Options de configuration d'AppSignal pour PHP

AppSignal pour PHP peut être configuré via le fichier config/appsignal.php ou en utilisant des variables d’environnement. Cette page liste toutes les options de configuration disponibles. En savoir plus sur l’ordre de chargement de la configuration. Une fois AppSignal configuré, vous pouvez valider la configuration actuelle :

Shell

vendor/bin/appsignal validate

collector_endpoint

Champ	Valeur
Clé du fichier de configuration	`collector_endpoint`
Clé de variable d’environnement système	`APPSIGNAL_COLLECTOR_ENDPOINT`
Requis	oui
Type	`String`
Valeur par défaut	`null` (non défini par défaut)

Description

L’URL du collecteur AppSignal vers lequel envoyer les données de traces, de métriques et de logs. AppSignal affiche cette URL lorsque vous créez une nouvelle application, et elle est également disponible pour les applications existantes.

config/appsignal.php

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

environment

Champ	Valeur
Clé du fichier de configuration	`environment`
Clé de variable d’environnement système	`APPSIGNAL_APP_ENV`
Requis	oui
Type	`String`
Valeur par défaut	`null` (non défini par défaut)

Description

L’environnement de l’application à signaler à AppSignal.

config/appsignal.php

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

Note : Modifier le nom ou l’environnement d’une application existante créera une nouvelle application sur AppSignal.com.

name

Champ	Valeur
Clé du fichier de configuration	`name`
Clé de variable d’environnement système	`APPSIGNAL_APP_NAME`
Requis	oui
Type	`String`
Valeur par défaut	`null` (non défini par défaut)

Description

Le nom d’affichage de votre application sur AppSignal.com.

config/appsignal.php

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

Note : Modifier le nom ou l’environnement d’une application existante créera une nouvelle application sur AppSignal.com.

push_api_key

Champ	Valeur
Clé du fichier de configuration	`push_api_key`
Clé de variable d’environnement système	`APPSIGNAL_PUSH_API_KEY`
Requis	oui
Type	`String`
Valeur par défaut	`null` (non défini par défaut)

Description

La clé de niveau organisation utilisée pour s’authentifier auprès de la Push API. En savoir plus sur la clé Push API AppSignal.

config/appsignal.php

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

active

Champ	Valeur
Clé du fichier de configuration	`active`
Clé de variable d’environnement système	`APPSIGNAL_ACTIVE`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`false`

Description

Configurez si AppSignal est actif pour un environnement donné. Le plus souvent utilisé dans la configuration par fichier par environnement.

app_path

Champ	Valeur
Clé du fichier de configuration	`app_path`
Requis	non
Type	`String`
Valeur par défaut	détectée à partir de la racine du projet

Description

L’emplacement de l’application sur le système de fichiers de l’hôte. Aide AppSignal à nettoyer les backtraces en supprimant le chemin absolu de l’application des lignes de backtrace, en ne montrant que les chemins à l’intérieur du répertoire du projet. Cela rend possible notre fonctionnalité de liens de backtrace. Le package AppSignal définit automatiquement cette valeur en fonction de la racine du projet détectée. Si la détection automatique du chemin d’application ne fonctionne pas, vous pouvez la remplacer :

config/appsignal.php

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

filter_attributes

Champ	Valeur
Clé du fichier de configuration	`filter_attributes`
Clé de variable d’environnement système	`APPSIGNAL_FILTER_ATTRIBUTES`
Requis	non
Type	`Array<String>`
Valeur par défaut	`[]`

Description

L’option de configuration filter_attributes vous permet de filtrer certains attributs spécifiques pour qu’ils ne soient pas signalés à AppSignal. Cela peut être utile pour éviter que des informations sensibles ou non pertinentes ne soient signalées. Si un attribut est filtré de cette manière, il n’apparaîtra pas du tout dans l’interface.

config/appsignal.php

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

filter_function_parameters

Champ	Valeur
Clé du fichier de configuration	`filter_function_parameters`
Clé de variable d’environnement système	`APPSIGNAL_FILTER_FUNCTION_PARAMETERS`
Requis	non
Type	`Array<String>`
Valeur par défaut	`[]`

Description

Cette option de configuration vous permet de filtrer les paramètres de fonction définis dans l’attribut de span appsignal.function.parameters. AppSignal remplace les valeurs des clés répertoriées dans l’option de configuration filter_function_parameters par [FILTERED].

config/appsignal.php

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

filter_request_payload

Champ	Valeur
Clé du fichier de configuration	`filter_request_payload`
Clé de variable d’environnement système	`APPSIGNAL_FILTER_REQUEST_PAYLOAD`
Requis	non
Type	`Array<String>`
Valeur par défaut	`[]`

Description

Cette option de configuration vous permet de filtrer les données de charge utile (payload) des requêtes définies dans l’attribut de span appsignal.request.payload. AppSignal remplace les valeurs des clés répertoriées dans l’option de configuration filter_request_payload par [FILTERED]. En savoir plus sur le filtrage des paramètres de requête.

config/appsignal.php

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

filter_request_query_parameters

Champ	Valeur
Clé du fichier de configuration	`filter_request_query_parameters`
Clé de variable d’environnement système	`APPSIGNAL_FILTER_REQUEST_QUERY_PARAMETERS`
Requis	non
Type	`Array<String>`
Valeur par défaut	`[]`

Description

Cette option de configuration vous permet de filtrer les paramètres de requête (query parameters) définis dans l’attribut de span appsignal.request.query_parameters. AppSignal remplace les valeurs des clés répertoriées dans l’option de configuration filter_request_query_parameters par [FILTERED]. En savoir plus sur le filtrage des paramètres de requête.

config/appsignal.php

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

filter_request_session_data

Champ	Valeur
Clé du fichier de configuration	`filter_request_session_data`
Clé de variable d’environnement système	`APPSIGNAL_FILTER_REQUEST_SESSION_DATA`
Requis	non
Type	`Array<String>`
Valeur par défaut	`[]`

Description

L’option de configuration filter_request_session_data vous permet de filtrer les données de session des requêtes définies dans l’attribut de span appsignal.request.session_data. AppSignal remplace les valeurs des clés répertoriées dans l’option de configuration filter_request_session_data par [FILTERED]. En savoir plus sur le filtrage des données de session des requêtes.

config/appsignal.php

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

hostname

Champ	Valeur
Clé du fichier de configuration	`hostname`
Clé de variable d’environnement système	`APPSIGNAL_HOSTNAME`
Requis	non
Type	`String`
Valeur par défaut	détectée depuis le système

Description

Aide AppSignal à reconnaître différents hôtes pour les traces et à les étiqueter automatiquement avec le nom d’hôte. Le package AppSignal définit automatiquement cette valeur en utilisant gethostname().

ignore_actions

Champ	Valeur
Clé du fichier de configuration	`ignore_actions`
Clé de variable d’environnement système	`APPSIGNAL_IGNORE_ACTIONS`
Requis	non
Type	`Array<String>`
Valeur par défaut	`[]`

Description

Avec cette option de configuration, vous pouvez spécifier une liste d’actions qui seront ignorées par AppSignal. Tout ce qui se passe, y compris les exceptions, ne sera pas transmis à AppSignal. Cela peut être utile pour ignorer les points d’accès de contrôle de santé (health check) ou d’autres actions que vous ne souhaitez pas surveiller. En savoir plus sur l’ignorance des actions.

config/appsignal.php

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

ignore_errors

Champ	Valeur
Clé du fichier de configuration	`ignore_errors`
Clé de variable d’environnement système	`APPSIGNAL_IGNORE_ERRORS`
Requis	non
Type	`Array<String>`
Valeur par défaut	`[]`

Description

Cette option de configuration vous permet d’ignorer des erreurs spécifiques pour qu’elles ne soient pas signalées à AppSignal. Cela peut être utile pour ignorer les erreurs attendues ou les erreurs qui ne peuvent pas être résolues. En savoir plus sur l’ignorance des erreurs.

config/appsignal.php

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

ignore_logs

Champ	Valeur
Clé du fichier de configuration	`ignore_logs`
Clé de variable d’environnement système	`APPSIGNAL_IGNORE_LOGS`
Requis	non
Type	`Array<String>`
Valeur par défaut	`[]`

Description

Liste de messages de log qui seront ignorés. Tout message de log contenant l’un des éléments de la liste ne sera pas transmis à AppSignal. Un petit sous-ensemble de syntaxe regex est pris en charge, en savoir plus dans notre guide Ignorer les logs. Le format attendu est une liste de valeurs séparées par des virgules.

config/appsignal.php

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

ignore_namespaces

Champ	Valeur
Clé du fichier de configuration	`ignore_namespaces`
Clé de variable d’environnement système	`APPSIGNAL_IGNORE_NAMESPACES`
Requis	non
Type	`Array<String>`
Valeur par défaut	`[]`

Description

Cette option de configuration vous permet d’ignorer des espaces de noms spécifiques pour qu’ils ne soient pas signalés à AppSignal. Cela peut être utile pour ignorer certaines parties de votre application afin qu’elles ne soient pas surveillées. En savoir plus sur les espaces de noms.

config/appsignal.php

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

request_headers

Champ	Valeur
Clé du fichier de configuration	`request_headers`
Clé de variable d’environnement système	`APPSIGNAL_REQUEST_HEADERS`
Requis	non
Type	`Array<String>`
Valeur par défaut	`["accept", "accept-charset", "accept-encoding", "accept-language", "cache-control", "connection", "content-length", "host", "range"]`

Description

Configurez quels en-têtes de requête inclure lorsqu’une requête est effectuée vers un serveur HTTP. Cette option est une liste d’autorisation. Elle n’inclut que les en-têtes configurés. Si la liste est vide, aucun en-tête n’est inclus. AppSignal lit les en-têtes de requête à partir de la requête HTTP. Chaque clé est un nom d’en-tête normalisé (en minuscules).

config/appsignal.php

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

Pour configurer AppSignal afin qu’il ne stocke aucun en-tête de requête HTTP, définissez explicitement la valeur de configuration sur un tableau vide.

config/appsignal.php

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

response_headers

Champ	Valeur
Clé du fichier de configuration	`response_headers`
Clé de variable d’environnement système	`APPSIGNAL_RESPONSE_HEADERS`
Requis	non
Type	`Array<String>`
Valeur par défaut	`["accept", "accept-charset", "accept-encoding", "accept-language", "cache-control", "connection", "content-length", "date", "range"]`

Description

Configurez quels en-têtes de réponse inclure lorsqu’une requête est effectuée par un client HTTP. Cette option est une liste d’autorisation. Elle n’inclut que les en-têtes configurés. Si le tableau est vide, aucun en-tête n’est inclus. Chaque élément de ce tableau doit être un nom d’en-tête de réponse HTTP normalisé (en minuscules).

config/appsignal.php

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

Pour configurer AppSignal afin qu’il ne stocke aucun en-tête de réponse HTTP, définissez explicitement la valeur de configuration sur un tableau vide.

config/appsignal.php

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

revision

Champ	Valeur
Clé du fichier de configuration	`revision`
Clé de variable d’environnement système	`APPSIGNAL_REVISION`
Requis	non
Type	`String`
Valeur par défaut	détectée depuis git

Description

La version actuellement en cours d’exécution de votre application. AppSignal créera un marqueur de déploiement lorsque cette valeur change et étiquettera toutes les données entrantes avec la révision actuelle. Le package AppSignal définit automatiquement cette valeur en utilisant git rev-parse HEAD. En savoir plus sur les marqueurs de déploiement dans la rubrique des marqueurs de déploiement.

send_function_parameters

Champ	Valeur
Clé du fichier de configuration	`send_function_parameters`
Clé de variable d’environnement système	`APPSIGNAL_SEND_FUNCTION_PARAMETERS`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`

Description

Configurez s’il faut inclure les paramètres de fonction dans les traces. S’il est défini sur false, aucune de ces données n’est envoyée à nos serveurs. Ces valeurs sont définies avec l’attribut de span appsignal.function.parameters.

config/appsignal.php

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

send_request_payload

Champ	Valeur
Clé du fichier de configuration	`send_request_payload`
Clé de variable d’environnement système	`APPSIGNAL_SEND_REQUEST_PAYLOAD`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`

Description

Configurez s’il faut envoyer les données de charge utile (payload) des requêtes dans les traces. S’il est défini sur false, aucune de ces données n’est envoyée à nos serveurs. Ces valeurs sont définies avec l’attribut de span appsignal.request.payload. Pour plus d’informations, veuillez consulter le filtrage de la charge utile des requêtes.

config/appsignal.php

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

send_request_query_parameters

Champ	Valeur
Clé du fichier de configuration	`send_request_query_parameters`
Clé de variable d’environnement système	`APPSIGNAL_SEND_REQUEST_QUERY_PARAMETERS`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`

Description

Configurez s’il faut inclure les paramètres de requête (query parameters) dans les traces. S’il est défini sur false, aucune de ces données n’est envoyée à nos serveurs. Ces valeurs sont définies avec l’attribut de span appsignal.request.query_parameters. Pour plus d’informations, veuillez consulter le filtrage des paramètres de requête.

config/appsignal.php

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

send_request_session_data

Champ	Valeur
Clé du fichier de configuration	`send_request_session_data`
Clé de variable d’environnement système	`APPSIGNAL_SEND_REQUEST_SESSION_DATA`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`

Description

Configurez s’il faut envoyer les données de session des requêtes dans les traces. S’il est défini sur false, aucune de ces données n’est envoyée à nos serveurs. Ces valeurs sont définies avec l’attribut de span appsignal.request.session_data. Pour plus d’informations, veuillez consulter le filtrage des données de session des requêtes.

config/appsignal.php

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

service_name

Champ	Valeur
Clé du fichier de configuration	`service_name`
Clé de variable d’environnement système	`APPSIGNAL_SERVICE_NAME`
Requis	non
Type	`String`
Valeur par défaut	`null` (non défini par défaut)

Description

Le nom de service aide AppSignal à reconnaître différents services et regroupe automatiquement leurs traces dans un espace de noms correspondant. Choisissez un nom qui convient à votre application, comme “Web server”, “Background worker”, “Email service”, “Authentication service”, etc.

config/appsignal.php

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

​Options disponibles

​collector_endpoint

​Description

​environment

​Description

​name

​Description

​push_api_key

​Description

​active

​Description

​app_path

​Description

​filter_attributes

​Description

​filter_function_parameters

​Description

​filter_request_payload

​Description

​filter_request_query_parameters

​Description

​filter_request_session_data

​Description

​hostname

​Description

​ignore_actions

​Description

​ignore_errors

​Description

​ignore_logs

​Description

​ignore_namespaces

​Description

​request_headers

​Description

​response_headers

​Description

​revision

​Description

​send_function_parameters

​Description

​send_request_payload

​Description

​send_request_query_parameters

​Description

​send_request_session_data

​Description

​service_name

​Description

Options disponibles

collector_endpoint

Description

environment

Description

name

Description

push_api_key

Description

active

Description

app_path

Description

filter_attributes

Description

filter_function_parameters

Description

filter_request_payload

Description

filter_request_query_parameters

Description

filter_request_session_data

Description

hostname

Description

ignore_actions

Description

ignore_errors

Description

ignore_logs

Description

ignore_namespaces

Description

request_headers

Description

response_headers

Description

revision

Description

send_function_parameters

Description

send_request_payload

Description

send_request_query_parameters

Description

send_request_session_data

Description

service_name

Description