Opções de configuração da gem Ruby - AppSignal Documentation

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.

active

Campo	Valor
Chave do arquivo de configuração	`active`
Chave de variável de ambiente do sistema	`APPSIGNAL_ACTIVE`
Obrigatório	sim
Tipo	Boolean (`true` / `false`)
Valor padrão	`false` / detectado pelo sistema
Disponível desde a versão	`0.3.0`
	`0.11.6`: Suporte adicionado para a opção de variável de ambiente.

Descrição

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

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

APPSIGNAL_APP_ENV

Campo	Valor
Chave de variável de ambiente do sistema	`APPSIGNAL_APP_ENV`
Obrigatório	sim
Tipo	`String`
Valor padrão	`""` / detectado pelo sistema
Disponível desde a versão	`0.11.8`
	`1.3.0`: Suporte adicionado para Padrino. `1.3.6`: Suporte adicionado para Sinatra. `2.0.4`: Padroniza o comportamento para todas as configurações.

Descrição

O ambiente do aplicativo que será reportado ao AppSignal. Esta opção de configuração será detectada automaticamente em aplicativos Rails. Para aplicativos Rails, a variável RAILS_ENV é usada para detectar o ambiente. Para aplicativos que usam outros frameworks ou nenhum, a variável de ambiente RACK_ENV é utilizada. Para sobrescrever essa detecção automática, defina a variável de ambiente APPSIGNAL_APP_ENV.

Shell

export APPSIGNAL_APP_ENV=staging
rackup

Esta opção será usada para carregar a configuração dos arquivos de configuração onde a configuração do AppSignal é armazenada. A opção de variável de ambiente é comumente usada em plataformas onde os aplicativos rodam no ambiente production por padrão, como o Heroku. Essa configuração permite uma substituição para definir o ambiente como staging, por exemplo.

Shell

heroku config:set APPSIGNAL_APP_ENV=staging

Se o ambiente for definido usando o helper Appsignal.configure, ele substituirá a variável de ambiente APPSIGNAL_APP_ENV.

Observação: alterar o nome ou o ambiente de um aplicativo existente criará um novo aplicativo no AppSignal.com.

Observação: esta opção de configuração não tem equivalente como chave em arquivo de configuração. Para definir o ambiente na inicialização do AppSignal, você precisará inicializar a configuração manualmente.

Ambientes personalizados no arquivo de configuração

Não existe uma chave env disponível no arquivo config/appsignal.yml. Se você deseja definir dinamicamente o nome do ambiente para um aplicativo no arquivo de configuração, é possível personalizar seu arquivo de configuração para usar a variável de ambiente para criar um ambiente.

YAML

# config/appsignal.yml
<%= ENV["APPSIGNAL_APP_ENV"] %>:
  active: true

Se você usar outra variável de ambiente diferente de APPSIGNAL_APP_ENV, certifique-se de que o valor corresponda a algum dos nomes de variáveis de ambiente detectados automaticamente (RAILS_ENV e RACK_ENV) ou ao valor fornecido para Appsignal.configure.

Observação: alterar o nome ou o ambiente de um aplicativo existente criará um novo aplicativo no AppSignal.com.

name

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

Descrição

Nome da sua aplicação como deve ser exibido no AppSignal.com. Se você usar Ruby on Rails, a gem detectará automaticamente o nome e você pode deixar este campo vazio. Para outros frameworks, definir isso é obrigatório.

Nota: Alterar o nome ou o ambiente de uma aplicação existente criará uma nova aplicação 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)
Disponível desde a versão	`0.1.0`

Descrição

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

Nota: Quando a variável de ambiente do sistema APPSIGNAL_PUSH_API_KEY está definida, a opção active terá como 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.

activejob_report_errors

Campo	Valor
Chave do arquivo de configuração	`activejob_report_errors`
Chave de variável de ambiente do sistema	`APPSIGNAL_ACTIVEJOB_REPORT_ERRORS`
Obrigatório	não
Tipo	`String`
Valor padrão	`all`
Disponível desde a versão	`3.6.1`
	O valor `discard` foi adicionado na gem Ruby 3.7.3. A variável de ambiente `APPSIGNAL_ACTIVEJOB_REPORT_ERRORS` foi adicionada na gem Ruby 3.9.0.

Descrição

Configura o relato de erros que ocorrem em jobs do Active Job. Esta opção permite desativar o relato de erros para jobs do Active Job, permitindo que um relato de erros personalizado seja adicionado. Valores aceitos:

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

Observação: a opção discard só funciona no Active Job 7.1 e mais recente. Em versões inferiores, discard é lido como all.

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

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 você quiser que o agente escute apenas as requisições feitas para 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 as 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` empacotado.
Disponível desde a versão	`1.3.5`

Descrição

Configure o caminho do arquivo de certificado SSL. Por padrão, aponta para o arquivo cacert.pem empacotado na própria gem do AppSignal. Use esta opção para apontar para outro arquivo de certificado se houver um problema ao 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 homedir ~ em 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	`3.6.3`

Descrição

A capacidade de CPU disponível do host, em número de CPUs. Isso é usado para calcular a porcentagem de uso de CPU nas métricas do host. Se não for 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.

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`
	Obsoleto desde a versão 3.0.16 em favor da opção de configuração `log_level`.

Descrição

Aviso: Esta opção de configuração está obsoleta na gem Ruby 3.0.16. Use a opção log_level em vez disso para a gem Ruby 3.0.16 e versões mais recentes.

Habilita o log de depuração. Geralmente isso só é necessário 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 log de depuração 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 depuração 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.

default_tags

Campo	Valor
Chave do arquivo de configuração	`default_tags`
Chave de variável de ambiente do sistema	`APPSIGNAL_DEFAULT_TAGS`
Obrigatório	não
Tipo	`Hash[String, (String \| Symbol \| Integer \| Boolean)]`
Valor padrão	undefined
Disponível desde a versão	`4.8.3`

Descrição

Tags padrão que serão adicionadas a todas as transações. Tags específicas de transação definidas com Appsignal.add_tags substituirão as tags padrão com a mesma chave.

Appsignal.configure do |config|
  config.default_tags = {
    "region" => "europe",
    "shard" => "shard-1"
  }
end

default: &defaults
  default_tags:
    region: europe
    shard: shard-1

Ao usar a variável de ambiente, forneça uma lista de pares chave-valor separados por vírgula.

Shell

export APPSIGNAL_DEFAULT_TAGS="region=europe,shard=shard-1"

Os valores das tags devem ser do tipo String, Symbol, Integer ou Boolean. Tags com outros tipos de valor serão ignoradas. Leia mais sobre tagging.

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	`Array<String>`
Valor padrão	`[]`
Disponível desde a versão	`2.2.0.beta.1`
	`2.11.0`: Adicionado suporte para a opção de variável de ambiente do sistema.

Descrição

Configure os servidores DNS que o agente do AppSignal deve usar.

Appsignal.configure do |config|
  config.dns_servers = ["8.8.8.8", "8.8.4.4"]
end

default: &defaults
  dns_servers:
    - 8.8.8.8
    - 8.8.4.4

# In the host environment
export APPSIGNAL_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 exibirá uma mensagem no arquivo appsignal.log: A problem occurred while setting DNS servers.

enable_active_support_event_log_reporter

Campo	Valor
Chave do arquivo de configuração	`enable_active_support_event_log_reporter`
Chave de variável de ambiente do sistema	`APPSIGNAL_ENABLE_ACTIVE_SUPPORT_EVENT_LOG_REPORTER`
Obrigatório	não
Tipo	`Boolean`
Valor padrão	`true`
Disponível desde a versão	`4.8.0`

Descrição

Habilita a integração de relatório estruturado de eventos do ActiveSupport::EventReporter. Quando habilitada, a integração do AppSignal se inscreve nos eventos emitidos pelo ActiveSupport::EventReporter e os reporta como logs.

enable_allocation_tracking

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

Descrição

Defina esta opção como false para desabilitar o rastreamento do número de objetos alocados em Ruby.

enable_at_exit_hook

Campo	Valor
Chave do arquivo de configuração	`enable_at_exit_hook`
Chave de variável de ambiente do sistema	`APPSIGNAL_ENABLE_AT_EXIT_HOOK`
Obrigatório	não
Tipo	`String`
Valor padrão	’on_error’ / ‘always’ em containers
Disponível desde a versão	`4.5.8`

Descrição

Configura como o AppSignal é encerrado quando a aplicação é encerrada. Isso determinará se ele chama Appsignal.stop automaticamente, que fará flush dos dados para a extensão e o agente. Esta opção tem três valores possíveis:

always: Sempre chama Appsignal.stop quando o programa é encerrado. Em containers (Docker), é automaticamente definido para este valor.
never: Nunca chama Appsignal.stop quando o programa é encerrado. O valor padrão quando o programa não está sendo executado em um container (Docker).
on_error: Chama Appsignal.stop quando o programa é encerrado com erro.

Para mais informações, consulte nossa página de instrumentação para scripts e jobs em background.

enable_at_exit_reporter

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

Descrição

Defina como true para reportar o último erro que causou o encerramento do processo. O erro reportado geralmente é o erro que faz o processo travar. Se a gem Ruby já reportou o erro, ela não o reportará novamente. Erros reportados por meio desse mecanismo são adicionados ao namespace “unhandled”. Adicione este código ao início da aplicação em containers de curta duração e funções serverless para garantir que o erro seja enviado antes que o sistema seja encerrado.

Ruby

at_exit { sleep 5 }

enable_frontend_error_catching

Campo	Valor
Chave do arquivo de configuração	`enable_frontend_error_catching`
Chave de variável de ambiente do sistema	`APPSIGNAL_ENABLE_FRONTEND_ERROR_CATCHING`
Obrigatório	não
Tipo	Booleano (`true` / `false`)
Valor padrão	`false`
Disponível desde a versão	`1.0.0`
	`3.0.0`: Removido da gem. Consulte nosso guia de upgrade para mais informações.

Descrição

Habilita o sistema experimental de captura de erros de front-end. Isso adicionará uma rota à sua aplicação em /appsignal_error_catcher que pode ser usada para capturar erros de JavaScript e enviá-los ao AppSignal. Você pode configurar esta rota com frontend_error_catching_path.

enable_gvl_global_timer

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

Descrição

Defina esta opção como false para desabilitar a instrumentação do timer global da GVL. Esta opção de configuração não tem efeito se o GVLTools não estiver instalado.

enable_gvl_waiting_threads

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

Descrição

Defina esta opção como false para desabilitar a instrumentação de threads em espera da GVL. Esta opção de configuração não tem efeito se o GVLTools não estiver instalado.

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

Descrição

Defina esta opção como false para desabilitar 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 reportarão métricas imprecisas a partir de dentro dos containers. A coleta de métricas do host nesses sistemas não pode ser habilitada. Para o Heroku, use o log drain do Heroku em vez disso.

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.3.0`
	`2.9.0`: O valor padrão foi alterado para `true`.

Descrição

Habilita o sistema de probes por minuto.

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

Descrição

Defina como true para habilitar o servidor de métricas do NGINX. Consulte 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_rails_error_reporter

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

Descrição

Defina como false para desabilitar o subscriber do error reporter do Rails. Consulte a documentação do Rails para mais detalhes.

enable_rake_performance_instrumentation

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

Descrição

Habilita a instrumentação de performance para tarefas Rake. Por padrão, a instrumentação do Rake reporta apenas erros.

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

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`
Disponível desde a versão	`0.1.0`
	`1.0.0`: Adicionado suporte para variável de ambiente do sistema.

Descrição

Configure o endpoint para enviar dados ao AppSignal. Esta configuração não precisará 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	`2.3.6`

Descrição

Se isso for definido como true, o diretório de trabalho do AppSignal que é criado é acessível para todos os usuários (permissões Unix 0666). Isso geralmente é necessário porque processos para a mesma aplicação são executados sob um usuário diferente. Defina como false para desabilitar esse comportamento (permissões Unix 0644).

filter_metadata

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

Descrição

A gem Ruby do AppSignal armazena metadados sobre requisições e jobs em background nas amostras por padrão, como caminho da requisição, método da requisição, id da requisição, fila do background job, id do job e contagem de tentativas do job. Esses valores de metadados serão exibidos na caixa de tags. Se algum desses valores de metadados contiver PII ou outros dados sensíveis, use esta opção de configuração para filtrar os metadados por chave. Defina a opção filter_metadata como uma lista de chaves de metadados que devem ser filtradas. Você pode configurar isso com uma lista de chaves no arquivo de configuração. Quando filtrados, os metadados não estarão visíveis na interface do AppSignal.

Appsignal.configure do |config|
  config.filter_metadata += ["path", "request_id"]
end

default: &defaults
  filter_metadata:
    - path
    - request_id

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	`1.3.0`
	`2.3.0`: Esta opção de configuração também é usada para filtragem de argumentos em integrações de background jobs.

Descrição

Lista de chaves de parâmetros que devem ser ignoradas pela filtragem do AppSignal. Seus valores serão substituídos por [FILTERED] quando transmitidos ao AppSignal. Você pode configurar isso com uma lista de chaves no arquivo de configuração.

Appsignal.configure do |config|
  config.filter_parameters += ["password", "email", "api_token", "token"]
end

# config/appsignal.yml
default: &defaults
  filter_parameters:
    - password
    - email
    - api_token
    - token

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	`2.6.0`
	É recomendada a atualização para a versão `2.6.1` ou superior.

Descrição

Lista de chaves de dados de sessão que devem ser ignoradas pela filtragem do AppSignal. Seus valores serão substituídos por [FILTERED] quando transmitidos ao AppSignal. Você pode configurar isso com uma lista de chaves no arquivo de configuração.

Appsignal.configure do |config|
  config.filter_session_data += ["name", "email", "api_token", "token"]
end

# config/appsignal.yml
default: &defaults
  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	`3.4.11`

Descrição

Agrupa hosts por função (role) e gera métricas baseadas nessa 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 a partir do sistema
Disponível desde a versão	`1.3.6`

Descrição

Isso sobrescreve o hostname do servidor. Útil para quando você não consegue definir um hostname personalizado ou quando um id não 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)
Disponível desde a versão	`0.11.13`

Descrição

Se você precisar que o agente se conecte à Internet através 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.10.0`

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 acontecer, incluindo exceções, não será transmitido ao 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.1.0`

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	`Array<String>`
Valor padrão	`[]`
Disponível desde a versão	`3.7.0`

Descrição

Lista de mensagens de log que serão ignoradas. Qualquer mensagem de log que contenha 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 Ignore 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	`Array<String>`
Valor padrão	`[]`
Disponível desde a versão	`2.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_code_ownership

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

Descrição

Define se a gem CodeOwnership deve ser instrumentada automaticamente. Pode ser true ou false.

instrument_http_rb

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

Descrição

Habilita ou desabilita a instrumentação para a gem http.rb do Ruby. Habilitado por padrão.

instrument_net_http

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

Descrição

Define se deve adicionar instrumentação para chamadas net/http. Pode ser true ou false.

instrument_ownership

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

Descrição

Define se a gem Ownership deve ser instrumentada automaticamente. Pode ser true ou false.

instrument_redis

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

Descrição

Define se deve habilitar a instrumentação para consultas Redis usando a gem Redis. Pode ser true ou false.

instrument_sequel

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

Descrição

Define se deve adicionar instrumentação para consultas sequel usando a integração com a gem Sequel. Pode ser true ou false.

log

Campo	Valor
Chave do arquivo de configuração	`log`
Chave de variável de ambiente do sistema	`APPSIGNAL_LOG`
Obrigatório	não
Tipo	`String`
Valor padrão	`file`
Disponível desde a versão	`2.0.0`

Descrição

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

Selecione qual logger a integração do AppSignal usará. 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 containers e Heroku.

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`
Disponível desde a versão	`3.0.16`

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 configurado como “info”, ele registrará todas as mensagens de erro, aviso e info, mas não registrará as mensagens de debug. Definir 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 de debug habilitada. Valores aceitos:

error
warning
info
debug
trace

log_path

Campo	Valor
Chave do arquivo de configuração	`log_path`
Chave de variável de ambiente do sistema	`APPSIGNAL_LOG_PATH`
Obrigatório	não
Tipo	`String`
Valor padrão	`./log`
Disponível desde a versão	`1.0.0`

Descrição

Esta opção configura a localização do arquivo de logging interno do AppSignal e não afeta o recurso de logging.
Nota: 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 malformado.

Sobrescreve 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 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	`4.5.15`

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 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.

ownership_set_namespace

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

Descrição

Define se a instrumentação da gem Ownership deve definir o namespace de uma amostra para seu owner. Pode ser true ou false.

request_headers

Campo	Valor
Chave do arquivo de configuração	`request_headers`
Chave de variável de ambiente do sistema	`APPSIGNAL_REQUEST_HEADERS`
Obrigatório	não
Tipo	`Array<String>`
Valor padrão	`["HTTP_ACCEPT", "HTTP_ACCEPT_CHARSET", "HTTP_ACCEPT_ENCODING", "HTTP_ACCEPT_LANGUAGE", "HTTP_CACHE_CONTROL", "HTTP_CONNECTION", "CONTENT_LENGTH", "PATH_INFO", "HTTP_RANGE", "REQUEST_METHOD", "REQUEST_PATH", "SERVER_NAME", "SERVER_PORT", "SERVER_PROTOCOL"]`
Disponível desde a versão	`2.6.0`
	Recomenda-se atualizar para `2.6.1` ou superior. A partir de `3.5.6`, `REQUEST_URI` deixou de ser incluído por padrão. Agora `REQUEST_PATH` é incluído em seu lugar.

Descrição

A opção de configuração request_headers contém uma lista de cabeçalhos HTTP de requisição que são lidos e armazenados pela gem AppSignal Ruby. Esta opção de configuração request_headers é uma allowlist (lista de permissões), o que significa que apenas os cabeçalhos especificados por esta opção de configuração serão considerados. Se esta opção de configuração não for definida, será usado o padrão do AppSignal.

Appsignal.configure do |config|
  # Add a request header
  config.request_headers << "PATH_INFO"

  # Remove a request header
  config.request_headers.delete("PATH_INFO")
end

# To add an additional request header it's necessary to list all default headers too
default: &defaults
  request_headers:
    - HTTP_ACCEPT
    - HTTP_ACCEPT_CHARSET
    - HTTP_ACCEPT_ENCODING
    - HTTP_ACCEPT_LANGUAGE
    - HTTP_CACHE_CONTROL
    - HTTP_CONNECTION
    - CONTENT_LENGTH
    - PATH_INFO
    - HTTP_RANGE
    - REQUEST_METHOD
    - REQUEST_PATH
    - SERVER_NAME
    - SERVER_PORT
    - SERVER_PROTOCOL

Observe que o AppSignal lê os cabeçalhos do seu aplicativo e eles podem não corresponder exatamente ao que está sendo enviado pelo navegador/cliente. Em aplicativos Rack (Rails, Sinatra, etc), todos os cabeçalhos personalizados são prefixados com a string HTTP_, todos os nomes de cabeçalhos são convertidos para maiúsculas e os hífens (-) são substituídos por sublinhados (_). Por exemplo, o cabeçalho X-Hub-Signature pode ser acessado pelo seu aplicativo e pelo AppSignal com o nome HTTP_X_HUB_SIGNATURE. Para configurar o AppSignal para não armazenar nenhum cabeçalho HTTP de requisição nas transações do AppSignal, configure a opção com um array vazio.

Appsignal.configure do |config|
  config.request_headers = []
end

default: &defaults
  request_headers: []

revision

Campo	Valor
Chave do arquivo de configuração	`revision`
Chave de 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	`2.6.0`
	Recomenda-se atualizar para `2.6.1` ou superior ao usar esta opção. `2.9.13`: Detecção automática para deploys no Heroku com o recurso Dyno Metadata labs habilitado. `2.9.14`: Não use esta versão se você depender da detecção de dyno metadata do Heroku. `3.4.7`: Detecção automática para deploys no Render. `3.7.5`: Detecção automática para deploys no Kamal. `4.5.18`: Detecção automática para deploys no Capistrano. `4.5.18`: Detecção automática para deploys no Hatchbox.io.

Descrição

Define a revisão do aplicativo para reportar a versão do seu aplicativo que está em execução. O AppSignal criará um marcador de deploy quando este valor for alterado e marcará todos os dados recebidos com a revisão atual. Quando seu aplicativo é implantado usando Kamal, ou quando é implantado no Render, ou quando é implantado no Heroku e o recurso Heroku Labs: Dyno Metadata está habilitado, a integração do AppSignal detectará automaticamente o commit do 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. Leia mais sobre marcadores de deploy no tópico sobre marcadores de deploy.

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	`1.0.0`
	Detectado automaticamente desde a versão `2.0`

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`
Disponível desde a versão	`2.11.0`

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.9.0`
	`1.3.0`: Suporte adicionado para a opção de variável de ambiente do sistema.

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

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.

sidekiq_report_errors

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

Descrição

Configure o relatório de erros que ocorrem em jobs do Sidekiq. Valores aceitos:

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 erros para jobs, incluindo retentativas. Útil para relatórios de erros personalizados.

Nota: A opção discard só funciona no Sidekiq 5.1 e superior. Em versões anteriores, discard é interpretado como all.

skip_session_data

Campo	Valor
Chave do arquivo de configuração	`skip_session_data`
Chave de variável de ambiente do sistema	`APPSIGNAL_SKIP_SESSION_DATA`
Obrigatório	não
Tipo	Booleano (`true` / `false`)
Valor padrão	`false`
Disponível desde a versão	`0.11.0`
	`3.0.20`: Descontinuado em favor de `send_session_data`.

Descrição

Aviso: Esta opção de configuração foi descontinuada na gem Ruby 3.0.20. Por favor, use a opção send_session_data em versões mais recentes da gem Ruby.

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

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.

transaction_debug_mode

Campo	Valor
Chave do arquivo de configuração	`transaction_debug_mode`
Chave de 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	`2.9.18`
	Descontinuado desde a versão 3.0.16 em favor da opção de configuração `log_level`.

Descrição

Aviso: Esta opção de configuração foi descontinuada na gem Ruby 3.0.16. Por favor, use a opção log_level em vez disso para a gem Ruby 3.0.16 e versões mais novas.

Habilita o modo de depuração de transações. Isso habilita um log muito detalhado de transações e eventos, o que é útil ao desenvolver integrações ou quando os 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 o recurso de logging.

working_dir_path

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

Descrição

Aviso: Esta opção de configuração foi descontinuada na gem Ruby 2.7.0. Por favor, use a opção working_directory_path em vez disso para a gem Ruby 2.7.0 e versões mais novas.

Sobrescreve o local onde o AppSignal para Ruby cria um diretório de trabalho. Veja working_directory_path para entender o comportamento aplicável. Esta opção de configuração acrescenta /appsignal ao caminho especificado, enquanto working_directory_path não acrescenta.

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.

working_directory_path

Campo	Valor
Chave do arquivo de configuração	`working_directory_path`
Chave de 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	`2.7.0`
	`2.10.12`: Suporte adicionado para a opção de variável de ambiente do sistema. Por favor, use a opção `working_dir_path` em versões anteriores à 2.7.0.

Descrição

Sobrescreve o local onde o AppSignal para Ruby 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. Se você estiver executando múltiplos aplicativos usando o AppSignal no mesmo servidor, use esta opção de configuração para selecionar diretórios de trabalho diferentes 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, veja nossa documentação executando múltiplos aplicativos em um host.

Appsignal.configure do |config|
  config.working_directory_path = "/tmp/project_1/"
end

default: &defaults
  working_directory_path: "/tmp/project_1/"

Configuração do AppSignal Ruby

Ordem de carregamento do AppSignal para Ruby

⌘I

​Opções disponíveis

​active

​Descrição

​APPSIGNAL_APP_ENV

​Descrição

​Ambientes personalizados no arquivo de configuração

​name

​Descrição

​push_api_key

​Descrição

​activejob_report_errors

​Descrição

​bind_address

​Descrição

​ca_file_path

​Descrição

​cpu_count

​Descrição

​debug

​Descrição

​default_tags

​Descrição

​dns_servers

​Descrição

​enable_active_support_event_log_reporter

​Descrição

​enable_allocation_tracking

​Descrição

​enable_at_exit_hook

​Descrição

​enable_at_exit_reporter

​Descrição

​enable_frontend_error_catching

​Descrição

​enable_gvl_global_timer

​Descrição

​enable_gvl_waiting_threads

​Descrição

​enable_host_metrics

​Descrição

​enable_minutely_probes

​Descrição

​enable_nginx_metrics

​Descrição

​enable_rails_error_reporter

​Descrição

​enable_rake_performance_instrumentation

​Descrição

​enable_statsd

​Descrição

​endpoint

​Descrição

​files_world_accessible

​Descrição

​filter_metadata

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

​Descrição

​instrument_http_rb

​Descrição

​instrument_net_http

​Descrição

Opções disponíveis

active

Descrição

APPSIGNAL_APP_ENV

Descrição

Ambientes personalizados no arquivo de configuração

name

Descrição

push_api_key

Descrição

activejob_report_errors

Descrição

bind_address

Descrição

ca_file_path

Descrição

cpu_count

Descrição

debug

Descrição

default_tags

Descrição

dns_servers

Descrição

enable_active_support_event_log_reporter

Descrição

enable_allocation_tracking

Descrição

enable_at_exit_hook

Descrição

enable_at_exit_reporter

Descrição

enable_frontend_error_catching

Descrição

enable_gvl_global_timer

Descrição

enable_gvl_waiting_threads

Descrição

enable_host_metrics

Descrição

enable_minutely_probes

Descrição

enable_nginx_metrics

Descrição

enable_rails_error_reporter

Descrição

enable_rake_performance_instrumentation

Descrição

enable_statsd

Descrição

endpoint

Descrição

files_world_accessible

Descrição

filter_metadata

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_code_ownership

Descrição

instrument_http_rb

Descrição

instrument_net_http

Descrição