Opções disponíveis
- Opções obrigatórias
- Opções
additionalInstrumentationsbindAddresscaFilePathcpuCountdebugdisableDefaultInstrumentationsdnsServersenableHostMetricsenableMinutelyProbesenableNginxMetricsenableOpentelemetryHttpenableStatsdfilesWorldAccessiblefilterParametersfilterSessionDatahostnamehostRolehttpProxyignoreActionsignoreErrorsignoreLogsignoreNamespacesloglogLevellogPathnginxPortopentelemetry_portrequestHeadersrevisionrunningInContainersendEnvironmentMetadatasendParamssendSessionDatastatsdPortworkingDirectoryPath
active
Descrição
Configure o AppSignal para estar ativo ou não em um determinado ambiente. Mais comumente usado na configuração por arquivo por ambiente.environment
Descrição
O ambiente da aplicação a ser reportado ao AppSignal.Nota: Alterar o nome ou o ambiente de uma aplicação
existente criará uma nova aplicação no AppSignal.com.
name
Descrição
Nome do seu aplicativo como ele deve ser exibido no AppSignal.com.Nota: Alterar o nome ou o ambiente de um aplicativo existente
criará um novo aplicativo no AppSignal.com.
pushApiKey
Descrição
A chave de autenticação em nível de organização para autenticar com nossa Push API. Saiba mais sobre a chave da Push API do AppSignal.additionalInstrumentations
Descrição
Lista de instrumentações adicionais do OpenTelemetry para usar com o AppSignal, por meio de bibliotecas de terceiros ou suas próprias integrações.bindAddress
Descrição
Um endereço IPv4 válido que o agente AppSignal usa como vínculo para seus servidores TCP e UDP. Use um endereço específico se você quiser apenas que o agente escute solicitações feitas a esse endereço. Defina essa opção como0.0.0.0 para permitir o recebimento de solicitações de hosts usando qualquer endereço IP. Por padrão, ele só escuta solicitações feitas no mesmo host. Essa opção é aplicada a todos os servidores do agente (StatsD, OpenTelemetry e NGINX).
caFilePath
Descrição
Use essa opção para apontar para outro arquivo de certificado se houver um 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 homedir
~
para sistemas *NIX. Isso será visto como um caminho malformado.cpuCount
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
Descrição
Ativa o logging de debug, isso geralmente só é necessário a pedido do suporte. Com essa opção ativada, o AppSignal registrará muito mais informações sobre as decisões tomadas durante a coleta de métricas e quando os dados são enviados aos servidores do AppSignal.com. Ativar 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 ativada.Esta opção define o nível de severidade do logger interno do AppSignal. Essa
opção de configuração não afeta o recurso de logging.
disableDefaultInstrumentations
Descrição
Permite desabilitar a instrumentação automática das integrações padrão:- @appsignal/opentelemetry-instrumentation-bullmq
- @opentelemetry/instrumentation-amqplib
- @opentelemetry/instrumentation-express
- @opentelemetry/instrumentation-fastify
- @opentelemetry/instrumentation-graphql
- @opentelemetry/instrumentation-http
- @opentelemetry/instrumentation-ioredis
- @opentelemetry/instrumentation-knex
- @opentelemetry/instrumentation-koa
- @opentelemetry/instrumentation-mongodb
- @opentelemetry/instrumentation-mongoose
- @opentelemetry/instrumentation-mysql2
- @opentelemetry/instrumentation-mysql
- @opentelemetry/instrumentation-nestjs-core
- @opentelemetry/instrumentation-pg
- @opentelemetry/instrumentation-redis
- @opentelemetry/instrumentation-redis-4
- @opentelemetry/instrumentation-restify
- @opentelemetry/instrumentation-undici
- @prisma/instrumentation
true.
dnsServers
Descrição
Configure servidores DNS para o agente AppSignal usar.Shell
- Valores aceitáveis:
8.8.8.8,my.custom.local.server. - Valores não aceitáveis:
foo,my.awesome.custom.local.dns.server.
appsignal.log: A problem occurred while setting DNS servers.
enableHostMetrics
Descrição
Defina essa opção comofalse para desabilitar a coleta de métricas de host.
No Heroku e Dokku, as métricas de host estão desabilitadas por padrão. Isso é feito porque esses sistemas reportarão métricas imprecisas de dentro dos containers. A coleta de métricas de host nesses sistemas não pode ser ativada. Para Heroku, use o Heroku log drain em vez disso.
enableMinutelyProbes
Descrição
Habilita o sistema de probes a cada minuto.enableNginxMetrics
Descrição
Defina comotrue para habilitar o servidor de métricas do NGINX. Veja a documentação de métricas do NGINX para detalhes.
Quando habilitado, o agente 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, essa opção de configuração só pode ser habilitada em uma delas.
enableOpentelemetryHttp
Descrição
Defina essa opção comotrue para habilitar o servidor HTTP do OpenTelemetry.
Quando habilitado, o agente 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, essa opção de configuração só pode ser habilitada em uma delas.
Isso é necessário para aplicações que usam o exporter HTTP do OpenTelemetry para reportar dados ao AppSignal.
enableStatsd
Descrição
Habilita o servidor StatsD no agente AppSignal. Quando habilitado, o agente AppSignal escutará em um servidor vinculado alocalhost na porta 8125. Se você estiver executando várias aplicações instrumentadas com AppSignal no mesmo servidor, essa opção de configuração só pode ser habilitada em uma delas.
filesWorldAccessible
Descrição
Se isso for definido comotrue, o diretório de trabalho do AppSignal que é criado fica acessível para todos os usuários (permissões Unix 0666). Isso é frequentemente necessário porque os processos da mesma aplicação rodam sob usuários diferentes. Defina como false para desabilitar esse comportamento (permissões Unix 0644).
filterParameters
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.
Leia mais sobre filtragem de parâmetros.
filterSessionData
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.
Leia mais sobre filtragem de dados de sessão.
hostname
Descrição
Isso sobrescreve 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.hostRole
Descrição
Agrupe hosts por role (função) e gere métricas com base nesse role. Uma dessas métricas é a métrica do tipo counterreporting_hosts. Um bom role indica qual é o papel principal do servidor, como “webserver”, “processor”, “api”, “database”, “loadbalancer”, etc.
httpProxy
Descrição
Se você precisar que o agente se conecte à Internet via um proxy, defina a URL completa do proxy nessa chave de configuração.ignoreActions
Descrição
Com essa 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 quer monitorar. Leia mais sobre como ignorar actions.ignoreErrors
Descrição
Lista de classes de erro que serão ignoradas. Qualquer exceção levantada com essa classe de erro não será transmitida ao AppSignal. Leia mais sobre como ignorar erros.ignoreLogs
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 de sintaxe regex é suportado, leia mais sobre isso em nosso guia Ignore Logs.ignoreNamespaces
Descrição
Lista de namespaces que serão ignorados. Qualquer erro gerado ou requisição lenta que ocorrer nesse namespace não será enviado ao AppSignal. Saiba mais sobre namespaces.log
Descrição
Esta opção configura qual logger a funcionalidade de logging interna 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”.
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.
logLevel
Descrição
Esta opção define o nível de severidade do logger interno do AppSignal e não
afeta o recurso de logging.
- error
- warning
- info
- debug
- trace
logPath
Descrição
Esta opção configura a localização do arquivo de log 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 diretório home
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á
visto como um caminho malformado.appsignal.log pode
ser escrito.
nginxPort
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 alocalhost, por padrão na porta 27649. Se você estiver executando vários aplicativos instrumentados com AppSignal no mesmo servidor com métricas do NGINX habilitadas, use esta opção para configurar cada aplicativo para escutar em uma porta diferente.
opentelemetry_port
Descrição
Defina esta opção para configurar a porta do servidor HTTP OpenTelemetry do processo do agente AppSignal. Configure esta porta se outro processo já estiver em execução na máquina e também estiver usando esta porta para evitar conflitos.requestHeaders
Descrição
A opção de configuraçãorequestHeaders contém uma lista de cabeçalhos de requisição HTTP que são lidos e armazenados pelo pacote AppSignal para Node.js.
Esta opção de configuração requestHeaders é uma allowlist, o que significa que ela só aceitará cabeçalhos conforme especificado por esta opção de configuração. Se esta opção de configuração não for definida, o padrão do AppSignal será usado.
A lista a seguir é o padrão do pacote AppSignal.
Node.js
Node.js
revision
Descrição
Define a revisão do aplicativo para reportar a versão atualmente em execução do seu aplicativo. O AppSignal criará um marcador de deploy quando esse valor mudar 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çãorevision com um valor personalizado.
Saiba mais sobre marcadores de deploy no tópico de marcadores de deploy.
runningInContainer
Descrição
O AppSignal espera estar em execução na mesma máquina entre diferentes deploys. Defina esta chave comotrue se o aplicativo estiver em execução em um contêiner, como com Docker.
Versões mais recentes da integração do AppSignal detectam automaticamente seu ambiente de contêiner, portanto, nenhuma configuração manual é necessária. Se você tiver problemas com a detecção automática, por favor entre em contato com o suporte.
Esta opção é definida automaticamente como true no Heroku.
sendEnvironmentMetadata
Descrição
Enviar metadados de ambiente sobre o aplicativo. Para mais informações, leia sobre metadados de ambiente.sendParams
Descrição
Define se deve pular o envio de parâmetros de requisição ao AppSignal. Para mais informações, leia sobre send_params em filtragem de parâmetros de requisição.sendSessionData
Descrição
Defina esta opção comofalse para não enviar nenhum dado de sessão com traces de exceções e amostras de problemas de desempenho.
Para mais informações, leia sobre filtragem de dados de sessão de requisição.
statsdPort
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 e também estiver usando esta porta para evitar conflitos.workingDirectoryPath
Descrição
Substitui o local onde o AppSignal para Node.js 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 o propósito deste diretório de trabalho. Se você estiver executando vários 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 uma com a outra. Para mais informações sobre esse cenário, consulte nossa documentação sobre execução de múltiplos aplicativos em um host.Node.js
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á
visto como um caminho malformado.