Configurar o daemon do AWS X-Ray - AWS X-Ray
Variáveis de ambiente compatíveisUsar as opções de linha de comandoUsar um arquivo de configuração

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Configurar o daemon do AWS X-Ray

É possível usar opções de linha de comandos ou um arquivo de configuração para personalizar o comportamento do daemon do X-Ray. A maioria das opções estão disponíveis usando os dois métodos, mas alguns só estão disponíveis em arquivos de configuração e outros somente na linha de comando.

Para começar, a única opção necessária é -n ou --region, usada para definir a região que o daemon utilizará para enviar os dados de rastreamento ao X-Ray.

~/xray-daemon$ ./xray -n us-east-2

Se você estiver executando o daemon localmente, ou seja, fora do Amazon EC2, poderá adicionar a opção -o para ignorar a verificação de credenciais do perfil de instância para que o daemon fique pronto mais rapidamente.

~/xray-daemon$ ./xray -o -n us-east-2

As demais opções de linha de comandos permitem que você configure o registro em log, escute em uma porta diferente, limite a quantidade de memória que o daemon pode usar ou assuma um perfil para enviar dados de rastreamento a uma conta diferente.

Você pode passar um arquivo de configuração ao daemon para acessar as opções de configuração avançadas e executar tarefas, como limitar o número de chamadas simultâneas para o X-Ray, desabilitar a alternância de logs e enviar tráfego a um proxy.

Variáveis de ambiente compatíveis

O daemon do X-Ray é compatível com as seguintes variáveis de ambiente:

  • AWS_REGION: especifica a Região da AWS do endpoint de serviço do X-Ray.

  • HTTPS_PROXY: especifica um endereço de proxy pelo qual o daemon carregará os segmentos. Isso pode ser os nomes de domínio DNS ou endereços IP e números de porta usados pelos servidores de proxy.

Usar as opções de linha de comando

Passe essas opções para o daemon quando você executá-lo localmente ou com um script de dados do usuário.

Opções de linha de comando

  • -b, --bind: escutar os documentos de segmentos em uma porta UDP diferente.

    --bind "127.0.0.1:3000"

    Padrão: 2000.

  • -t, --bind-tcp: escutar chamadas ao serviço X-Ray em uma porta TCP diferente.

    -bind-tcp "127.0.0.1:3000"

    Padrão: 2000.

  • -c, --config: carregar um arquivo de configuração do caminho especificado.

    --config "/home/ec2-user/xray-daemon.yaml"

  • -f, --log-file: gerar logs de saída para o caminho do arquivo especificado.

    --log-file "/var/log/xray-daemon.log"

  • -l, --log-level: nível de log, do mais para o menos detalhado: dev, debug, info, warn, error, prod.

    --log-level warn

    Padrão: prod

  • -m, --buffer-memory: alterar a quantidade de memória em MB que os buffers podem usar (3, no mínimo).

    --buffer-memory 50

    Padrão: 1% de memória disponível.

  • -o, --local-mode: não verificar metadados da instância do EC2.

  • -r, --role-arn: assumir o perfil do IAM especificado para carregar os segmentos para uma conta diferente.

    --role-arn "arn:aws:iam::123456789012:role/xray-cross-account"

  • -a, --resource-arn: nome do recurso da Amazon (ARN) do recurso da AWS que está executando o daemon.

  • -p, --proxy-address: carregar segmentos para o AWS X-Ray por meio de um proxy. O protocolo do servidor proxy deve ser especificado.

    --proxy-address "http://192.0.2.0:3000"

  • -n, --region: enviar segmentos para o serviço X-Ray em uma região específica.

  • -v, --version: mostrar a versão do daemon do AWS X-Ray.

  • -h, --help: mostrar a tela de ajuda.

Usar um arquivo de configuração

Também é possível usar um arquivo de formato YAML para configurar o daemon. Passe o arquivo de configuração para o daemon usando a opção -c.

~$ ./xray -c ~/xray-daemon.yaml
Opções do arquivo de configuração

  • TotalBufferSizeMB: tamanho máximo do buffer em MB (3, no mínimo). Escolha 0 para usar 1% da memória de host.

  • Concurrency: número máximo de chamadas simultâneas para o AWS X-Ray que carregam documentos de segmentos.

  • Region: enviar segmentos para o serviço AWS X-Ray em uma região específica.

  • Socket: configurar a vinculação do daemon.

  • Logging: configurar o comportamento do registro em log.

    • LogRotation: definir como false para desabilitar a alternância de logs.

    • LogLevel: alterar o nível de log, do mais para o menos detalhado: dev, debug, info ou prod, warn, error, prod. O padrão é prod, que é equivalente a info.

    • LogPath: gerar logs para o caminho do arquivo especificado.

  • LocalMode: definir como true para ignorar a verificação de metadados da instância do EC2.

  • ResourceARN: nome do recurso da Amazon (ARN) do recurso da AWS que está executando o daemon.

  • RoleARN: assumir o perfil do IAM especificado faça carregar os segmentos para uma conta diferente.

  • ProxyAddress: carregar segmentos para o AWS X-Ray por meio de um proxy.

  • Endpoint: alterar o endpoint de serviço do X-Ray para o qual o daemon envia documentos de segmentos.

  • NoVerifySSL: desabilitar a verificação do certificado TLS.

  • Version: versão do formato de arquivo de configuração do daemon. A versão do formato do arquivo é um campo obrigatório.

exemplo Xray-daemon.yaml

Esse arquivo de configuração altera a porta de escuta do daemon para 3000, desativa verificações de metadados da instância, define um perfil a ser usado para fazer upload de segmentos e altera opções de região e registro em log.

Socket:
  UDPAddress: "127.0.0.1:3000"
  TCPAddress: "127.0.0.1:3000"
Region: "us-west-2"
Logging:
  LogLevel: "warn"
  LogPath: "/var/log/xray-daemon.log"
LocalMode: true
RoleARN: "arn:aws:iam::123456789012:role/xray-cross-account"
Version: 2