Opções de configuração do Standalone agent

A lista a seguir inclui todas as opções de configuração com o nome da variável de ambiente e o nome da chave no arquivo de configuração. Para mais informações sobre como configurar o Standalone AppSignal Agent com um arquivo de configuração ou usando variáveis de ambiente, consulte nossa seção de configuração.

app_name

Campo	Valor
Chave do arquivo de configuração	`app_name`
Chave de variável de ambiente do sistema	`APPSIGNAL_APP_NAME`
Obrigatório	sim
Tipo	`String`
Valor padrão	nil (Não é definido por padrão)

Descrição

Nome do seu aplicativo como deve ser exibido no AppSignal.com.

Nota: Alterar o nome ou o ambiente de um aplicativo existente criará um novo aplicativo no AppSignal.com.

environment

Campo	Valor
Chave do arquivo de configuração	`environment`
Chave de variável de ambiente do sistema	`APPSIGNAL_APP_ENV`
Obrigatório	sim
Tipo	`String`
Valor padrão	nil (Não é definido por padrão)

Descrição

O ambiente do aplicativo a ser reportado para o AppSignal.

Nota: Alterar o nome ou o ambiente de um aplicativo existente criará um novo aplicativo no AppSignal.com.

push_api_key

Campo	Valor
Chave do arquivo de configuração	`push_api_key`
Chave de variável de ambiente do sistema	`APPSIGNAL_PUSH_API_KEY`
Obrigatório	sim
Tipo	`String`
Valor padrão	nil (Não é definido por padrão)

Descrição

A chave de autenticação em nível de organização para autenticar com nossa Push API. Leia mais sobre a chave da Push API do AppSignal.

bind_address

Campo	Valor
Chave do arquivo de configuração	`bind_address`
Chave de variável de ambiente do sistema	`APPSIGNAL_BIND_ADDRESS`
Obrigatório	não
Tipo	`String`
Valor padrão	`127.0.0.1`
Disponível desde a versão	`0.0.24`

Descrição

Um endereço IPv4 válido que o agente do AppSignal utiliza como binding para seus servidores TCP e UDP. Use um endereço específico se você quiser que o agente escute apenas requisições feitas a esse endereço. Defina esta opção como 0.0.0.0 para permitir o recebimento de requisições de hosts usando qualquer endereço IP. Por padrão, ele escuta apenas requisições feitas no mesmo host. Esta opção é aplicada a todos os servidores do agente (StatsD, OpenTelemetry e NGINX).

ca_file_path

Campo	Valor
Chave do arquivo de configuração	`ca_file_path`
Chave de variável de ambiente do sistema	`APPSIGNAL_CA_FILE_PATH`
Obrigatório	não
Tipo	`String`
Valor padrão	Por padrão, utiliza as CAs do sistema.

Descrição

Configura o caminho do arquivo de certificado SSL.

Use esta opção para apontar para outro arquivo de certificado caso haja problema ao se conectar à nossa API.

Nota: O caminho especificado não pode conter abstrações de sistema de arquivos específicas do sistema operacional, como o símbolo de diretório home ~ para sistemas *NIX. Isso será interpretado como um caminho malformado.

cpu_count

Campo	Valor
Chave do arquivo de configuração	`cpu_count`
Chave de variável de ambiente do sistema	`APPSIGNAL_CPU_COUNT`
Obrigatório	não
Tipo	`Float`
Valor padrão	`undefined`
Disponível desde a versão	`0.34.1`

Descrição

A capacidade disponível de CPU do host, em número de CPUs. Isso é usado para calcular a porcentagem de uso de CPU nas métricas de host. Se não definido, o agente tentará detectar isso automaticamente a partir dos cgroups. O número de CPUs pode ser uma fração, por exemplo, 0.5.

dns_servers

Campo	Valor
Chave do arquivo de configuração	`dns_servers`
Chave de variável de ambiente do sistema	`APPSIGNAL_DNS_SERVERS`
Obrigatório	não
Tipo	`String`
Valor padrão	nil (Não é definido por padrão)

Descrição

Configure os servidores DNS para o agente do AppSignal usar.

YAML

# /etc/appsignal-agent.conf
dns_servers = "8.8.8.8,8.8.4.4"

Se você for afetado pelos nossos timeouts de DNS, tente definir um servidor DNS manualmente usando esta opção que não utilize mais de 4 pontos no nome do servidor.

Valores aceitáveis: 8.8.8.8, my.custom.local.server.
Valores não aceitáveis: foo, my.awesome.custom.local.dns.server.

Se o servidor DNS não puder ser alcançado, o agente recorrerá à configuração de DNS do host e gerará uma mensagem no arquivo appsignal.log: A problem occurred while setting DNS servers.

enable_host_metrics

Campo	Valor
Chave do arquivo de configuração	`enable_host_metrics`
Chave de variável de ambiente do sistema	`APPSIGNAL_ENABLE_HOST_METRICS`
Obrigatório	não
Tipo	Booleano (`true` / `false`)
Valor padrão	`true` / detectado pelo sistema
Disponível desde a versão	`0.0.1`
	`0.0.26`: Desabilitado por padrão na imagem Docker appsignal/agent.

Descrição

Defina esta opção como false para desabilitar a coleta de métricas de host. No Heroku e no Dokku, as métricas de host são desabilitadas por padrão. Isso é feito porque esses sistemas reportarão métricas imprecisas a partir de dentro dos contêineres. A coleta de métricas de host nesses sistemas não pode ser habilitada. Para o Heroku, use o log drain do Heroku em vez disso.

enable_http

Campo	Valor
Chave do arquivo de configuração	`enable_http`
Obrigatório	não
Tipo	Booleano (`true` / `false`)
Valor padrão	`false`
Disponível desde a versão	`0.0.23`
	`0.0.25`: Descontinuado em favor de `enable_opentelemetry_http`

Descrição

Defina esta opção como true para habilitar o servidor HTTP OpenTelemetry. Quando habilitado, o agente do AppSignal escutará em um servidor vinculado a localhost na porta 8099. Se você estiver executando várias aplicações instrumentadas com AppSignal no mesmo servidor, esta opção de configuração só pode ser habilitada em uma delas. Isso é necessário para aplicativos que usam o exportador HTTP do OpenTelemetry para enviar dados ao AppSignal.

enable_nginx_metrics

Campo	Valor
Chave do arquivo de configuração	`enable_nginx_metrics`
Chave de variável de ambiente do sistema	`APPSIGNAL_ENABLE_NGINX_METRICS`
Obrigatório	não
Tipo	Booleano (`true` / `false`)
Valor padrão	`false`
Disponível desde a versão	`0.0.24`
	`0.0.26`: Habilitado por padrão na imagem Docker appsignal/agent.

Descrição

Defina como true para habilitar o servidor de métricas do NGINX. Veja a documentação de métricas do NGINX para detalhes. Quando habilitado, o agente do AppSignal escutará em um servidor vinculado a localhost na porta 27649. Se você estiver executando várias aplicações instrumentadas com AppSignal no mesmo servidor, esta opção de configuração só pode ser habilitada em uma delas.

enable_opentelemetry_http

Campo	Valor
Chave do arquivo de configuração	`enable_opentelemetry_http`
Chave de variável de ambiente do sistema	`APPSIGNAL_ENABLE_OPENTELEMETRY_HTTP`
Obrigatório	não
Tipo	Booleano (`true` / `false`)
Valor padrão	`false` / detectado pelo sistema
Disponível desde a versão	`0.0.25`
	`0.0.26`: Habilitado por padrão na imagem Docker appsignal/agent.

Descrição

enable_statsd

Campo	Valor
Chave do arquivo de configuração	`enable_statsd`
Chave de variável de ambiente do sistema	`APPSIGNAL_ENABLE_STATSD`
Obrigatório	não
Tipo	Booleano (`true` / `false`)
Valor padrão	`true`
Disponível desde a versão	`0.0.24`

Descrição

Habilita o servidor StatsD no agente do AppSignal. Quando habilitado, o agente do AppSignal escutará em um servidor vinculado a localhost na porta 8125. Se você estiver executando várias aplicações instrumentadas com AppSignal no mesmo servidor, esta opção de configuração só pode ser habilitada em uma delas.

filter_parameters

Campo	Valor
Chave do arquivo de configuração	`filter_parameters`
Chave de variável de ambiente do sistema	`APPSIGNAL_FILTER_PARAMETERS`
Obrigatório	não
Tipo	`Array<String>`
Valor padrão	`[]`
Disponível desde a versão	`0.0.23`

Descrição

Lista de chaves de parâmetros que devem ser ignoradas usando a filtragem do AppSignal. Seus valores serão substituídos por [FILTERED] quando transmitidos para o AppSignal.

TOML

# appsignal.conf
filter_parameters = ["password", "confirm_password", "secret"]

Leia mais sobre filtragem de parâmetros.

filter_session_data

Campo	Valor
Chave do arquivo de configuração	`filter_session_data`
Chave de variável de ambiente do sistema	`APPSIGNAL_FILTER_SESSION_DATA`
Obrigatório	não
Tipo	`Array<String>`
Valor padrão	`[]`
Disponível desde a versão	`0.0.23`

Descrição

Lista de chaves de dados de sessão que devem ser ignoradas usando a filtragem do AppSignal. Seus valores serão substituídos por [FILTERED] quando transmitidos para o AppSignal.

TOML

# appsignal.conf
filter_session_data = ["secret_token_one", "secret_token_two"]

Leia mais sobre filtragem de dados de sessão.

host_role

Campo	Valor
Chave do arquivo de configuração	`host_role`
Chave de variável de ambiente do sistema	`APPSIGNAL_HOST_ROLE`
Obrigatório	não
Tipo	`String`
Valor padrão	nil (Não é definido por padrão)
Disponível desde a versão	`0.0.28`

Descrição

Agrupe hosts por função (role) e gere métricas com base nessa função. Uma dessas métricas é a métrica de contador reporting_hosts. Uma boa função indica qual é a principal atribuição do servidor, como “webserver”, “processor”, “api”, “database”, “loadbalancer”, etc.

hostname

Campo	Valor
Chave do arquivo de configuração	`hostname`
Chave de variável de ambiente do sistema	`APPSIGNAL_HOSTNAME`
Obrigatório	não
Tipo	`String`
Valor padrão	detectado pelo sistema

Descrição

Isso sobrescreve o hostname do servidor. Útil quando você não consegue definir um hostname personalizado ou quando um id genérico é gerado para você em serviços de hospedagem.

http_proxy

Campo	Valor
Chave do arquivo de configuração	`http_proxy`
Chave de variável de ambiente do sistema	`APPSIGNAL_HTTP_PROXY`
Obrigatório	não
Tipo	`String`
Valor padrão	nil (Não é definido por padrão)

Descrição

Se você precisar que o agente se conecte à Internet por meio de um proxy, defina a URL completa do proxy nesta chave de configuração.

ignore_actions

Campo	Valor
Chave do arquivo de configuração	`ignore_actions`
Chave de variável de ambiente do sistema	`APPSIGNAL_IGNORE_ACTIONS`
Obrigatório	não
Tipo	`Array<String>`
Valor padrão	`[]`
Disponível desde a versão	`0.0.26`

Descrição

Com esta opção de configuração você pode especificar uma lista de ações que serão ignoradas pelo AppSignal. Tudo o que acontece, incluindo exceções, não será transmitido para o AppSignal. Isso pode ser útil para ignorar endpoints de health check ou outras ações que você não quer monitorar. Leia mais sobre ignorar ações.

ignore_errors

Campo	Valor
Chave do arquivo de configuração	`ignore_errors`
Chave de variável de ambiente do sistema	`APPSIGNAL_IGNORE_ERRORS`
Obrigatório	não
Tipo	`Array<String>`
Valor padrão	`[]`
Disponível desde a versão	`0.0.26`

Descrição

Lista de classes de erro que serão ignoradas. Qualquer exceção levantada com essa classe de erro não será transmitida para o AppSignal. Leia mais sobre ignorar erros.

ignore_namespaces

Campo	Valor
Chave do arquivo de configuração	`ignore_namespaces`
Chave de variável de ambiente do sistema	`APPSIGNAL_IGNORE_NAMESPACES`
Obrigatório	não
Tipo	`Array<String>`
Valor padrão	`[]`
Disponível desde a versão	`0.0.26`

Descrição

Lista de namespaces que serão ignorados. Qualquer erro levantado ou requisição lenta que ocorra nesse namespace não será enviado para o AppSignal. Leia mais sobre namespaces.

log_level

Campo	Valor
Chave do arquivo de configuração	`log_level`
Chave de variável de ambiente do sistema	`APPSIGNAL_LOG_LEVEL`
Obrigatório	não
Tipo	`String`
Valor padrão	`info`

Descrição

Esta opção define o nível de severidade do logger interno do AppSignal e não afeta o recurso de logging.

Define o nível de severidade do logger interno do AppSignal. Se estiver configurado como “info”, ele registrará todas as mensagens de erro, aviso e info, mas não registrará as mensagens de debug. Configurar para os níveis “debug” ou “trace” geralmente só é necessário a pedido do suporte. Definir o nível como “debug”/“trace” pode ter um leve impacto no uso de disco e IO, especialmente em sites de alto tráfego. A sobrecarga de CPU é mínima com a opção debug habilitada. Valores aceitos:

error
warning
info
debug
trace

nginx_port

Campo	Valor
Chave do arquivo de configuração	`nginx_port`
Chave de variável de ambiente do sistema	`APPSIGNAL_NGINX_PORT`
Obrigatório	não
Tipo	`Integer`
Valor padrão	`27649`
Disponível desde a versão	`0.36.6`

Descrição

Configure a porta na qual o servidor de métricas do NGINX é exposto. Quando o AppSignal recebe métricas do NGINX, ele escuta em um servidor vinculado a localhost, por padrão na porta 27649. Se você estiver executando várias aplicações instrumentadas com AppSignal no mesmo servidor com métricas do NGINX habilitadas, use esta opção para configurar cada aplicação para escutar em uma porta diferente.

opentelemetry_port

Campo	Valor
Chave do arquivo de configuração	`opentelemetry_port`
Chave de variável de ambiente do sistema	`APPSIGNAL_OPENTELEMETRY_PORT`
Obrigatório	não
Tipo	`Integer`
Valor padrão	`8099`
Disponível desde a versão	`0.0.28`

Descrição

Defina esta opção para configurar a porta do servidor HTTP do OpenTelemetry do processo do agente AppSignal. Configure esta porta se outro processo já estiver em execução na máquina utilizando essa mesma porta, para evitar conflitos.

push_api_endpoint

Campo	Valor
Chave do arquivo de configuração	`push_api_endpoint`
Chave de variável de ambiente do sistema	`APPSIGNAL_PUSH_API_ENDPOINT`
Obrigatório	não
Tipo	`String`
Valor padrão	`https://push.appsignal.com`

Descrição

Configure o endpoint para envio de dados ao AppSignal. Esta configuração não precisará ser alterada.

running_in_container

Campo	Valor
Chave do arquivo de configuração	`running_in_container`
Chave de variável de ambiente do sistema	`APPSIGNAL_RUNNING_IN_CONTAINER`
Obrigatório	não
Tipo	Booleano (`true` / `false`)
Valor padrão	detectado pelo agente
Disponível desde a versão	`0.0.27`

Descrição

O AppSignal espera estar executando na mesma máquina entre diferentes deploys. Defina esta chave como true se o aplicativo estiver rodando em um contêiner, como com o Docker. Versões mais recentes da integração do AppSignal detectam automaticamente o ambiente de contêiner, então nenhuma configuração manual é necessária. Se você estiver tendo problemas com a detecção automática, por favor entre em contato com o suporte. Esta opção é definida como true automaticamente no Heroku.

send_environment_metadata

Campo	Valor
Chave do arquivo de configuração	`send_environment_metadata`
Chave de variável de ambiente do sistema	`APPSIGNAL_SEND_ENVIRONMENT_METADATA`
Obrigatório	não
Tipo	Booleano (`true` / `false`)
Valor padrão	`true`

Descrição

Envia metadados de ambiente sobre o aplicativo. Para mais informações, leia sobre metadados de ambiente.

send_params

Campo	Valor
Chave do arquivo de configuração	`send_params`
Chave de variável de ambiente do sistema	`APPSIGNAL_SEND_PARAMS`
Obrigatório	não
Tipo	Booleano (`true` / `false`)
Valor padrão	`true`
Disponível desde a versão	`0.0.24`

Descrição

Define se o envio de parâmetros de requisição para o AppSignal deve ser ignorado. Para mais informações, leia sobre send_params na filtragem de parâmetros de requisição.

send_session_data

Campo	Valor
Chave do arquivo de configuração	`send_session_data`
Chave de variável de ambiente do sistema	`APPSIGNAL_SEND_SESSION_DATA`
Obrigatório	não
Tipo	Booleano (`true` / `false`)
Valor padrão	`true`
Disponível desde a versão	`0.0.24`

Descrição

Defina esta opção como false para não enviar nenhum dado de sessão com rastros de exceção e amostras de problemas de desempenho. Para mais informações, leia sobre filtragem de dados de sessão de requisição.

statsd_port

Campo	Valor
Chave do arquivo de configuração	`statsd_port`
Chave de variável de ambiente do sistema	`APPSIGNAL_STATSD_PORT`
Obrigatório	não
Tipo	`Integer`
Valor padrão	`8125`
Disponível desde a versão	`0.0.28`

Descrição

Defina esta opção para configurar a porta do servidor HTTP StatsD do processo do agente AppSignal. Configure esta porta se outro processo já estiver em execução na máquina utilizando essa mesma porta, para evitar conflitos.

working_dir_path

Campo	Valor
Chave do arquivo de configuração	`working_dir_path`
Chave de variável de ambiente do sistema	`APPSIGNAL_WORKING_DIRECTORY_PATH`
Obrigatório	não
Tipo	`String`
Valor padrão	`/var/lib/appsignal-agent`

Descrição

Sobrescreve o local onde o Agente Standalone do AppSignal pode armazenar arquivos temporários. Use esta opção se o local padrão não for adequado. Veja nossa página como o AppSignal opera para mais informações sobre a finalidade deste diretório de trabalho.

​Opções disponíveis

​app_name

​Descrição

​environment

​Descrição

​push_api_key

​Descrição

​bind_address

​Descrição

​ca_file_path

​Descrição

​cpu_count

​Descrição

​dns_servers

​Descrição

​enable_host_metrics

​Descrição

​enable_http

​Descrição

​enable_nginx_metrics

​Descrição

​enable_opentelemetry_http

​Descrição

​enable_statsd

​Descrição

​filter_parameters

​Descrição

​filter_session_data

​Descrição

​host_role

​Descrição

​hostname

​Descrição

​http_proxy

​Descrição

​ignore_actions

​Descrição

​ignore_errors

​Descrição

​ignore_namespaces

​Descrição

​log_level

​Descrição

​nginx_port

​Descrição

​opentelemetry_port

​Descrição

​push_api_endpoint

​Descrição

​running_in_container

​Descrição

​send_environment_metadata

​Descrição

​send_params

​Descrição

​send_session_data

​Descrição

​statsd_port

​Descrição

​working_dir_path

​Descrição

Opções disponíveis

app_name

Descrição

environment

Descrição

push_api_key

Descrição

bind_address

Descrição

ca_file_path

Descrição

cpu_count

Descrição

dns_servers

Descrição

enable_host_metrics

Descrição

enable_http

Descrição

enable_nginx_metrics

Descrição

enable_opentelemetry_http

Descrição

enable_statsd

Descrição

filter_parameters

Descrição

filter_session_data

Descrição

host_role

Descrição

hostname

Descrição

http_proxy

Descrição

ignore_actions

Descrição

ignore_errors

Descrição

ignore_namespaces

Descrição

log_level

Descrição

nginx_port

Descrição

opentelemetry_port

Descrição

push_api_endpoint

Descrição

running_in_container

Descrição

send_environment_metadata

Descrição

send_params

Descrição

send_session_data

Descrição

statsd_port

Descrição

working_dir_path

Descrição