Opções de configuração do AppSignal for PHP

O AppSignal for PHP pode ser configurado através do arquivo config/appsignal.php ou usando variáveis de ambiente. Esta página lista todas as opções de configuração disponíveis. Saiba mais sobre a ordem de carregamento da configuração. Depois de configurar o AppSignal, você pode validar a configuração atual:

Shell

vendor/bin/appsignal validate

collector_endpoint

Campo	Valor
Chave do arquivo de configuração	`collector_endpoint`
Chave de variável de ambiente do sistema	`APPSIGNAL_COLLECTOR_ENDPOINT`
Obrigatório	sim
Tipo	`String`
Valor padrão	`null` (não definido por padrão)

Descrição

A URL do coletor do AppSignal para o qual enviar dados de trace, métricas e logs. O AppSignal exibe esta URL ao criar um novo aplicativo, e também está disponível para aplicativos existentes.

config/appsignal.php

return [
    'collector_endpoint' => $_ENV['APPSIGNAL_COLLECTOR_ENDPOINT'] ?? null,
    // ... other options
];

environment

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

Descrição

O ambiente do aplicativo a ser reportado ao AppSignal.

config/appsignal.php

return [
    'environment' => $_ENV['APPSIGNAL_APP_ENV'] ?? 'production',
    // ... other options
];

Nota: 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	`null` (não definido por padrão)

Descrição

O nome de exibição do seu aplicativo no AppSignal.com.

config/appsignal.php

return [
    'name' => 'My App',
    // ... other options
];

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

push_api_key

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

Descrição

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

config/appsignal.php

return [
    'push_api_key' => $_ENV['APPSIGNAL_PUSH_API_KEY'] ?? '00000000-0000-0000-0000-000000000000',
    // ... other options
];

active

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

Descrição

Configura se o AppSignal está ativo para um determinado ambiente. Mais comumente usado na configuração por arquivo por ambiente.

app_path

Campo	Valor
Chave do arquivo de configuração	`app_path`
Obrigatório	não
Tipo	`String`
Valor padrão	detectado a partir da raiz do projeto

Descrição

A localização do aplicativo no sistema de arquivos do host. Ajuda o AppSignal a limpar backtraces removendo o caminho absoluto do aplicativo das linhas de backtrace, mostrando apenas caminhos dentro do diretório do projeto. Isso torna possível nosso recurso de Backtrace links. O pacote AppSignal define este valor automaticamente com base na raiz do projeto detectada. Se a detecção automática do caminho do aplicativo não funcionar, você pode sobrescrevê-la:

config/appsignal.php

return [
	'app_path' => '/var/www/html/your-app'
    // ... other options
];

filter_attributes

Campo	Valor
Chave do arquivo de configuração	`filter_attributes`
Chave de variável de ambiente do sistema	`APPSIGNAL_FILTER_ATTRIBUTES`
Obrigatório	não
Tipo	`Array<String>`
Valor padrão	`[]`

Descrição

A opção de configuração filter_attributes permite que você filtre atributos específicos para que não sejam reportados ao AppSignal. Isso pode ser útil para filtrar informações sensíveis ou não relevantes. Se um atributo for filtrado dessa forma, ele não aparecerá na interface.

config/appsignal.php

return [
    'filter_attributes' => ['my.secret.attribute', 'some.opentelemetry.attribute'],
    // ... other options
];

filter_function_parameters

Campo	Valor
Chave do arquivo de configuração	`filter_function_parameters`
Chave de variável de ambiente do sistema	`APPSIGNAL_FILTER_FUNCTION_PARAMETERS`
Obrigatório	não
Tipo	`Array<String>`
Valor padrão	`[]`

Descrição

Esta opção de configuração permite que você filtre quaisquer parâmetros de função definidos no atributo de span appsignal.function.parameters. O AppSignal substitui os valores das chaves listadas na opção de configuração filter_function_parameters por [FILTERED].

config/appsignal.php

return [
    'filter_function_parameters' => ['api_token', 'secret'],
    // ... other options
];

filter_request_payload

Campo	Valor
Chave do arquivo de configuração	`filter_request_payload`
Chave de variável de ambiente do sistema	`APPSIGNAL_FILTER_REQUEST_PAYLOAD`
Obrigatório	não
Tipo	`Array<String>`
Valor padrão	`[]`

Descrição

Esta opção de configuração permite que você filtre quaisquer dados de payload de requisição definidos no atributo de span appsignal.request.payload. O AppSignal substitui os valores das chaves listadas na opção de configuração filter_request_payload por [FILTERED]. Saiba mais sobre filtragem de parâmetros de query de requisição.

config/appsignal.php

return [
    'filter_request_payload' => ['password', 'cvv'],
    // ... other options
];

filter_request_query_parameters

Campo	Valor
Chave do arquivo de configuração	`filter_request_query_parameters`
Chave de variável de ambiente do sistema	`APPSIGNAL_FILTER_REQUEST_QUERY_PARAMETERS`
Obrigatório	não
Tipo	`Array<String>`
Valor padrão	`[]`

Descrição

Esta opção de configuração permite que você filtre quaisquer parâmetros de query de requisição definidos no atributo de span appsignal.request.query_parameters. O AppSignal substitui os valores das chaves listadas na opção de configuração filter_request_query_parameters por [FILTERED]. Saiba mais sobre filtragem de parâmetros de query de requisição.

config/appsignal.php

return [
    'filter_request_query_parameters' => ['password', 'cvv'],
    // ... other options
];

filter_request_session_data

Campo	Valor
Chave do arquivo de configuração	`filter_request_session_data`
Chave de variável de ambiente do sistema	`APPSIGNAL_FILTER_REQUEST_SESSION_DATA`
Obrigatório	não
Tipo	`Array<String>`
Valor padrão	`[]`

Descrição

A opção de configuração filter_request_session_data permite que você filtre quaisquer dados de sessão de requisição definidos no atributo de span appsignal.request.session_data. O AppSignal substitui os valores das chaves listadas na opção de configuração filter_request_session_data por [FILTERED]. Saiba mais sobre filtragem de dados de sessão de requisição.

config/appsignal.php

return [
    'filter_request_session_data' => ['password', 'cvv'],
    // ... other options
];

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

Descrição

Ajuda o AppSignal a reconhecer diferentes hosts para traces e marcá-los automaticamente com o hostname. O pacote AppSignal define este valor automaticamente usando gethostname().

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	`[]`

Descrição

Com esta opção de configuração você pode especificar uma lista de ações que serão ignoradas pelo AppSignal. Tudo 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 deseja monitorar. Saiba mais sobre ignorar ações.

config/appsignal.php

return [
    'ignore_actions' => ['GET /health_check', 'POST /ping'],
    // ... other options
];

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	`[]`

Descrição

Esta opção de configuração permite que você ignore erros específicos para que não sejam reportados ao AppSignal. Isso pode ser útil para ignorar erros esperados ou erros que não podem ser resolvidos. Saiba mais sobre ignorar erros.

config/appsignal.php

return [
    'ignore_errors' => ['MyCustomError', 'ExpectedError'],
    // ... other options
];

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	`[]`

Descrição

Lista de mensagens de log que serão ignoradas. Qualquer mensagem de log que contenha qualquer um 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. O formato esperado é uma lista de valores separados por vírgulas.

config/appsignal.php

return [
	'ignore_logs' => ["^success", "OK"],
	// ... other options
];

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	`[]`

Descrição

Esta opção de configuração permite que você ignore namespaces específicos para que não sejam reportados ao AppSignal. Isso pode ser útil para ignorar partes específicas do seu aplicativo do monitoramento. Saiba mais sobre namespaces.

config/appsignal.php

return [
    'ignore_namespaces' => ['admin', 'secret'],
    // ... other options
];

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	`["accept", "accept-charset", "accept-encoding", "accept-language", "cache-control", "connection", "content-length", "host", "range"]`

Descrição

Configura quais cabeçalhos de requisição incluir quando uma requisição é feita a um servidor HTTP. Esta opção é uma allowlist. Ela só inclui os cabeçalhos que são configurados. Se a lista estiver vazia, nenhum cabeçalho é incluído. O AppSignal lê os cabeçalhos de requisição da requisição HTTP. Cada chave é um nome de cabeçalho normalizado (em letras minúsculas).

config/appsignal.php

return [
	'request_headers' => ['accept-encoding', 'content-length', 'user-agent'],
	// ... other options
];

Para configurar o AppSignal para não armazenar nenhum cabeçalho de requisição HTTP, defina explicitamente o valor da configuração como um array vazio.

config/appsignal.php

return [
    'request_headers' => [],
	// ... other options
];

response_headers

Campo	Valor
Chave do arquivo de configuração	`response_headers`
Chave de variável de ambiente do sistema	`APPSIGNAL_RESPONSE_HEADERS`
Obrigatório	não
Tipo	`Array<String>`
Valor padrão	`["accept", "accept-charset", "accept-encoding", "accept-language", "cache-control", "connection", "content-length", "date", "range"]`

Descrição

Configura quais cabeçalhos de resposta incluir quando uma requisição é feita por um cliente HTTP. Esta opção é uma allowlist. Ela só inclui os cabeçalhos que são configurados. Se o array estiver vazio, nenhum cabeçalho é incluído. Cada item neste array deve ser um nome de cabeçalho de resposta HTTP normalizado (em letras minúsculas).

config/appsignal.php

return [
    'response_headers' => ['accept', 'accept-charset', 'accept-encoding'],
	// ... other options
];

Para configurar o AppSignal para não armazenar nenhum cabeçalho de resposta HTTP, defina explicitamente o valor da configuração como um array vazio.

config/appsignal.php

return [
    'response_headers' => [],
	// ... other options
];

revision

Campo	Valor
Chave do arquivo de configuração	`revision`
Chave de variável de ambiente do sistema	`APPSIGNAL_REVISION`
Obrigatório	não
Tipo	`String`
Valor padrão	detectado a partir do git

Descrição

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. O pacote AppSignal define este valor automaticamente usando git rev-parse HEAD. Saiba mais sobre marcadores de deploy no tópico de marcadores de deploy.

send_function_parameters

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

Descrição

Configura se deve incluir parâmetros de função em traces. Se definido como false, nenhum desses dados é enviado para nossos servidores. Esses valores são definidos com o atributo de span appsignal.function.parameters.

config/appsignal.php

return [
    'send_function_parameters' => false,
    // ... other options
];

send_request_payload

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

Descrição

Configura se deve enviar dados de payload de requisição em traces. Se definido como false, nenhum desses dados é enviado para nossos servidores. Esses valores são definidos com o atributo de span appsignal.request.payload. Para mais informações, leia sobre filtragem de payload de requisição.

config/appsignal.php

return [
    'send_request_payload' => false,
    // ... other options
];

send_request_query_parameters

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

Descrição

Configura se deve incluir parâmetros de query de requisição em traces. Se definido como false, nenhum desses dados é enviado para nossos servidores. Esses valores são definidos com o atributo de span appsignal.request.query_parameters. Para mais informações, leia sobre filtragem de parâmetros de requisição.

config/appsignal.php

return [
    'send_request_query_parameters' => false,
    // ... other options
];

send_request_session_data

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

Descrição

Configura se deve enviar dados de sessão de requisição em traces. Se definido como false, nenhum desses dados é enviado para nossos servidores. Esses valores são definidos com o atributo de span appsignal.request.session_data. Para mais informações, leia sobre filtragem de dados de sessão de requisição.

config/appsignal.php

return [
    'send_request_session_data' => false,
    // ... other options
];

service_name

Campo	Valor
Chave do arquivo de configuração	`service_name`
Chave de variável de ambiente do sistema	`APPSIGNAL_SERVICE_NAME`
Obrigatório	não
Tipo	`String`
Valor padrão	`null` (não definido por padrão)

Descrição

O nome do serviço ajuda o AppSignal a reconhecer diferentes serviços e agrupa automaticamente seus traces em um namespace correspondente. Escolha um nome que se adeque ao seu aplicativo, como “Web server”, “Background worker”, “Email service”, “Authentication service”, etc.

config/appsignal.php

return [
    'service_name' => 'My service name',
    // ... other options
];

​Opções disponíveis

​collector_endpoint

​Descrição

​environment

​Descrição

​name

​Descrição

​push_api_key

​Descrição

​active

​Descrição

​app_path

​Descrição

​filter_attributes

​Descrição

​filter_function_parameters

​Descrição

​filter_request_payload

​Descrição

​filter_request_query_parameters

​Descrição

​filter_request_session_data

​Descrição

​hostname

​Descrição

​ignore_actions

​Descrição

​ignore_errors

​Descrição

​ignore_logs

​Descrição

​ignore_namespaces

​Descrição

​request_headers

​Descrição

​response_headers

​Descrição

​revision

​Descrição

​send_function_parameters

​Descrição

​send_request_payload

​Descrição

​send_request_query_parameters

​Descrição

​send_request_session_data

​Descrição

​service_name

​Descrição

Opções disponíveis

collector_endpoint

Descrição

environment

Descrição

name

Descrição

push_api_key

Descrição

active

Descrição

app_path

Descrição

filter_attributes

Descrição

filter_function_parameters

Descrição

filter_request_payload

Descrição

filter_request_query_parameters

Descrição

filter_request_session_data

Descrição

hostname

Descrição

ignore_actions

Descrição

ignore_errors

Descrição

ignore_logs

Descrição

ignore_namespaces

Descrição

request_headers

Descrição

response_headers

Descrição

revision

Descrição

send_function_parameters

Descrição

send_request_payload

Descrição

send_request_query_parameters

Descrição

send_request_session_data

Descrição

service_name

Descrição