Configuração do AppSignal para Node.js

Nesta seção, vamos explicar como configurar o AppSignal, o que pode ser configurado no pacote Node.js e qual é a configuração mínima necessária.

Configuração mínima necessária

A configuração mínima necessária pelo AppSignal para Node.js consiste nos itens a seguir. Se eles não estiverem presentes, o AppSignal não enviará nenhum dado para AppSignal.com.

Uma Push API Key válida
Um nome de aplicação
Um ambiente da aplicação (development/production/test definindo NODE_ENV)
A opção active: true

A integração suporta carregar sua configuração via opções passadas para o construtor Appsignal. Recomendamos criar um arquivo appsignal.cjs para fazer o require e inicializar o AppSignal.

// appsignal.cjs
const { Appsignal } = require("@appsignal/nodejs");

new Appsignal({
  active: true,
  name: "<YOUR APPLICATION NAME>",
  pushApiKey: "<YOUR API KEY>",
});

Como alternativa, você pode configurar o agente usando variáveis de ambiente do sistema. O AppSignal se tornará automaticamente ativo se a variável de ambiente APPSIGNAL_PUSH_API_KEY estiver definida.

export APPSIGNAL_PUSH_API_KEY="<YOUR API KEY>"
export APPSIGNAL_APP_NAME="<YOUR APPLICATION NAME>"
export APPSIGNAL_APP_ENV="production"

Opções de configuração

Leia sobre todas as opções de configuração na página de opções.

Ambientes da aplicação

Uma aplicação pode ter múltiplos ambientes, como “development”, “test”, “staging” e “production”. Para separar os erros e problemas de performance que ocorrem no ambiente “development” daqueles em “production”, é possível definir em qual ambiente a aplicação está rodando por meio da variável de ambiente NODE_ENV. Se você ativar o AppSignal por ambiente, pode definir a propriedade active das opções que você passa para o construtor condicionalmente:

// appsignal.cjs
const { Appsignal } = require("@appsignal/nodejs");

new Appsignal({
  active: process.env.NODE_ENV !== "development",
  name: "<YOUR APPLICATION NAME>",
  pushApiKey: "<YOUR API KEY>",
});

Isso também desativará o AppSignal ao executar seus testes.

SDKs & telemetria

SDKs de linguagem

Ferramentas de telemetria

Configuração do AppSignal para Node.js

Configuração mínima necessária

Opções de configuração

Ambientes da aplicação

​Configuração mínima necessária

​Opções de configuração

​Ambientes da aplicação

Configuração mínima necessária

Opções de configuração

Ambientes da aplicação