Espelhe tráfego de produção para uma origem de teste com Functions

Construa uma função em um firewall que envia uma cópia de cada requisição correspondente para uma origem de teste e leia as respostas em Real-Time Events.

Última atualização

Ver como Markdown Configurar agente

Neste tutorial, você vai construir uma função que copia as requisições de produção para uma origem de teste. A cópia permite que um software novo responda a requisições reais antes de atender os usuários. Você vai criar a função, instanciá-la em um firewall e acioná-la com uma regra do Rules Engine. Depois, você vai ler as respostas espelhadas em Real-Time Events.

Pré-requisitos

1. Crie a função de espelhamento de tráfego

Uma função é executada em um firewall quando ela exporta um handler firewall. Para criar a função:

Abra a página Functions

Acesse Azion Console > Products Menu > Libraries > Functions.

Selecione + Function
Nomeie a função

Digite um nome para a função. Por exemplo: traffic-mirroring.

Cole o código na aba Code

Na aba Code, cole o código a seguir:

JavaScript
01const TEST_ORIGIN = 'example.com';
02const TEST_TIMEOUT = 5000;
03
04async function mirror(testUrl, options) {
05 try {
06 const start = Date.now();
07 const response = await fetch(testUrl, options);
08 const seconds = (Date.now() - start) / 1000;
09
10 console.log(`[${response.status}, ${seconds}s]`);
11
12 if (response.status > 399) {
13 console.warn(
14 JSON.stringify({
15 request_method: options.method,
16 request_path: new URL(testUrl).pathname,
17 request_headers: options.headers,
18 request_body: options.body,
19 response_status: response.status,
20 response_body: await response.text(),
21 response_time: seconds,
22 })
23 );
24 }
25 } catch (error) {
26 if (error.name === 'TimeoutError') {
27 console.warn('Test origin timeout');
28 } else {
29 console.warn(`Error: ${error.message}`);
30 }
31 }
32}
33
34export default {
35 firewall: async (request, env, ctx) => {
36 const originalUrl = new URL(request.url);
37 const testUrl = `${originalUrl.protocol}//${TEST_ORIGIN}${originalUrl.pathname}${originalUrl.search}`;
38
39 const options = {
40 method: request.method,
41 headers: Object.fromEntries(request.headers),
42 signal: AbortSignal.timeout(TEST_TIMEOUT),
43 };
44
45 // O corpo de uma requisição pode ser lido uma vez, portanto leia-o antes de a cópia começar.
46 if (request.body) {
47 options.body = await request.text();
48 }
49
50 // waitUntil mantém a cópia fora do caminho da requisição.
51 ctx.waitUntil(mirror(testUrl, options));
52 },
53};
Substitua a origem de teste

Substitua example.com pelo domínio da sua origem de teste.

Selecione Save

A função é salva e fica disponível para ser instanciada em um firewall.

ctx.waitUntil() estende a execução além do ponto em que o handler retorna. A cópia sai do caminho da requisição, e a requisição original chega à origem de produção sem latência adicional. O handler nunca chama ctx.deny(), portanto nenhuma requisição é bloqueada. AbortSignal.timeout() encerra uma cópia após 5 segundos, e uma origem de teste mais lenta precisa de um valor maior.

dica — O exemplo usa o padrão ES Modules. Para migrar uma função do padrão Service Worker para esse padrão, consulte Migre padrões de handler em Functions.

2. Instancie a função no firewall

Uma instância de função vincula a função a um firewall, e um firewall executa uma função apenas com o módulo Functions ativado. Para criar a instância:

Abra o firewall

Em Azion Console, vá para Products Menu > Firewall > seu firewall.

Na aba Main Settings, ative o módulo Functions
Selecione Save
Vá para a aba Functions Instances
Selecione + Function Instance
Nomeie a instância

Digite um nome para a instância. Por exemplo: traffic-mirroring instance.

Selecione a função

Selecione a função traffic-mirroring. Apenas as funções com Initiator Type definido como Firewall aparecem na lista.

Selecione Save

A instância aparece na aba Functions Instances. Ela não é executada até que uma regra do Rules Engine a selecione.

3. Adicione a regra que executa a função

Uma regra do Rules Engine define os critérios que acionam a instância. Para espelhar as requisições cuja URI começa com /api:

Vá para a aba Rules Engine

No mesmo firewall, vá para a aba Rules Engine.

Selecione + Rule
Nomeie a regra

Digite um nome para a regra. Por exemplo: Mirror traffic to the test origin.

Selecione a variável na seção Criteria

Na seção Criteria, selecione a variável Request URI.

Selecione starts with como operador de comparação
Digite o argumento

Digite /api como argumento.

Na seção Behaviors, selecione Run Function
Selecione a instância que você criou
Selecione Save

A regra executa a instância em toda requisição cuja URI começa com /api. As mudanças podem levar alguns minutos para propagar. Aguarde antes de enviar uma requisição que corresponde aos critérios.

4. Verifique as requisições espelhadas em Real-Time Events

Envie uma requisição que corresponde aos critérios da regra:

curl https://<seu-dominio>/api/

O firewall executa a instância nessa requisição, e a função envia uma cópia para a origem de teste. Para ler o que a origem de teste respondeu:

Abra Real-Time Events

Acesse Azion Console > Real-Time Events.

Selecione a aba Functions Console
Use os filtros para restringir a consulta
Selecione uma entrada para ver os detalhes

Uma cópia bem-sucedida registra o status da origem de teste e o tempo de resposta:

[200, 0.142s]

Uma resposta acima de 399 registra a requisição e a resposta em JSON, portanto a falha carrega o próprio contexto. Uma cópia que excede o timeout registra Test origin timeout.

Leia as entradas a partir de quatro medidas:

  • Tempo de resposta: como a latência da origem de teste se compara com a de produção.
  • Taxa de erro: quantas entradas carregam um status 4xx ou 5xx.
  • Frequência de timeout: com que frequência uma cópia excede o timeout.
  • Cobertura de requisições: se a origem de teste responde a todos os métodos que a regra corresponde, incluindo POST, PUT e DELETE.

Quando a origem de teste responde ao tráfego de produção dentro do seu orçamento de latência e de erro, ela está pronta para atender produção.

5. (Opcional) Defina a origem de teste por uma variável de ambiente

Variáveis de ambiente guardam a origem de teste e o timeout fora do código, portanto uma função atende vários testes. Para ler ambos os valores do ambiente:

Crie as variáveis de ambiente

Crie TEST_ORIGIN e TEST_TIMEOUT na função, conforme descrito em Variáveis de ambiente.

Substitua o código na aba Code

Na aba Code, substitua o código pelo código a seguir:

JavaScript
01const DEFAULT_TIMEOUT = 10000;
02
03async function mirror(testUrl, options) {
04 try {
05 const start = Date.now();
06 const response = await fetch(testUrl, options);
07 const seconds = (Date.now() - start) / 1000;
08
09 console.log(`[${response.status}, ${seconds}s]`);
10
11 if (response.status > 399) {
12 console.warn(
13 JSON.stringify({
14 request_method: options.method,
15 request_path: new URL(testUrl).pathname,
16 request_headers: options.headers,
17 request_body: options.body,
18 response_status: response.status,
19 response_body: await response.text(),
20 response_time: seconds,
21 })
22 );
23 }
24 } catch (error) {
25 if (error.name === 'TimeoutError') {
26 console.warn('Test origin timeout');
27 } else {
28 console.warn(`Error: ${error.message}`);
29 }
30 }
31}
32
33export default {
34 firewall: async (request, env, ctx) => {
35 const testOrigin = Azion.env.get('TEST_ORIGIN');
36 const testTimeout = Number(Azion.env.get('TEST_TIMEOUT')) || DEFAULT_TIMEOUT;
37
38 const originalUrl = new URL(request.url);
39 const testUrl = `${originalUrl.protocol}//${testOrigin}${originalUrl.pathname}${originalUrl.search}`;
40
41 const options = {
42 method: request.method,
43 headers: Object.fromEntries(request.headers),
44 signal: AbortSignal.timeout(testTimeout),
45 };
46
47 // O corpo de uma requisição pode ser lido uma vez, portanto leia-o antes de a cópia começar.
48 if (request.body) {
49 options.body = await request.text();
50 }
51
52 // waitUntil mantém a cópia fora do caminho da requisição.
53 ctx.waitUntil(mirror(testUrl, options));
54 },
55};

Azion.env.get() retorna o valor de uma chave em tempo de execução. Quando TEST_TIMEOUT não carrega valor, a função usa 10000 ms.

Selecione Save

A função lê a origem de teste em tempo de execução, portanto a próxima origem de teste não exige edição de código.

Próximos passos

Execute uma função em um firewallOs mesmos três objetos para qualquer função de firewall, da função à regra que a aciona.Instancie uma função em um firewallCrie a instância pela Azion API e passe a configuração dela como Args em JSON.Functions no FirewallOs desfechos que uma função de firewall retorna e os headers de requisição e resposta que ela adiciona.Rules Engine para FirewallTodas as variáveis de critério, operadores de comparação e comportamentos que uma regra de firewall aceita.Data StreamEnvie a mesma saída de log para um endpoint que você controla, para monitoramento que dura mais que um teste.Solução de problemas de execução e logs de funçõesO que verificar quando uma função não produz saída de log ou nunca é executada.