Opções de configuração do pacote Elixir

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 AppSignal com um arquivo de configuração ou variáveis de ambiente do sistema, veja nosso tópico Configuração.

Opções disponíveis

Opções obrigatórias
- active
- env
- name
- otp_app
- push_api_key
Opções

active

Campo	Valor
Chave do arquivo de configuração	`active`
Chave de variável de ambiente do sistema	`APPSIGNAL_ACTIVE`
Obrigatório	sim
Tipo	Booleano (`true` / `false`)
Valor padrão	`false` / detectado pelo sistema
Disponível desde a versão	`0.1.0`

Descrição

Nota: Quando a variável de ambiente APPSIGNAL_PUSH_API_KEY está definida, o padrão desta opção é true. Isso pode ser sobrescrito definindo a variável de ambiente do sistema APPSIGNAL_ACTIVE como false: APPSIGNAL_ACTIVE=false.

Configura se o AppSignal deve estar ativo ou não para um determinado ambiente. Mais comumente usada na configuração via arquivo por ambiente.

env

Campo	Valor
Chave do arquivo de configuração	`env`
Chave de variável de ambiente do sistema	`APPSIGNAL_APP_ENV`
Obrigatório	sim
Tipo	`Atom`
Valor padrão	`dev`
Disponível desde a versão	`0.1.0`
	`0.9.2`: O nome da variável de ambiente desta opção de configuração foi renomeado de `APPSIGNAL_ENVIRONMENT` para `APPSIGNAL_APP_ENV`.

Descrição

O ambiente do app a ser reportado ao AppSignal. Esta opção é definida por padrão pelo nosso instalador, como Mix.env. Para sobrescrevê-la, altere o valor em config/appsignal.exs (ou no arquivo de configuração de sua escolha).

Elixir

# config/appsignal.exs
# or config/config.exs
config :appsignal, :config,
  env: Mix.env # Installer default

# Set your own value
config :appsignal, :config,
  env: :staging

Para sobrescrever a opção de configuração no ambiente do sistema, use a variável de ambiente APPSIGNAL_APP_ENV.

Shell

# The method of setting environment variables may differ on your system
export APPSIGNAL_APP_ENV=staging
mix run

A opção de variável de ambiente é comumente usada em plataformas, como o Heroku, onde os apps rodam no ambiente production por padrão. Esta configuração permite sobrescrever para definir o ambiente como staging, por exemplo.

Shell

heroku config:set APPSIGNAL_APP_ENV=staging

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

name

Campo	Valor
Chave do arquivo de configuração	`name`
Chave da 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 da sua aplicação como ela deve ser exibida no AppSignal.com.

Observação: Alterar o nome ou o ambiente de uma aplicação existente criará uma nova aplicação no AppSignal.com.

otp_app

Campo	Valor
Chave do arquivo de configuração	`otp_app`
Chave da variável de ambiente do sistema	`APPSIGNAL_OTP_APP`
Obrigatório	sim
Tipo	`Atom`
Valor padrão	nil (Não definido por padrão)
Disponível desde a versão	`2.0.0`

Descrição

O nome do OTP app da sua aplicação, a ser usado para configuração automática da instrumentação para bibliotecas como o Ecto.

push_api_key

Campo	Valor
Chave do arquivo de configuração	`push_api_key`
Chave da 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)
Disponível desde a versão	`0.1.0`

Descrição

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

Observação: Quando a variável de ambiente do sistema APPSIGNAL_PUSH_API_KEY está definida, a opção active terá como valor padrão true em vez de false. Isso significa que o AppSignal será considerado ativo para o ambiente carregado mesmo se active estiver definido como false no arquivo de configuração. Para mais informações, consulte a opção active.

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	`2.7.7`

Descrição

Um endereço IPv4 válido que o agente do AppSignal usa como binding para seus servidores TCP e UDP. Use um endereço específico se quiser que o agente escute apenas requisições feitas para esse endereço. Defina esta opção como 0.0.0.0 para permitir receber requisições de hosts usando qualquer endereço IP. Por padrão, ele só escuta 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	Caminho do arquivo `cacert.pem` incluído.
Disponível desde a versão	`0.12.0`

Descrição

Configura o caminho do arquivo de certificado SSL. Por padrão, isso aponta para o arquivo cacert.pem empacotado com o AppSignal no próprio pacote. Use esta opção para apontar para outro arquivo de certificado se houver problema ao conectar com 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 pessoal ~ para sistemas *NIX. Isso será considerado 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	`2.9.1`

Descrição

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

debug

Campo	Valor
Chave do arquivo de configuração	`debug`
Chave de variável de ambiente do sistema	`APPSIGNAL_DEBUG`
Obrigatório	não
Tipo	Booleano (`true` / `false`)
Valor padrão	`false`
Disponível desde a versão	`1.0.0`
	Descontinuada desde a versão 2.2.8 em favor da opção de configuração `log_level`.

Descrição

Aviso: Esta opção de configuração está descontinuada no pacote Elixir 2.2.8. Use a opção log_level no lugar para o pacote Elixir 2.2.8 e versões mais recentes.

Habilita o logging de debug, geralmente necessário apenas a pedido do suporte. Com esta opção habilitada, o AppSignal registrará muito mais informações sobre decisões tomadas durante a coleta de métricas e quando os dados são enviados aos servidores do AppSignal.com. Habilitar o logging de debug 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 de debug habilitada.

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

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	`list(String)`
Valor padrão	`[]`
Disponível desde a versão	`1.3.0.beta.2`

Descrição

Configura servidores DNS para o agente do AppSignal usar.

# config/config.exs
config :appsignal, :config,
  dns_servers: ["8.8.8.8", "8.8.4.4"]

Se você for afetado por nossos timeouts de DNS, tente definir um servidor DNS manualmente usando esta opção, que não use 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.

ecto_repos

Campo	Valor
Chave do arquivo de configuração	`ecto_repos`
Chave de variável de ambiente do sistema	`APPSIGNAL_ECTO_REPOS`
Obrigatório	não
Tipo	`list(String)`
Valor padrão	`nil`
Disponível desde a versão	`2.0.0`

Descrição

Configura quais repos do Ecto serão instrumentados para consultas. Se não definido, o AppSignal encontrará automaticamente seus repos através da configuração da aplicação.

# config/config.exs
config :appsignal, :config,
  ecto_repos: [AppsignalPhoenixExample.Repo, AppsignalPhoenixExample.AnotherRepo]

enable_error_backend

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

Descrição

Habilita o backend de erros na integração com Elixir.

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`

Descrição

Defina esta opção como false para desativar a coleta de métricas do host. No Heroku e no Dokku, as métricas do host são desabilitadas por padrão. Isso é feito porque esses sistemas reportam métricas imprecisas a partir dos containers. A coleta de métricas do host nesses sistemas não pode ser habilitada. Para o Heroku, use o Heroku log drain.

enable_minutely_probes

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

Descrição

Habilita o sistema de minutely probes.

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	`2.5.2`

Descrição

Defina como true para habilitar o servidor de métricas do NGINX. Veja a documentação de métricas do NGINX para mais 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_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	`false`
Disponível desde a versão	`2.2.6`

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.

endpoint

Campo	Valor
Chave do arquivo de configuração	`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

Configura o endpoint para enviar dados ao AppSignal. Esta configuração não precisa ser alterada.

files_world_accessible

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

Descrição

Se esta opção for definida como true, o diretório de trabalho do AppSignal criado fica acessível para todos os usuários (permissões Unix 0666). Isso geralmente é necessário porque processos do mesmo aplicativo são executados sob usuários diferentes. Defina como false para desativar esse comportamento (permissões Unix 0644).

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	`list(String)`
Valor padrão	`[]`

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] ao serem transmitidos ao AppSignal. Você pode configurar isso com uma lista de chaves no arquivo de configuração.

Elixir

# config/appsignal.exs
config :appsignal, :config,
  filter_parameters: ["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	`list(String)`
Valor padrão	`[]`
Disponível desde a versão	`1.6.0`
	Recomenda-se a atualização para a versão `1.6.3` ou superior.

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] ao serem transmitidos ao AppSignal. Você pode configurar isso com uma lista de chaves no arquivo de configuração.

Elixir

# config/appsignal.exs
config :appsignal, :config,
  filter_session_data: ["name", "email", "api_token", "token"]

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	`2.7.7`

Descrição

Agrupe hosts por função e gere métricas com base nesta função. Uma dessas métricas é a métrica contadora reporting_hosts. Uma boa função indica qual é o papel principal 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
Disponível desde a versão	`0.12.0`

Descrição

Isto substitui o hostname do servidor. Útil quando você não consegue definir um hostname personalizado ou quando um id pouco descritivo é 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 via 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	`list(String)`
Valor padrão	`[]`

Descrição

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

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	`list(String)`
Valor padrão	`[]`

Descrição

Lista de classes de erro que serão ignoradas. Qualquer exceção lançada com esta classe de erro não será transmitida ao AppSignal. Leia mais sobre ignorar erros.

ignore_logs

Campo	Valor
Chave do arquivo de configuração	`ignore_logs`
Chave de variável de ambiente do sistema	`APPSIGNAL_IGNORE_LOGS`
Obrigatório	não
Tipo	`list(String)`
Valor padrão	`[]`
Disponível desde a versão	`2.10.0`

Descrição

Lista de mensagens de log que serão ignoradas. Qualquer mensagem de log contendo algum dos elementos da lista não será transmitida ao AppSignal. Um pequeno subconjunto da sintaxe de regex é suportado, leia mais sobre isso em nosso guia Ignorar Logs.

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	`list(String)`
Valor padrão	`[]`
Disponível desde a versão	`1.3.0`

Descrição

Lista de namespaces que serão ignorados. Qualquer erro lançado ou requisição lenta que ocorra neste namespace não será enviado ao AppSignal. Leia mais sobre namespaces.

instrument_absinthe

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

Descrição

Se deve instrumentar automaticamente eventos de Telemetry para a integração com o pacote Absinthe, pode ser true ou false.

instrument_ecto

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

Descrição

Se deve instrumentar automaticamente eventos de Telemetry para a integração com o pacote Ecto, pode ser true ou false.

instrument_finch

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

Descrição

Se deve instrumentar automaticamente eventos de Telemetry para a integração com o pacote Finch, pode ser true ou false.

instrument_oban

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

Descrição

Se deve instrumentar automaticamente eventos de Telemetry para a integração com o pacote Oban, pode ser true ou false.

instrument_tesla

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

Descrição

Define se eventos do Telemetry devem ser instrumentados automaticamente para a integração do pacote Tesla; pode ser true ou false.

log

Campo	Valor
Chave do arquivo de configuração	`log`
Chave da variável de ambiente do sistema	`APPSIGNAL_LOG`
Obrigatório	não
Tipo	`Atom`
Valor padrão	`:file`

Descrição

Esta opção configura qual logger a funcionalidade de logging interna do AppSignal utilizará e não afeta a funcionalidade de logging.Observação: O agente do AppSignal, que é utilizado pela integração, sempre escreverá no arquivo “appsignal.log”.

Selecione qual logger a integração do AppSignal utilizará. Os valores aceitos são file e stdout. Veja também a configuração log_path.

file (padrão)
- Escreve todos os logs do AppSignal no sistema de arquivos.
stdout (padrão no Heroku)
- Imprime os logs do AppSignal no STDOUT do processo pai, em vez de em um arquivo. Útil com soluções de hospedagem como sistemas de contêineres e Heroku.

log_level

Campo	Valor
Chave do arquivo de configuração	`log_level`
Chave da variável de ambiente do sistema	`APPSIGNAL_LOG_LEVEL`
Obrigatório	não
Tipo	`String`
Valor padrão	`info`
Disponível desde a versão	`2.2.8`

Descrição

Esta opção define o nível de severidade do logger interno do AppSignal e não afeta a funcionalidade 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 informação, mas não registrará as mensagens de depuração. Definir os níveis como “debug” ou “trace” normalmente 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

log_path

Campo	Valor
Chave do arquivo de configuração	`log_path`
Chave da variável de ambiente do sistema	`APPSIGNAL_LOG_PATH`
Obrigatório	não
Tipo	`String`
Valor padrão	`/tmp`
Disponível desde a versão	`1.0.0`
	`1.9.0`: O caminho de log padrão foi alterado de `/tmp/appsignal/` para `/tmp/`.

Descrição

Esta opção configura a localização do arquivo de log interno do AppSignal e não afeta a funcionalidade de logging.
Observação: O caminho especificado não pode conter abstrações de sistema de arquivos específicas do sistema operacional, como o símbolo de homedir ~ em sistemas *NIX. Isso será interpretado como um caminho mal formado.

Sobrescreva a localização do caminho (diretório) onde o arquivo appsignal.log pode ser escrito.

nginx_port

Campo	Valor
Chave do arquivo de configuração	`nginx_port`
Chave da 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	`2.15.8`

Descrição

Configura 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 associado a localhost, por padrão na porta 27649. Se você estiver executando várias aplicações instrumentadas pelo 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.

report_oban_errors

Campo	Valor
Chave do arquivo de configuração	`report_oban_errors`
Chave da variável de ambiente do sistema	`APPSIGNAL_REPORT_OBAN_ERRORS`
Obrigatório	não
Tipo	`String`
Valor padrão	`all`
Disponível desde a versão	`2.5.1`

Descrição

Quando reportar erros recebidos pelo handler de eventos de exceção da integração do pacote Oban durante o processamento de um job. Os valores possíveis são:

all: Reporta todos os erros para cada execução de jobs, incluindo retentativas.
discard: Reporta erros quando o job é descartado devido ao erro. Use esta opção para reportar erros somente quando todas as retentativas do job tiverem se esgotado.
none: Não reporta nenhum erro para os jobs, incluindo retentativas.

request_headers

Campo	Valor
Chave do arquivo de configuração	`request_headers`
Chave da variável de ambiente do sistema	`APPSIGNAL_REQUEST_HEADERS`
Obrigatório	não
Tipo	`list(String)`
Valor padrão	`["accept", "accept-charset", "accept-encoding", "accept-language", "cache-control", "connection", "content-length", "path-info", "range", "request-method", "request-uri", "server-name", "server-port", "server-protocol"]`
Disponível desde a versão	`1.6.0`
	Recomenda-se atualizar para `1.6.3` ou superior.

Descrição

A opção de configuração request_headers contém uma lista de cabeçalhos de requisição HTTP que são lidos e armazenados pelo pacote Elixir do AppSignal. Esta opção de configuração request_headers é uma allowlist (lista de permissões), o que significa que ela aceitará apenas os cabeçalhos especificados por esta opção de configuração. Se esta opção de configuração não estiver definida, será usado o padrão do AppSignal. A lista a seguir é o padrão do pacote AppSignal.

Elixir

# config/appsignal.exs
config :appsignal, :config,
  request_headers: ~w(
    accept accept-charset accept-encoding accept-language cache-control
    connection content-length path-info range request-method
    request-uri server-name server-port server-protocol
  )

Para configurar o AppSignal para não armazenar nenhum cabeçalho de requisição HTTP nas transações do AppSignal, configure a opção com uma lista vazia.

Elixir

# config/appsignal.exs
config :appsignal, :config,
  request_headers: []

revision

Campo	Valor
Chave do arquivo de configuração	`revision`
Chave da variável de ambiente do sistema	`APP_REVISION`
Obrigatório	não
Tipo	`String`
Valor padrão	nil (Não definido por padrão)
Disponível desde a versão	`1.5.0`
	`1.10.12`: Detecção automática para deploys no Heroku com a funcionalidade Dyno Metadata labs habilitada. `2.7.6`: Detecção automática para deploys no Render. `3.4.7`: Detecção automática para deploys via Kamal.

Descrição

Define a revisão da aplicação para reportar a versão atualmente em execução da sua aplicação. O AppSignal criará um marcador de deploy quando este valor mudar e marcará todos os dados recebidos com a revisão atual. Quando sua aplicação é implantada usando Kamal, ou quando é implantada no Render, ou quando é implantada no Heroku e a funcionalidade Heroku Labs: Dyno Metadata está habilitada, a integração do AppSignal detectará automaticamente o commit Git do deploy atual e o usará como revisão. Você pode sobrescrever as revisões detectadas automaticamente no Heroku, Render ou Kamal definindo manualmente a opção de configuração revision com um valor personalizado. Saiba mais sobre marcadores de deploy no tópico de marcadores de deploy.

running_in_container

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

Descrição

O AppSignal espera estar em execução na mesma máquina entre diferentes deploys. Defina esta chave como true se a aplicação estiver sendo executada em um contêiner, como com o Docker. Versões mais recentes da integração do AppSignal detectam automaticamente o ambiente de contêiner, portanto, nenhuma configuração manual é necessária. Se você estiver tendo problemas com a detecção automática, 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 da variável de ambiente do sistema	`APPSIGNAL_SEND_ENVIRONMENT_METADATA`
Obrigatório	não
Tipo	Booleano (`true` / `false`)
Valor padrão	`true`
Disponível desde a versão	`2.2.8`

Descrição

Envia metadados de ambiente sobre a aplicação. Para mais informações, leia sobre metadados de ambiente.

send_params

Campo	Valor
Chave do arquivo de configuração	`send_params`
Chave da 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	`1.10.0`

Descrição

Define se deve-se ignorar o envio de parâmetros de requisição ao AppSignal. 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 da 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	`2.2.10`

Descrição

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

skip_session_data

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

Descrição

Aviso: Esta opção de configuração está obsoleta no pacote Elixir 2.2.10. Use a opção send_session_data em versões mais recentes do pacote Elixir.

statsd_port

Campo	Valor
Chave do arquivo de configuração	`statsd_port`
Chave da 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	`2.7.2`

Descrição

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

transaction_debug_mode

Campo	Valor
Chave do arquivo de configuração	`transaction_debug_mode`
Chave da variável de ambiente do sistema	`APPSIGNAL_TRANSACTION_DEBUG_MODE`
Obrigatório	não
Tipo	Booleano (`true` / `false`)
Valor padrão	`false`
Disponível desde a versão	`1.11.4`
	Obsoleta desde a versão 2.2.9 em favor da opção de configuração `log_level`.

Descrição

Aviso: Esta opção de configuração está obsoleta no pacote Elixir 2.2.9. Use a opção log_level no pacote Elixir 2.2.9 e versões mais recentes.

Habilita o modo de depuração de transações. Isso ativa um log muito detalhado de transações e eventos, útil ao desenvolver integrações ou quando eventos não são rastreados conforme o esperado. O log só é gravado se a opção geral debug também estiver ativada.

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

working_dir_path

Campo	Valor
Chave do arquivo de configuração	`working_dir_path`
Chave da variável de ambiente do sistema	`APPSIGNAL_WORKING_DIR_PATH`
Obrigatório	não
Tipo	`String`
Valor padrão	detectado pelo agente
Disponível desde a versão	`1.8.0`

Descrição

Aviso: Esta opção de configuração está obsoleta no pacote Elixir 1.8.0. Use a opção working_directory_path no pacote Elixir 1.8.0 e versões mais recentes.

Sobrescreve a localização onde o AppSignal for Elixir pode armazenar arquivos temporários. Use esta opção se a localização padrão não for adequada. Consulte nossa página como o AppSignal opera para mais informações sobre o propósito deste diretório de trabalho. Se você estiver executando múltiplas aplicações usando o AppSignal no mesmo servidor, use esta opção de configuração para selecionar diferentes diretórios de trabalho para cada instância do AppSignal; caso contrário, as duas instâncias podem entrar em conflito. Para mais informações sobre este cenário, consulte nossa documentação sobre executar múltiplas aplicações em um host.

Elixir

# config/config.exs
config :appsignal, :config,
  working_dir_path: "/tmp/project_1/"

Observação: O caminho especificado não pode conter abstrações de sistema de arquivos específicas do sistema operacional, como o símbolo de homedir ~ em sistemas *NIX. Isso será interpretado como um caminho mal formado.

working_directory_path

Campo	Valor
Chave do arquivo de configuração	`working_directory_path`
Chave da variável de ambiente do sistema	`APPSIGNAL_WORKING_DIRECTORY_PATH`
Obrigatório	não
Tipo	`String`
Valor padrão	detectado pelo agente
Disponível desde a versão	`1.8.0`
	Em versões anteriores, use a opção `working_dir_path`.

Descrição

Elixir

# config/appsignal.exs
config :appsignal, :config,
  working_directory_path: "/tmp/project_1/"

​Opções disponíveis

​active

​Descrição

​env

​Descrição

​name

​Descrição

​otp_app

​Descrição

​push_api_key

​Descrição

​bind_address

​Descrição

​ca_file_path

​Descrição

​cpu_count

​Descrição

​debug

​Descrição

​dns_servers

​Descrição

​ecto_repos

​Descrição

​enable_error_backend

​Descrição

​enable_host_metrics

​Descrição

​enable_minutely_probes

​Descrição

​enable_nginx_metrics

​Descrição

​enable_statsd

​Descrição

​endpoint

​Descrição

​files_world_accessible

​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_logs

​Descrição

​ignore_namespaces

​Descrição

​instrument_absinthe

​Descrição

​instrument_ecto

​Descrição

​instrument_finch

​Descrição

​instrument_oban

​Descrição

​instrument_tesla

​Descrição

​log

​Descrição

​log_level

​Descrição

​log_path

​Descrição

​nginx_port

​Descrição

​report_oban_errors

​Descrição

​request_headers

​Descrição

​revision

​Descrição

​running_in_container

Opções disponíveis

active

Descrição

env

Descrição

name

Descrição

otp_app

Descrição

push_api_key

Descrição

bind_address

Descrição

ca_file_path

Descrição

cpu_count

Descrição

debug

Descrição

dns_servers

Descrição

ecto_repos

Descrição

enable_error_backend

Descrição

enable_host_metrics

Descrição

enable_minutely_probes

Descrição

enable_nginx_metrics

Descrição

enable_statsd

Descrição

endpoint

Descrição

files_world_accessible

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_logs

Descrição

ignore_namespaces

Descrição

instrument_absinthe

Descrição

instrument_ecto

Descrição

instrument_finch

Descrição

instrument_oban

Descrição

instrument_tesla

Descrição

log

Descrição

log_level

Descrição

log_path

Descrição

nginx_port

Descrição

report_oban_errors

Descrição

request_headers

Descrição

revision

Descrição

running_in_container