Options de configuration du package Python

La liste suivante contient toutes les options de configuration avec le nom de la variable d’environnement et le nom de la clé dans le fichier de configuration. Pour plus d’informations sur la façon de configurer AppSignal avec un fichier de configuration ou des variables d’environnement système, consultez notre documentation sur la Configuration.

active

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

Description

Configurez si AppSignal est actif ou non pour un environnement donné. Si AppSignal n’est pas actif, aucune donnée n’est signalée pour l’application dans l’environnement spécifié.

environment

Champ	Valeur
Clé du fichier de configuration	`environment`
Clé de variable d’environnement système	`APPSIGNAL_APP_ENV`
Obligatoire	oui
Type	`String`
Valeur par défaut	`development`
Disponible depuis la version	`0.1.0`

Description

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

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`
Obligatoire	oui
Type	`String`
Valeur par défaut	nil (Non défini par défaut)
Disponible depuis la version	`0.1.0`

Description

Nom de votre application tel qu’il doit être affiché sur AppSignal.com.

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`
Obligatoire	oui
Type	`String`
Valeur par défaut	nil (Non défini par défaut)
Disponible depuis la version	`0.1.0`

Description

La clé d’authentification au niveau de l’organisation pour s’authentifier auprès de notre API Push. En savoir plus sur la clé d’API Push d’AppSignal.

bind_address

Champ	Valeur
Clé du fichier de configuration	`bind_address`
Clé de variable d’environnement système	`APPSIGNAL_BIND_ADDRESS`
Requis	non
Type	`String`
Valeur par défaut	`127.0.0.1`
Disponible depuis la version	`0.1.5`

Description

Une adresse IPv4 valide que l’agent AppSignal utilise comme liaison pour ses serveurs TCP et UDP. Utilisez une adresse spécifique si vous souhaitez que l’agent n’écoute que les requêtes effectuées sur cette adresse. Définissez cette option sur 0.0.0.0 pour autoriser la réception de requêtes depuis des hôtes utilisant n’importe quelle adresse IP. Par défaut, il n’écoute que les requêtes effectuées sur le même hôte. Cette option s’applique à tous les serveurs de l’agent (StatsD, OpenTelemetry et NGINX).

Agent uniquement : lors de l’utilisation d’un collecteur externe, cette option de configuration n’a aucun effet.

ca_file_path

Champ	Valeur
Clé du fichier de configuration	`ca_file_path`
Clé de variable d’environnement système	`APPSIGNAL_CA_FILE_PATH`
Requis	non
Type	`String`
Valeur par défaut	Chemin du fichier `cacert.pem` empaqueté.
Disponible depuis la version	`0.1.0`

Description

Utilisez cette option pour pointer vers un autre fichier de certificat s’il y a un problème de connexion à notre API.

Note : Le chemin spécifié ne peut pas contenir d’abstractions du système de fichiers spécifiques au système d’exploitation, telles que le symbole de répertoire personnel ~ pour les systèmes *NIX. Cela sera considéré comme un chemin mal formé.

Lorsque vous utilisez un collecteur externe, cette option de configuration n’a aucun effet sur la manière dont l’intégration communique avec le collecteur externe. Elle sera toujours utilisée lors de la communication avec les serveurs d’AppSignal.

collector_endpoint

Champ	Valeur
Clé du fichier de configuration	`collector_endpoint`
Clé de variable d’environnement système	`APPSIGNAL_COLLECTOR_ENDPOINT`
Requis	non
Type	`String`
Valeur par défaut	nil (Non défini par défaut)
Disponible depuis la version	`1.6.0`

Description

L’adresse d’un collecteur AppSignal déployé en externe. Lorsque cette option est définie, l’agent AppSignal fourni avec l’intégration ne sera pas utilisé, et les données OpenTelemetry seront envoyées au collecteur à cette adresse à la place.

Il s’agit d’une option de configuration expérimentale. Les fonctionnalités suivantes ne seront pas disponibles lors de l’utilisation d’un collecteur externe :

Les fonctionnalités suivantes sont uniquement disponibles lors de l’utilisation d’un collecteur externe :

Journalisation

cpu_count

Champ	Valeur
Clé du fichier de configuration	`cpu_count`
Clé de variable d’environnement système	`APPSIGNAL_CPU_COUNT`
Obligatoire	non
Type	`Float`
Valeur par défaut	`undefined`
Disponible depuis la version	`1.2.0`

Description

La capacité CPU disponible de l’hôte, en nombre de CPU. Cela est utilisé pour calculer le pourcentage d’utilisation du CPU dans les métriques de l’hôte. Si elle n’est pas définie, l’agent essaiera de la détecter automatiquement à partir des cgroups. Le nombre de CPU peut être une fraction, par exemple 0.5.

Agent uniquement : lors de l’utilisation d’un collecteur externe, cette option de configuration n’a aucun effet.

disable_default_instrumentations

Champ	Valeur
Clé du fichier de configuration	`disable_default_instrumentations`
Clé de variable d’environnement système	`APPSIGNAL_DISABLE_DEFAULT_INSTRUMENTATIONS`
Obligatoire	non
Type	`list(String)` ou Booléen (`true` / `false`)
Valeur par défaut	`false`
Disponible depuis la version	`0.1.0`

Description

Vous permet de désactiver l’instrumentation automatique des intégrations par défaut :

aiopg
asyncpg
celery
django
flask
mysql
mysqlclient
psycopg
psycopg2
pymysql
redis
jinja2
requests
sqlalchemy
sqlite3
logging

Lorsque vous utilisez AppSignal pour Python 1.5.4 ou antérieur, préfixez chacun de ces noms avec opentelemetry.instrumentation.. Par exemple, jinja2 serait spécifié comme opentelemetry.instrumentation.jinja2.

Notez que les instrumentations ne sont activées que si la bibliothèque d’instrumentation OpenTelemetry correspondante est installée. Pour désactiver toutes les instrumentations automatiques, définissez la valeur sur True.

dns_servers

Champ	Valeur
Clé du fichier de configuration	`dns_servers`
Clé de variable d’environnement système	`APPSIGNAL_DNS_SERVERS`
Obligatoire	non
Type	`list(String)`
Valeur par défaut	`[]`
Disponible depuis la version	`0.1.0`

Description

Configurez les serveurs DNS que l’agent AppSignal doit utiliser.

Shell

# Dans l'environnement de l'hôte
export APPSIGNAL_DNS_SERVERS="8.8.8.8,8.8.4.4"

Si vous êtes affecté par nos délais d’attente DNS, essayez de définir manuellement un serveur DNS avec cette option qui n’utilise pas plus de 4 points dans le nom du serveur.

Valeurs acceptables : 8.8.8.8, my.custom.local.server.
Valeurs non acceptables : foo, my.awesome.custom.local.dns.server.

Si le serveur DNS ne peut pas être atteint, l’agent se rabattra sur la configuration DNS de l’hôte et affichera un message dans le fichier appsignal.log : A problem occurred while setting DNS servers.

Agent uniquement : lors de l’utilisation d’un collecteur externe, cette option de configuration n’a aucun effet.

enable_host_metrics

Champ	Valeur
Clé du fichier de configuration	`enable_host_metrics`
Clé de variable d’environnement système	`APPSIGNAL_ENABLE_HOST_METRICS`
Obligatoire	non
Type	Booléen (`true` / `false`)
Valeur par défaut	“true `/ détecté par le système`
Disponible depuis la version	`0.1.0`

Description

Définissez cette option sur false pour désactiver la collecte des métriques de l’hôte. Sur Heroku et Dokku, les métriques de l’hôte sont désactivées par défaut. Cela est fait parce que ces systèmes signaleront des métriques inexactes depuis l’intérieur des conteneurs. La collecte des métriques de l’hôte sur ces systèmes ne peut pas être activée. Pour Heroku, utilisez plutôt le drain de logs Heroku.

Agent uniquement : lors de l’utilisation d’un collecteur externe, cette option de configuration n’a aucun effet.

enable_minutely_probes

Champ	Valeur
Clé du fichier de configuration	`enable_minutely_probes`
Clé de variable d’environnement système	`APPSIGNAL_ENABLE_MINUTELY_PROBES`
Obligatoire	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`1.2.0`

Description

Active le système des sondes à la minute.

enable_nginx_metrics

Champ	Valeur
Clé du fichier de configuration	`enable_nginx_metrics`
Clé de variable d’environnement système	`APPSIGNAL_ENABLE_NGINX_METRICS`
Obligatoire	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`false`
Disponible depuis la version	`0.1.0`

Description

Définissez sur true pour activer le serveur de métriques NGINX. Consultez la documentation des métriques NGINX pour plus de détails. Lorsqu’il est activé, l’agent AppSignal écoutera un serveur lié à localhost sur le port 27649. Si vous exécutez plusieurs applications instrumentées par AppSignal sur le même serveur, cette option de configuration ne peut être activée que dans l’une d’entre elles.

Agent uniquement : lors de l’utilisation d’un collecteur externe, cette option de configuration n’a aucun effet.

enable_statsd

Champ	Valeur
Clé du fichier de configuration	`enable_statsd`
Clé de variable d’environnement système	`APPSIGNAL_ENABLE_STATSD`
Obligatoire	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`false`
Disponible depuis la version	`0.1.0`

Description

Active le serveur StatsD dans l’agent AppSignal. Lorsqu’il est activé, l’agent AppSignal écoutera un serveur lié à localhost sur le port 8125. Si vous exécutez plusieurs applications instrumentées par AppSignal sur le même serveur, cette option de configuration ne peut être activée que dans l’une d’entre elles.

Agent uniquement : lors de l’utilisation d’un collecteur externe, cette option de configuration n’a aucun effet.

endpoint

Champ	Valeur
Clé du fichier de configuration	`endpoint`
Clé de variable d’environnement système	`APPSIGNAL_PUSH_API_ENDPOINT`
Obligatoire	non
Type	`String`
Valeur par défaut	`https://push.appsignal.com`
Disponible depuis la version	`0.1.0`

Description

Configurez le point de terminaison vers lequel envoyer les données à AppSignal. Ce paramètre ne devrait pas avoir besoin d’être modifié.

Agent uniquement : lors de l’utilisation d’un collecteur externe, cette option de configuration n’a aucun effet.

files_world_accessible

Champ	Valeur
Clé du fichier de configuration	`files_world_accessible`
Clé de variable d’environnement système	`APPSIGNAL_FILES_WORLD_ACCESSIBLE`
Obligatoire	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`0.1.0`

Description

Si cela est défini sur true, le répertoire de travail d’AppSignal qui est créé est accessible à tous les utilisateurs (permissions Unix 0666). Cela est souvent nécessaire car les processus de la même application s’exécutent sous différents utilisateurs. Définissez sur false pour désactiver ce comportement (permissions Unix 0644).

Agent uniquement : lors de l’utilisation d’un collecteur externe, cette option de configuration n’a aucun effet.

filter_attributes

Champ	Valeur
Clé du fichier de configuration	`filter_attributes`
Clé de variable d’environnement système	`APPSIGNAL_FILTER_ATTRIBUTES`
Obligatoire	non
Type	`list(String)`
Valeur par défaut	`[]`
Disponible depuis la version	`1.6.0`

Description

Liste des attributs de span OpenTelemetry à filtrer avec AppSignal. Les valeurs correspondantes sont remplacées par [FILTERED]. En savoir plus sur le filtrage des paramètres.

Collecteur uniquement : cette option de configuration n’aura d’effet que lors de l’utilisation d’un collecteur externe.Consultez l’option de configuration filter_parameters pour filtrer les données lors de l’utilisation de l’agent.

filter_function_parameters

Champ	Valeur
Clé du fichier de configuration	`filter_function_parameters`
Clé de variable d’environnement système	`APPSIGNAL_FILTER_FUNCTION_PARAMETERS`
Obligatoire	non
Type	`list(String)`
Valeur par défaut	`[]`
Disponible depuis la version	`1.6.0`

Description

Liste des attributs de paramètres de fonction à filtrer avec AppSignal. Les valeurs correspondantes sont remplacées par [FILTERED]. En savoir plus sur le filtrage des paramètres.

filter_parameters

Champ	Valeur
Clé du fichier de configuration	`filter_parameters`
Clé de variable d’environnement système	`APPSIGNAL_FILTER_PARAMETERS`
Obligatoire	non
Type	`list(String)`
Valeur par défaut	`[]`
Disponible depuis la version	`0.1.0`

Description

Liste des clés de paramètres qui doivent être ignorées en utilisant le filtrage d’AppSignal. Leurs valeurs seront remplacées par [FILTERED] lorsqu’elles seront transmises à AppSignal. En savoir plus sur le filtrage des paramètres.

Agent uniquement : lors de l’utilisation d’un collecteur externe, cette option de configuration n’a aucun effet.Consultez les options de configuration suivantes pour filtrer les paramètres lors de l’utilisation d’un collecteur externe :

filter_attributes
filter_function_parameters
filter_request_payload
filter_request_query_parameters

filter_request_payload

Champ	Valeur
Clé du fichier de configuration	`filter_request_payload`
Clé de variable d’environnement système	`APPSIGNAL_FILTER_REQUEST_PAYLOAD`
Obligatoire	non
Type	`list(String)`
Valeur par défaut	`[]`
Disponible depuis la version	`1.6.0`

Description

Liste des attributs de charge utile de requête à filtrer avec AppSignal. Les valeurs correspondantes sont remplacées par [FILTERED]. En savoir plus sur le filtrage des paramètres.

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`
Obligatoire	non
Type	`list(String)`
Valeur par défaut	`[]`
Disponible depuis la version	`1.6.0`

Description

Liste des attributs de paramètres de requête à filtrer avec AppSignal. Les valeurs correspondantes sont remplacées par [FILTERED]. En savoir plus sur le filtrage des paramètres.

filter_session_data

Champ	Valeur
Clé du fichier de configuration	`filter_session_data`
Clé de variable d’environnement système	`APPSIGNAL_FILTER_SESSION_DATA`
Obligatoire	non
Type	`list(String)`
Valeur par défaut	`[]`
Disponible depuis la version	`0.1.0`

Description

Liste des clés de données de session qui doivent être ignorées en utilisant le filtrage d’AppSignal. Leurs valeurs seront remplacées par [FILTERED] lorsqu’elles seront transmises à AppSignal. En savoir plus sur le filtrage des données de session.

host_role

Champ	Valeur
Clé du fichier de configuration	`host_role`
Clé de variable d’environnement système	`APPSIGNAL_HOST_ROLE`
Obligatoire	non
Type	`String`
Valeur par défaut	nil (Non défini par défaut)
Disponible depuis la version	`0.2.2`

Description

Regroupez les hôtes par rôle et générez des métriques basées sur ce rôle. L’une de ces métriques est la métrique de compteur reporting_hosts. Un bon rôle indique quelle est la fonction principale du serveur, comme “webserver”, “processor”, “api”, “database”, “loadbalancer”, etc.

Agent uniquement : lors de l’utilisation d’un collecteur externe, cette option de configuration n’a aucun effet.

hostname

Champ	Valeur
Clé du fichier de configuration	`hostname`
Clé de variable d’environnement système	`APPSIGNAL_HOSTNAME`
Obligatoire	non
Type	`String`
Valeur par défaut	détecté depuis le système
Disponible depuis la version	`0.1.0`

Description

Cela remplace le nom d’hôte du serveur. Utile lorsque vous ne pouvez pas définir un nom d’hôte personnalisé ou lorsqu’un identifiant indescriptible est généré pour vous sur les services d’hébergement.

http_proxy

Champ	Valeur
Clé du fichier de configuration	`http_proxy`
Clé de variable d’environnement système	`APPSIGNAL_HTTP_PROXY`
Obligatoire	non
Type	`String`
Valeur par défaut	nil (Non défini par défaut)
Disponible depuis la version	`0.1.0`

Description

Si vous avez besoin que l’agent se connecte à Internet via un proxy, définissez l’URL complète du proxy dans cette clé de configuration.

ignore_actions

Champ	Valeur
Clé du fichier de configuration	`ignore_actions`
Clé de variable d’environnement système	`APPSIGNAL_IGNORE_ACTIONS`
Obligatoire	non
Type	`list(String)`
Valeur par défaut	`[]`
Disponible depuis la version	`0.1.0`

Description

Avec cette option de configuration, vous pouvez spécifier une liste d’actions qui seront ignorées par AppSignal. Tout ce qui se produit, y compris les exceptions, ne sera pas transmis à AppSignal. Cela peut être utile pour ignorer les points de terminaison de vérification d’état ou d’autres actions que vous ne souhaitez pas surveiller. En savoir plus sur l’ignorance des actions.

ignore_errors

Champ	Valeur
Clé du fichier de configuration	`ignore_errors`
Clé de variable d’environnement système	`APPSIGNAL_IGNORE_ERRORS`
Obligatoire	non
Type	`list(String)`
Valeur par défaut	`[]`
Disponible depuis la version	`0.1.0`

Description

Liste des classes d’erreurs qui seront ignorées. Toute exception levée avec cette classe d’erreur ne sera pas transmise à AppSignal. En savoir plus sur l’ignorance des erreurs.

ignore_namespaces

Champ	Valeur
Clé du fichier de configuration	`ignore_namespaces`
Clé de variable d’environnement système	`APPSIGNAL_IGNORE_NAMESPACES`
Obligatoire	non
Type	`list(String)`
Valeur par défaut	`[]`
Disponible depuis la version	`0.1.0`

Description

Liste des namespaces qui seront ignorés. Toute erreur levée ou requête lente qui se produit dans ce namespace ne sera pas envoyée à AppSignal. En savoir plus sur les namespaces.

log

Champ	Valeur
Clé du fichier de configuration	`log`
Clé de variable d’environnement système	`APPSIGNAL_LOG`
Obligatoire	non
Type	`String`
Valeur par défaut	`file`
Disponible depuis la version	`0.1.0`

Description

Cette option configure le logger qu’utilisera la fonctionnalité de journalisation interne d’AppSignal et n’affecte pas la fonctionnalité de journalisation.Note : L’agent AppSignal, qui est utilisé par l’intégration, écrira toujours dans le fichier “appsignal.log”.

Sélectionnez le logger que l’intégration AppSignal utilisera. Les valeurs acceptées sont file et stdout. Voir aussi la configuration log_path.

file (par défaut)
- Écrire tous les logs AppSignal dans le système de fichiers.
stdout (par défaut sur Heroku)
- Afficher les logs AppSignal dans le STDOUT du processus parent au lieu d’un fichier. Utile avec les solutions d’hébergement telles que les systèmes de conteneurs et Heroku.

Lorsque vous utilisez un collecteur externe, cette option de configuration n’a aucun effet sur la manière dont le collecteur émettra les journaux. L’intégration continuera à suivre cette option de configuration lors de l’émission des journaux.

log_level

Champ	Valeur
Clé du fichier de configuration	`log_level`
Clé de variable d’environnement système	`APPSIGNAL_LOG_LEVEL`
Obligatoire	non
Type	`String`
Valeur par défaut	`info`
Disponible depuis la version	`0.1.0`

Description

Cette option définit le niveau de gravité du logger interne d’AppSignal et n’affecte pas la fonctionnalité de journalisation.

Définissez le niveau de gravité du logger interne d’AppSignal. S’il est configuré sur “info”, il enregistrera tous les messages d’erreur, d’avertissement et d’information, mais pas les messages de débogage. Définir les niveaux “debug” ou “trace” n’est généralement nécessaire qu’à la demande du support. Définir le niveau sur “debug”/“trace” pourrait avoir un léger impact sur l’utilisation du disque et les E/S, en particulier sur les sites à fort trafic. La surcharge du CPU est minimale avec l’option debug activée. Valeurs acceptées :

error
warning
info
debug
trace

log_path

Champ	Valeur
Clé du fichier de configuration	`log_path`
Clé de variable d’environnement système	`APPSIGNAL_LOG_PATH`
Obligatoire	non
Type	`String`
Valeur par défaut	`/tmp`
Disponible depuis la version	`0.1.0`

Description

Cette option configure l’emplacement du fichier de journalisation interne d’AppSignal et n’affecte pas la fonctionnalité de journalisation.
Note : Le chemin spécifié ne peut pas contenir d’abstractions de système de fichiers spécifiques au système d’exploitation, comme le symbole du répertoire personnel ~ pour les systèmes *NIX. Cela sera considéré comme un chemin malformé.

Remplacez l’emplacement du chemin (répertoire) où le fichier appsignal.log peut être écrit.

nginx_port

Champ	Valeur
Clé du fichier de configuration	`nginx_port`
Clé de variable d’environnement système	`APPSIGNAL_NGINX_PORT`
Obligatoire	non
Type	`Integer`
Valeur par défaut	`27649`
Disponible depuis la version	`1.5.4`

Description

Configurez le port sur lequel le serveur de métriques NGINX est exposé. Lorsque AppSignal reçoit des métriques NGINX, il écoute sur un serveur lié à localhost, par défaut sur le port 27649. Si vous exécutez plusieurs applications instrumentées par AppSignal sur le même serveur avec les métriques NGINX activées, utilisez cette option pour configurer chaque application à écouter sur un port différent.

Agent uniquement : lors de l’utilisation d’un collecteur externe, cette option de configuration n’a aucun effet.

opentelemetry_port

Champ	Valeur
Clé du fichier de configuration	`opentelemetry_port`
Clé de variable d’environnement système	`APPSIGNAL_OPENTELEMETRY_PORT`
Obligatoire	non
Type	`Integer`
Valeur par défaut	`8099`
Disponible depuis la version	`0.2.2`

Description

Définissez cette option pour configurer le port du serveur HTTP OpenTelemetry du processus de l’agent AppSignal. Configurez ce port si un autre processus est déjà en cours d’exécution sur la machine et utilise également ce port, pour éviter les conflits.

Agent uniquement : lors de l’utilisation d’un collecteur externe, cette option de configuration n’a aucun effet. Le port à utiliser pour envoyer des données OpenTelemetry au collecteur externe peut être spécifié dans le cadre de l’option de configuration collector_endpoint.

request_headers

Champ	Valeur
Clé du fichier de configuration	`request_headers`
Clé de variable d’environnement système	`APPSIGNAL_REQUEST_HEADERS`
Obligatoire	non
Type	`list(String)`
Valeur par défaut	`["accept", "accept-charset", "accept-encoding", "accept-language", "cache-control", "connection", "content-length", "range"]`
Disponible depuis la version	`0.1.0`

Description

L’option de configuration request_headers contient une liste d’en-têtes de requête HTTP qui sont lus et stockés par le package AppSignal Python. Cette option de configuration request_headers est une liste d’autorisations, ce qui signifie qu’elle ne prendra que les en-têtes spécifiés par cette option de configuration. Si cette option de configuration n’est pas définie, elle utilisera la valeur par défaut d’AppSignal. La liste suivante est la valeur par défaut du package AppSignal.

Python

# __appsignal__.py
appsignal = Appsignal(
  # ...Other config opts
  request_headers=[
    "accept",
    "accept-charset",
    "accept-encoding",
    "accept-language",
    "cache-control",
    "connection",
    "content-length",
    "range"
  ]
)

Pour personnaliser cette liste, ajoutez l’option de configuration avec tous les en-têtes que vous souhaitez signaler. Tous les noms d’en-têtes doivent être écrits en caractères minuscules. Si le nom de l’en-tête est X-Custom-Header, ajoutez-le à cette liste comme x-custom-header. Pour configurer AppSignal pour qu’il ne stocke aucun en-tête de requête HTTP sur les traces AppSignal, configurez l’option avec une liste vide.

Python

# __appsignal__.py
appsignal = Appsignal(
  # ...Other config opts
  request_headers=[]
)

response_headers

Champ	Valeur
Clé du fichier de configuration	`response_headers`
Clé de variable d’environnement système	`APPSIGNAL_RESPONSE_HEADERS`
Obligatoire	non
Type	`list(String)`
Valeur par défaut	`[]`
Disponible depuis la version	`1.6.0`

Description

L’option de configuration response_headers contient une liste d’en-têtes de réponse HTTP qui sont lus et stockés par le package AppSignal pour Python. Cette option de configuration response_headers est une liste d’autorisations, ce qui signifie qu’elle ne prendra que les en-têtes spécifiés par cette option de configuration. Si cette option de configuration n’est pas définie, elle ne signalera aucun en-tête de réponse. Pour personnaliser cette liste, ajoutez l’option de configuration avec tous les en-têtes que vous souhaitez signaler. Tous les noms d’en-têtes doivent être écrits en caractères minuscules. Si le nom de l’en-tête est X-Custom-Header, ajoutez-le à cette liste comme x-custom-header.

Collecteur uniquement : cette option de configuration n’aura d’effet que lors de l’utilisation d’un collecteur externe.

revision

Champ	Valeur
Clé du fichier de configuration	`revision`
Clé de variable d’environnement système	`APP_REVISION`
Obligatoire	non
Type	`String`
Valeur par défaut	nil (Non défini par défaut)
Disponible depuis la version	`0.1.0`
	`0.2.0` : Détection automatique pour les déploiements Render. `1.3.3` : Détection automatique pour les déploiements Kamal.

Description

Définissez la révision de l’application pour signaler 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. Lorsque votre application est déployée à l’aide de Kamal, ou lorsqu’elle est déployée sur Render, ou lorsqu’elle est déployée sur Heroku et que la fonctionnalité Heroku Labs : Dyno Metadata est activée, l’intégration AppSignal détectera automatiquement le commit Git du déploiement actuel et l’utilisera comme révision. Vous pouvez écraser les révisions automatiquement détectées sur Heroku, Render ou Kamal en définissant manuellement l’option de configuration revision sur une valeur personnalisée. En savoir plus sur les marqueurs de déploiement dans la rubrique marqueurs de déploiement.

Lors de l’utilisation d’un collecteur externe, la révision n’est pas automatiquement détectée. Définissez cette option manuellement pour signaler la version actuellement en cours d’exécution de votre application.

running_in_container

Champ	Valeur
Clé du fichier de configuration	`running_in_container`
Clé de variable d’environnement système	`APPSIGNAL_RUNNING_IN_CONTAINER`
Obligatoire	non
Type	Booléen (`true` / `false`)
Valeur par défaut	détecté par l’agent
Disponible depuis la version	`0.1.0`

Description

AppSignal s’attend à s’exécuter sur la même machine entre différents déploiements. Définissez cette clé sur true si l’application s’exécute dans un conteneur, par exemple avec Docker. Les versions plus récentes de l’intégration AppSignal détectent automatiquement leur environnement de conteneur, aucune configuration manuelle n’est donc nécessaire. Si vous rencontrez des problèmes avec la détection automatique, veuillez contacter le support. Cette option est définie sur true automatiquement sur Heroku.

Agent uniquement : lors de l’utilisation d’un collecteur externe, cette option de configuration n’a aucun effet.

send_environment_metadata

Champ	Valeur
Clé du fichier de configuration	`send_environment_metadata`
Clé de variable d’environnement système	`APPSIGNAL_SEND_ENVIRONMENT_METADATA`
Obligatoire	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`0.1.0`

Description

Envoie des métadonnées d’environnement concernant l’application. Pour plus d’informations, veuillez consulter les métadonnées d’environnement.

Agent uniquement : lors de l’utilisation d’un collecteur externe, cette option de configuration n’a aucun effet.

send_function_parameters

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

Description

Indique s’il faut envoyer les paramètres de fonction à AppSignal.

Collecteur uniquement : cette option de configuration n’aura d’effet que lors de l’utilisation d’un collecteur externe.Consultez l’option de configuration send_params pour envoyer des données lorsque vous n’utilisez pas l’agent.

send_params

Champ	Valeur
Clé du fichier de configuration	`send_params`
Clé de variable d’environnement système	`APPSIGNAL_SEND_PARAMS`
Obligatoire	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`0.1.0`

Description

Indique s’il faut éviter d’envoyer les paramètres de requête à AppSignal. Pour plus d’informations, veuillez consulter send_params dans le filtrage des paramètres de requête.

Agent uniquement : lors de l’utilisation d’un collecteur externe, cette option de configuration n’a aucun effet.Consultez les options de configuration suivantes pour envoyer les paramètres lors de l’utilisation d’un collecteur externe :

send_function_parameters
send_request_payload
send_request_query_parameters

send_request_payload

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

Description

Indique s’il faut envoyer la charge utile de requête à AppSignal.

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`
Obligatoire	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`1.6.0`

Description

Indique s’il faut envoyer les paramètres de requête à AppSignal.

send_session_data

Champ	Valeur
Clé du fichier de configuration	`send_session_data`
Clé de variable d’environnement système	`APPSIGNAL_SEND_SESSION_DATA`
Obligatoire	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`0.1.0`

Description

Définissez cette option sur false pour ne pas envoyer de données de session avec les traces d’exception et les échantillons de problèmes de performance. Pour plus d’informations, veuillez consulter le filtrage des données de session de requête.

service_name

Champ	Valeur
Clé du fichier de configuration	`service_name`
Clé de variable d’environnement système	`APPSIGNAL_SERVICE_NAME`
Obligatoire	non
Type	`String`
Valeur par défaut	“
Disponible depuis la version	`1.6.0`

Description

Le nom du service aide AppSignal à reconnaître différents services pour les traces et regroupe automatiquement les traces dans un namespace basé sur le nom du service. Choisissez un nom qui correspond à votre application, comme “Web server”, “Background worker”, “Email service”, “Authentication service”, etc.

Collecteur uniquement : cette option de configuration n’aura d’effet que lors de l’utilisation d’un collecteur externe.

statsd_port

Champ	Valeur
Clé du fichier de configuration	`statsd_port`
Clé de variable d’environnement système	`APPSIGNAL_STATSD_PORT`
Obligatoire	non
Type	`Integer`
Valeur par défaut	`8125`
Disponible depuis la version	`0.2.2`

Description

Définissez cette option pour configurer le port du serveur HTTP StatsD du processus de l’agent AppSignal. Configurez ce port si un autre processus est déjà en cours d’exécution sur la machine et utilise également ce port, pour éviter les conflits.

Agent uniquement : lors de l’utilisation d’un collecteur externe, cette option de configuration n’a aucun effet.

working_directory_path

Champ	Valeur
Clé du fichier de configuration	`working_directory_path`
Clé de variable d’environnement système	`APPSIGNAL_WORKING_DIRECTORY_PATH`
Obligatoire	non
Type	`String`
Valeur par défaut	détecté par l’agent
Disponible depuis la version	`0.1.0`

Description

Remplacez l’emplacement où AppSignal pour Python peut stocker des fichiers temporaires. Utilisez cette option si l’emplacement par défaut ne convient pas. Consultez notre page comment fonctionne AppSignal pour plus d’informations sur la finalité de ce répertoire de travail. Si vous exécutez plusieurs applications utilisant AppSignal sur le même serveur, utilisez cette option de configuration pour sélectionner différents répertoires de travail pour chaque instance d’AppSignal, sinon les deux instances pourraient entrer en conflit l’une avec l’autre. Pour plus d’informations sur ce scénario, consultez notre documentation exécution de plusieurs applications sur un seul hôte.

Python

# __appsignal__.py
appsignal = Appsignal(
  # Other config
  working_directory_path="/tmp/project_1"
)

Note : Le chemin spécifié ne peut pas contenir d’abstractions de système de fichiers spécifiques au système d’exploitation, comme le symbole du répertoire personnel ~ pour les systèmes *NIX. Cela sera considéré comme un chemin malformé.

Agent uniquement : lors de l’utilisation d’un collecteur externe, cette option de configuration n’a aucun effet.

​Options disponibles

​active

​Description

​environment

​Description

​name

​Description

​push_api_key

​Description

​bind_address

​Description

​ca_file_path

​Description

​collector_endpoint

​Description

​cpu_count

​Description

​disable_default_instrumentations

​Description

​dns_servers

​Description

​enable_host_metrics

​Description

​enable_minutely_probes

​Description

​enable_nginx_metrics

​Description

​enable_statsd

​Description

​endpoint

​Description

​files_world_accessible

​Description

​filter_attributes

​Description

​filter_function_parameters

​Description

​filter_parameters

​Description

​filter_request_payload

​Description

​filter_request_query_parameters

​Description

​filter_session_data

​Description

​host_role

​Description

​hostname

​Description

​http_proxy

​Description

​ignore_actions

​Description

​ignore_errors

​Description

​ignore_namespaces

​Description

​log

​Description

​log_level

​Description

​log_path

​Description

​nginx_port

​Description

​opentelemetry_port

​Description

​request_headers

​Description

​response_headers

​Description

​revision

​Description

​running_in_container

​Description

​send_environment_metadata

​Description

​send_function_parameters

​Description

​send_params

Options disponibles

active

Description

environment

Description

name

Description

push_api_key

Description

bind_address

Description

ca_file_path

Description

collector_endpoint

Description

cpu_count

Description

disable_default_instrumentations

Description

dns_servers

Description

enable_host_metrics

Description

enable_minutely_probes

Description

enable_nginx_metrics

Description

enable_statsd

Description

endpoint

Description

files_world_accessible

Description

filter_attributes

Description

filter_function_parameters

Description

filter_parameters

Description

filter_request_payload

Description

filter_request_query_parameters

Description

filter_session_data

Description

host_role

Description

hostname

Description

http_proxy

Description

ignore_actions

Description

ignore_errors

Description

ignore_namespaces

Description

log

Description

log_level

Description

log_path

Description

nginx_port

Description

opentelemetry_port

Description

request_headers

Description

response_headers

Description

revision

Description

running_in_container

Description

send_environment_metadata

Description

send_function_parameters

Description

send_params