Options de configuration de la gem Ruby

La liste suivante inclut 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 section Configuration.

active

Champ	Valeur
Clé du fichier de configuration	`active`
Clé de variable d’environnement système	`APPSIGNAL_ACTIVE`
Obligatoire	oui
Type	Booléen (`true` / `false`)
Valeur par défaut	`false` / détecté par le système
Disponible depuis la version	`0.3.0`
	`0.11.6` : Prise en charge ajoutée pour l’option de variable d’environnement.

Description

Note : Lorsque la variable d’environnement APPSIGNAL_PUSH_API_KEY est définie, cela passe par défaut à true. Cela peut être remplacé en définissant la variable d’environnement système APPSIGNAL_ACTIVE sur false : APPSIGNAL_ACTIVE=false.

Configurez AppSignal pour qu’il soit actif ou non pour un environnement donné. Le plus souvent utilisé dans la configuration par fichier par environnement.

APPSIGNAL_APP_ENV

Champ	Valeur
Clé de variable d’environnement système	`APPSIGNAL_APP_ENV`
Obligatoire	oui
Type	`String`
Valeur par défaut	`""` / détecté par le système
Disponible depuis la version	`0.11.8`
	`1.3.0` : Prise en charge ajoutée pour Padrino. `1.3.6` : Prise en charge ajoutée pour Sinatra. `2.0.4` : Standardise le comportement pour toute la configuration.

Description

L’environnement de l’application à signaler à AppSignal. Cette option de configuration sera automatiquement détectée dans les applications Rails. Pour les applications Rails, la variable RAILS_ENV est utilisée pour détecter l’environnement. Pour les applications utilisant d’autres frameworks ou aucun, la variable d’environnement RACK_ENV est utilisée. Pour remplacer cette détection automatique, définissez la variable d’environnement APPSIGNAL_APP_ENV.

Shell

export APPSIGNAL_APP_ENV=staging
rackup

Cette option sera utilisée pour charger la configuration à partir des fichiers de configuration dans lesquels la configuration d’AppSignal est stockée. L’option de variable d’environnement est couramment utilisée sur les plateformes où les applications s’exécutent par défaut dans l’environnement production, telles que Heroku. Ce paramètre permet de remplacer pour définir l’environnement sur staging, par exemple.

Shell

heroku config:set APPSIGNAL_APP_ENV=staging

Si l’environnement est défini à l’aide de l’assistant Appsignal.configure, il remplacera la variable d’environnement APPSIGNAL_APP_ENV.

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

Note : Cette option de configuration n’a pas d’équivalent en tant que clé de fichier de configuration. Pour définir l’environnement à l’initialisation d’AppSignal, vous devrez initialiser la configuration manuellement.

Environnements personnalisés dans le fichier de configuration

Il n’existe pas de clé env disponible dans le fichier config/appsignal.yml. Si vous souhaitez définir dynamiquement le nom de l’environnement pour une application dans le fichier de configuration, il est possible de personnaliser votre fichier de configuration pour utiliser l’environnement afin de créer un environnement.

YAML

# config/appsignal.yml
<%= ENV["APPSIGNAL_APP_ENV"] %>:
  active: true

Si vous utilisez une autre variable d’environnement que APPSIGNAL_APP_ENV, assurez-vous que cela correspond à la valeur de l’un des noms de variables d’environnement détectés automatiquement (RAILS_ENV et RACK_ENV) ou à la valeur donnée à Appsignal.configure.

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é d’environnement système	`APPSIGNAL_APP_NAME`
Requis	oui
Type	`String`
Valeur par défaut	nil (Ceci n’est pas défini par défaut)
Disponible depuis la version	`1.0.0`

Description

Nom de votre application tel qu’il doit être affiché sur AppSignal.com. Si vous utilisez Ruby on Rails, le gem détectera automatiquement le nom et vous pouvez laisser ce champ vide. Pour les autres frameworks, le définir est obligatoire.

Remarque : 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é d’environnement système	`APPSIGNAL_PUSH_API_KEY`
Requis	oui
Type	`String`
Valeur par défaut	nil (Ceci n’est pas 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 Push API. En savoir plus sur la clé Push API d’AppSignal.

Remarque : Lorsque la variable d’environnement système APPSIGNAL_PUSH_API_KEY est définie, l’option active prendra par défaut la valeur true au lieu de false. Cela signifie qu’AppSignal sera considéré comme actif pour l’environnement chargé même si active est défini sur false dans le fichier de configuration. Pour plus d’informations, consultez l’option active.

activejob_report_errors

Champ	Valeur
Clé du fichier de configuration	`activejob_report_errors`
Clé de variable d’environnement système	`APPSIGNAL_ACTIVEJOB_REPORT_ERRORS`
Obligatoire	non
Type	`String`
Valeur par défaut	`all`
Disponible depuis la version	`3.6.1`
	`3.7.3` : La valeur `discard` a été ajoutée. `3.9.0` : Prise en charge ajoutée pour la variable d’environnement `APPSIGNAL_ACTIVEJOB_REPORT_ERRORS`.

Description

Configurez le signalement des erreurs qui se produisent dans les jobs Active Job. Cette option permet de désactiver le signalement des erreurs pour les jobs Active Job, afin de permettre l’ajout d’un signalement d’erreur personnalisé. Valeurs acceptées :

all : Signale toutes les erreurs pour chaque exécution de jobs, y compris les nouvelles tentatives.
discard : Signale les erreurs lorsque le job est abandonné en raison de l’erreur. Utilisez cette option pour ne signaler les erreurs que lorsque toutes les nouvelles tentatives du job ont été épuisées.
none : Ne signale aucune erreur pour les jobs, y compris les nouvelles tentatives.

Note : L’option discard ne fonctionne que sur Active Job 7.1 et plus récent. Sur les versions inférieures, discard est lu comme all.

bind_address

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

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 adressées à 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 provenant du même hôte. Cette option s’applique à tous les serveurs de l’agent (StatsD, OpenTelemetry et NGINX).

ca_file_path

Champ	Valeur
Clé du fichier de configuration	`ca_file_path`
Clé 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	`1.3.5`

Description

Configurez le chemin du fichier de certificat SSL. Par défaut, cela pointe vers le fichier cacert.pem fourni par AppSignal dans le gem lui-même. Utilisez cette option pour pointer vers un autre fichier de certificat s’il y a un problème de connexion à notre API.

Remarque : Le chemin spécifié ne peut pas contenir d’abstractions de 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é.

collector_endpoint

Champ	Valeur
Clé du fichier de configuration	`collector_endpoint`
Clé d’environnement système	`APPSIGNAL_COLLECTOR_ENDPOINT`
Requis	non
Type	`String`
Valeur par défaut	nil (Ceci n’est pas défini par défaut)
Disponible depuis la version	`5.0.0`

Description

L’adresse d’un Collector AppSignal déployé en externe. Lorsque cette option est définie, les traces, métriques et logs OpenTelemetry sont envoyés au collector à cette adresse.

Il s’agit d’une option de configuration expérimentale. Le tracing distribué est disponible uniquement lors de l’utilisation du collector hébergé d’AppSignal.

Le mode collector nécessite Ruby 3.1 ou une version ultérieure, ne prend pas en charge JRuby, et a besoin des gems OpenTelemetry, qui sont facultatives et doivent être ajoutées au Gemfile de votre application. Consultez le guide de configuration du collector pour connaître les gems et versions minimales requises. Sur des versions de Ruby plus anciennes, ou lorsque les gems sont manquantes ou trop anciennes, cette option est ignorée.

cpu_count

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

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. S’il n’est pas défini, l’agent tentera de le détecter automatiquement à partir des cgroups. Le nombre de CPU peut être une fraction, par exemple 0.5.

debug

Champ	Valeur
Clé du fichier de configuration	`debug`
Clé d’environnement système	`APPSIGNAL_DEBUG`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`false`
Disponible depuis la version	`1.0.0`
	`3.0.16` : Déconseillée au profit de l’option de configuration `log_level`. `4.0.0` : Supprimée du gem. Utilisez plutôt l’option de configuration `log_level`.

Description

Avertissement : Cette option de configuration a été supprimée dans le gem Ruby 4.0.0. La définir dans le gem Ruby 4.0.0 ou une version ultérieure n’a aucun effet. Utilisez plutôt l’option log_level.

Activez la journalisation de débogage. Cela n’est généralement nécessaire qu’à la demande du support. Avec cette option activée, AppSignal enregistrera beaucoup plus d’informations sur les décisions prises lors de la collecte de métriques et lors de l’envoi de données aux serveurs AppSignal.com. L’activation de la journalisation de débogage pourrait avoir un léger impact sur l’utilisation du disque et les E/S, en particulier sur les sites à fort trafic. La surcharge CPU est minimale lorsque l’option de débogage est activée.

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

default_tags

Champ	Valeur
Clé du fichier de configuration	`default_tags`
Clé d’environnement système	`APPSIGNAL_DEFAULT_TAGS`
Requis	non
Type	`Hash[String, (String \| Symbol \| Integer \| Boolean)]`
Valeur par défaut	`{}`
Disponible depuis la version	`4.8.3`

Description

Tags par défaut qui seront ajoutés à toutes les transactions. Les tags spécifiques à une transaction définis avec Appsignal.add_tags remplaceront les tags par défaut ayant la même clé.

Appsignal.configure do |config|
  config.default_tags = {
    "region" => "europe",
    "shard" => "shard-1"
  }
end

default: &defaults
  default_tags:
    region: europe
    shard: shard-1

Lorsque vous utilisez la variable d’environnement, fournissez une liste de paires clé-valeur séparées par des virgules.

Shell

export APPSIGNAL_DEFAULT_TAGS="region=europe,shard=shard-1"

Les valeurs des tags doivent être de type String, Symbol, Integer ou Boolean. Les tags avec d’autres types de valeurs seront ignorés. En savoir plus sur le tagging.

dns_servers

Champ	Valeur
Clé du fichier de configuration	`dns_servers`
Clé d’environnement système	`APPSIGNAL_DNS_SERVERS`
Requis	non
Type	`Array<String>`
Valeur par défaut	`[]`
Disponible depuis la version	`2.2.0.beta.1`
	`2.11.0` : Prise en charge ajoutée pour l’option d’environnement système.

Description

Configurez les serveurs DNS à utiliser par l’agent AppSignal.

Appsignal.configure do |config|
  config.dns_servers = ["8.8.8.8", "8.8.4.4"]
end

default: &defaults
  dns_servers:
    - 8.8.8.8
    - 8.8.4.4

# 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 un serveur DNS manuellement à l’aide de 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.

enable_active_support_event_log_reporter

Champ	Valeur
Clé du fichier de configuration	`enable_active_support_event_log_reporter`
Clé d’environnement système	`APPSIGNAL_ENABLE_ACTIVE_SUPPORT_EVENT_LOG_REPORTER`
Requis	non
Type	`Boolean`
Valeur par défaut	`false`
Disponible depuis la version	`4.8.0`
	`4.8.1` : L’intégration est désormais opt-in. Elle était activée par défaut dans `4.8.0`.

Description

Active l’intégration de rapport d’événements structurés ActiveSupport::EventReporter. Lorsqu’elle est activée, l’intégration AppSignal s’abonne aux événements émis par ActiveSupport::EventReporter et les rapporte sous forme de logs.

enable_allocation_tracking

Champ	Valeur
Clé du fichier de configuration	`enable_allocation_tracking`
Clé d’environnement système	`APPSIGNAL_ENABLE_ALLOCATION_TRACKING`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`1.0.0`

Description

Définissez cette option sur false pour désactiver le suivi du nombre d’objets alloués en Ruby.

enable_at_exit_hook

Champ	Valeur
Clé du fichier de configuration	`enable_at_exit_hook`
Clé d’environnement système	`APPSIGNAL_ENABLE_AT_EXIT_HOOK`
Requis	non
Type	`String`
Valeur par défaut	’on_error’ / ‘always’ sur les conteneurs
Disponible depuis la version	`4.5.8`

Description

Configurez la manière dont AppSignal s’arrête lorsque l’application s’arrête. Cela déterminera s’il appelle automatiquement Appsignal.stop, qui videra les données vers l’extension et l’agent. Cette option a trois valeurs possibles :

always : Toujours appeler Appsignal.stop lorsque le programme se termine. Sur les conteneurs (Docker), c’est automatiquement défini sur cette valeur.
never : Ne jamais appeler Appsignal.stop lorsque le programme se termine. La valeur par défaut lorsque le programme ne s’exécute pas sur un conteneur (Docker).
on_error : Appeler Appsignal.stop lorsque le programme se termine avec une erreur.

Pour plus d’informations, consultez notre page sur l’instrumentation pour les scripts et les tâches en arrière-plan.

enable_at_exit_reporter

Champ	Valeur
Clé du fichier de configuration	`enable_at_exit_reporter`
Clé d’environnement système	`APPSIGNAL_ENABLE_AT_EXIT_REPORTER`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`4.0.0`

Description

Définissez sur true pour signaler la dernière erreur ayant provoqué l’arrêt du processus. L’erreur signalée est généralement l’erreur qui fait planter le processus. Si le gem Ruby a déjà signalé l’erreur, elle ne sera pas signalée à nouveau. Les erreurs signalées via ce mécanisme sont ajoutées au namespace “unhandled”. Ajoutez ce code au début de l’application sur les conteneurs à courte durée de vie et les fonctions serverless pour vous assurer que l’erreur est vidée avant l’arrêt du système.

Ruby

at_exit { sleep 5 }

enable_frontend_error_catching

Champ	Valeur
Clé du fichier de configuration	`enable_frontend_error_catching`
Clé d’environnement système	`APPSIGNAL_ENABLE_FRONTEND_ERROR_CATCHING`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`false`
Disponible depuis la version	`1.0.0`
	`3.0.0` : Retiré du gem. Consultez notre guide de mise à niveau pour plus d’informations.

Description

Active le système expérimental de capture d’erreurs front-end. Cela ajoutera une route à votre application sur /appsignal_error_catcher qui peut être utilisée pour capturer les erreurs JavaScript et les envoyer à AppSignal. Vous pouvez configurer cette route avec frontend_error_catching_path.

enable_gvl_global_timer

Champ	Valeur
Clé du fichier de configuration	`enable_gvl_global_timer`
Clé d’environnement système	`APPSIGNAL_ENABLE_GVL_GLOBAL_TIMER`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`3.3.9`

Description

Définissez cette option sur false pour désactiver l’instrumentation du timer global GVL. Cette option de configuration n’a aucun effet si GVLTools n’est pas installé.

enable_gvl_waiting_threads

Champ	Valeur
Clé du fichier de configuration	`enable_gvl_waiting_threads`
Clé d’environnement système	`APPSIGNAL_ENABLE_GVL_WAITING_THREADS`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`3.3.9`

Description

Définissez cette option sur false pour désactiver l’instrumentation des threads en attente GVL. Cette option de configuration n’a aucun effet si GVLTools n’est pas installé.

enable_host_metrics

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

Description

Définissez cette option sur false pour désactiver la collecte de 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 car 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.

enable_job_enqueue_instrumentation

Champ	Valeur
Clé du fichier de configuration	`enable_job_enqueue_instrumentation`
Clé d’environnement système	`APPSIGNAL_ENABLE_JOB_ENQUEUE_INSTRUMENTATION`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`4.9.0`

Description

Active ou désactive l’enregistrement d’un événement lorsqu’un background job est mis en file d’attente. Lorsque cette option est activée, mettre en file d’attente un job depuis une transaction active enregistre un événement de mise en file d’attente dans la chronologie des événements de cette transaction. Cela s’applique à l’instrumentation de mise en file d’attente de chaque intégration de background job :

Définir cette option sur false empêche l’enregistrement de ces événements de mise en file d’attente, sans affecter l’instrumentation des jobs eux-mêmes. Activé par défaut.

enable_minutely_probes

Champ	Valeur
Clé du fichier de configuration	`enable_minutely_probes`
Clé d’environnement système	`APPSIGNAL_ENABLE_MINUTELY_PROBES`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`1.3.0`
	`2.9.0` : La valeur par défaut a été changée en `true`.

Description

Active le système de sondes à la minute.

enable_nginx_metrics

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

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.

enable_rails_error_reporter

Champ	Valeur
Clé du fichier de configuration	`enable_rails_error_reporter`
Clé d’environnement système	`APPSIGNAL_ENABLE_RAILS_ERROR_REPORTER`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`3.4.1`

Description

Définissez sur false pour désactiver l’abonné au reporter d’erreurs Rails. Consultez la documentation Rails pour plus de détails.

enable_rake_performance_instrumentation

Champ	Valeur
Clé du fichier de configuration	`enable_rake_performance_instrumentation`
Clé d’environnement système	`APPSIGNAL_ENABLE_RAKE_PERFORMANCE_INSTRUMENTATION`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`false`
Disponible depuis la version	`3.10.0`

Description

Activez l’instrumentation des performances pour les tâches Rake. Par défaut, l’instrumentation Rake ne rapporte que les erreurs.

enable_statsd

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

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.

endpoint

Champ	Valeur
Clé du fichier de configuration	`endpoint`
Clé d’environnement système	`APPSIGNAL_PUSH_API_ENDPOINT`
Requis	non
Type	`String`
Valeur par défaut	`https://push.appsignal.com`
Disponible depuis la version	`0.1.0`
	`1.0.0` : Prise en charge ajoutée pour la variable d’environnement système.

Description

Configurez le point de terminaison pour envoyer les données à AppSignal. Ce paramètre n’aura pas besoin d’être modifié.

files_world_accessible

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

Description

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

filter_attributes

Champ	Valeur
Clé du fichier de configuration	`filter_attributes`
Clé d’environnement système	`APPSIGNAL_FILTER_ATTRIBUTES`
Requis	non
Type	`list(String)`
Valeur par défaut	`[]`
Disponible depuis la version	`5.0.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é d’environnement système	`APPSIGNAL_FILTER_FUNCTION_PARAMETERS`
Requis	non
Type	`list(String)`
Valeur par défaut	`[]`
Disponible depuis la version	`5.0.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. Tant que cette option n’est pas définie, sa valeur est dérivée de l’option de configuration filter_parameters.

filter_metadata

Champ	Valeur
Clé du fichier de configuration	`filter_metadata`
Clé d’environnement système	`APPSIGNAL_FILTER_METADATA`
Requis	non
Type	`Array<String>`
Valeur par défaut	`[]`
Disponible depuis la version	`3.4.5`

Description

Le gem Ruby AppSignal stocke par défaut des métadonnées sur les requêtes et les tâches en arrière-plan sur les traces, comme le chemin de la requête, la méthode de la requête, l’identifiant de la requête, la file d’attente en arrière-plan, l’identifiant de la tâche et le nombre de nouvelles tentatives de la tâche. Ces valeurs de métadonnées seront affichées dans la zone des tags. Si l’une de ces valeurs de métadonnées contient des informations personnellement identifiables (PII) ou d’autres données sensibles, utilisez cette option de configuration pour filtrer les métadonnées par clé. Définissez l’option filter_metadata sur une liste de clés de métadonnées à filtrer. Vous pouvez configurer cela avec une liste de clés dans le fichier de configuration. Une fois filtrées, les métadonnées ne seront pas visibles dans l’interface utilisateur d’AppSignal.

Appsignal.configure do |config|
  config.filter_metadata += ["path", "request_id"]
end

default: &defaults
  filter_metadata:
    - path
    - request_id

filter_parameters

Champ	Valeur
Clé du fichier de configuration	`filter_parameters`
Clé d’environnement système	`APPSIGNAL_FILTER_PARAMETERS`
Requis	non
Type	`Array<String>`
Valeur par défaut	`[]`
Disponible depuis la version	`1.3.0`
	`2.3.0` : Cette option de configuration est également utilisée pour le filtrage des arguments dans les intégrations de tâches en arrière-plan.

Description

Liste de clés de paramètres qui doivent être ignorées à l’aide du filtrage AppSignal. Leurs valeurs seront remplacées par [FILTERED] lors de la transmission à AppSignal. Vous pouvez configurer cela avec une liste de clés dans le fichier de configuration.

Appsignal.configure do |config|
  config.filter_parameters += ["password", "email", "api_token", "token"]
end

# config/appsignal.yml
default: &defaults
  filter_parameters:
    - password
    - email
    - api_token
    - token

En savoir plus sur le filtrage des paramètres.

Agent uniquement : lors de l’utilisation d’un collecteur externe, cette option de configuration définit la valeur par défaut des options ci-dessous et n’a aucun autre effet.Utilisez les options de configuration suivantes pour définir comment la charge utile des requêtes, les paramètres de requête et les paramètres de fonction sont filtrés :

filter_function_parameters
filter_request_payload
filter_request_query_parameters

filter_request_payload

Champ	Valeur
Clé du fichier de configuration	`filter_request_payload`
Clé d’environnement système	`APPSIGNAL_FILTER_REQUEST_PAYLOAD`
Requis	non
Type	`list(String)`
Valeur par défaut	`[]`
Disponible depuis la version	`5.0.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. Tant que cette option n’est pas définie, sa valeur est dérivée de l’option de configuration filter_parameters.

filter_request_query_parameters

Champ	Valeur
Clé du fichier de configuration	`filter_request_query_parameters`
Clé d’environnement système	`APPSIGNAL_FILTER_REQUEST_QUERY_PARAMETERS`
Requis	non
Type	`list(String)`
Valeur par défaut	`[]`
Disponible depuis la version	`5.0.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. Tant que cette option n’est pas définie, sa valeur est dérivée de l’option de configuration filter_parameters.

filter_session_data

Champ	Valeur
Clé du fichier de configuration	`filter_session_data`
Clé d’environnement système	`APPSIGNAL_FILTER_SESSION_DATA`
Requis	non
Type	`Array<String>`
Valeur par défaut	`[]`
Disponible depuis la version	`2.6.0`
	`2.6.1` : Une mise à niveau vers cette version ou une version supérieure est recommandée.

Description

Liste de clés de données de session qui doivent être ignorées à l’aide du filtrage AppSignal. Leurs valeurs seront remplacées par [FILTERED] lors de la transmission à AppSignal. Vous pouvez configurer cela avec une liste de clés dans le fichier de configuration.

Appsignal.configure do |config|
  config.filter_session_data += ["name", "email", "api_token", "token"]
end

# config/appsignal.yml
default: &defaults
  filter_session_data:
    - name
    - email
    - api_token
    - token

En savoir plus sur le filtrage des données de session.

host_role

Champ	Valeur
Clé du fichier de configuration	`host_role`
Clé d’environnement système	`APPSIGNAL_HOST_ROLE`
Requis	non
Type	`String`
Valeur par défaut	nil (Ceci n’est pas défini par défaut)
Disponible depuis la version	`3.4.11`

Description

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

hostname

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

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 peu descriptif est généré pour vous sur des services d’hébergement.

http_proxy

Champ	Valeur
Clé du fichier de configuration	`http_proxy`
Clé d’environnement système	`APPSIGNAL_HTTP_PROXY`
Requis	non
Type	`String`
Valeur par défaut	nil (Ceci n’est pas défini par défaut)
Disponible depuis la version	`0.11.13`

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é d’environnement système	`APPSIGNAL_IGNORE_ACTIONS`
Requis	non
Type	`Array<String>`
Valeur par défaut	`[]`
Disponible depuis la version	`0.10.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 passe, y compris les exceptions, ne sera pas transmis à AppSignal. Cela peut être utile pour ignorer les points de terminaison de vérification de l’é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é d’environnement système	`APPSIGNAL_IGNORE_ERRORS`
Requis	non
Type	`Array<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_logs

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

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 la syntaxe regex est pris en charge ; pour en savoir plus, consultez notre guide Ignorer les logs.

ignore_namespaces

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

Description

Liste de 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.

instrument_active_job

Champ	Valeur
Clé du fichier de configuration	`instrument_active_job`
Clé d’environnement système	`APPSIGNAL_INSTRUMENT_ACTIVE_JOB`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`4.9.0`

Description

Active ou désactive l’instrumentation pour Active Job. Définir cette option sur false désactive entièrement l’intégration, y compris l’instrumentation des jobs et l’instrumentation de mise en file d’attente. Activé par défaut.

instrument_code_ownership

Champ	Valeur
Clé du fichier de configuration	`instrument_code_ownership`
Clé d’environnement système	`APPSIGNAL_INSTRUMENT_CODE_OWNERSHIP`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`4.7.1`

Description

Indique s’il faut instrumenter automatiquement le gem CodeOwnership, peut être true ou false.

instrument_delayed_job

Champ	Valeur
Clé du fichier de configuration	`instrument_delayed_job`
Clé d’environnement système	`APPSIGNAL_INSTRUMENT_DELAYED_JOB`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`4.9.0`

Description

Active ou désactive l’instrumentation pour Delayed::Job. Définir cette option sur false désactive entièrement l’intégration, y compris l’instrumentation des jobs et l’instrumentation de mise en file d’attente. Activé par défaut.

instrument_excon

Champ	Valeur
Clé du fichier de configuration	`instrument_excon`
Clé d’environnement système	`APPSIGNAL_INSTRUMENT_EXCON`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`4.9.0`

Description

Active ou désactive l’instrumentation pour Excon. Définir cette option sur false désactive entièrement l’intégration. Activé par défaut.

instrument_faraday

Champ	Valeur
Clé du fichier de configuration	`instrument_faraday`
Clé d’environnement système	`APPSIGNAL_INSTRUMENT_FARADAY`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`4.9.0`

Description

Active ou désactive l’instrumentation pour la gem Faraday. Définir cette option sur false désactive entièrement l’intégration. Activé par défaut.

instrument_http_rb

Champ	Valeur
Clé du fichier de configuration	`instrument_http_rb`
Clé d’environnement système	`APPSIGNAL_INSTRUMENT_HTTP_RB`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`3.2.0`

Description

Activez ou désactivez l’instrumentation pour le gem Ruby http.rb. Activé par défaut.

instrument_mongo

Champ	Valeur
Clé du fichier de configuration	`instrument_mongo`
Clé d’environnement système	`APPSIGNAL_INSTRUMENT_MONGO`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`4.9.0`

Description

Active ou désactive l’instrumentation MongoDB, qui couvre le Mongo Ruby Driver et Mongoid. Définir cette option sur false désactive entièrement l’intégration. Activé par défaut.

instrument_net_http

Champ	Valeur
Clé du fichier de configuration	`instrument_net_http`
Clé d’environnement système	`APPSIGNAL_INSTRUMENT_NET_HTTP`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`0.9.0`

Description

Indique s’il faut ajouter une instrumentation pour les appels net/http, peut être true ou false.

instrument_ownership

Champ	Valeur
Clé du fichier de configuration	`instrument_ownership`
Clé d’environnement système	`APPSIGNAL_INSTRUMENT_OWNERSHIP`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`4.3.3`

Description

Indique s’il faut instrumenter automatiquement le gem Ownership, peut être true ou false.

instrument_que

Champ	Valeur
Clé du fichier de configuration	`instrument_que`
Clé d’environnement système	`APPSIGNAL_INSTRUMENT_QUE`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`4.9.0`

Description

Active ou désactive l’instrumentation pour Que. Définir cette option sur false désactive entièrement l’intégration, y compris l’instrumentation des jobs et l’instrumentation de mise en file d’attente. Activé par défaut.

instrument_redis

Champ	Valeur
Clé du fichier de configuration	`instrument_redis`
Clé d’environnement système	`APPSIGNAL_INSTRUMENT_REDIS`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`1.0.0`

Description

Indique s’il faut activer l’instrumentation pour les requêtes Redis à l’aide du gem Redis, peut être true ou false.

instrument_resque

Champ	Valeur
Clé du fichier de configuration	`instrument_resque`
Clé d’environnement système	`APPSIGNAL_INSTRUMENT_RESQUE`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`4.9.0`

Description

Active ou désactive l’instrumentation pour Resque. Définir cette option sur false désactive entièrement l’intégration, y compris l’instrumentation des jobs et l’instrumentation de mise en file d’attente. Activé par défaut.

instrument_sequel

Champ	Valeur
Clé du fichier de configuration	`instrument_sequel`
Clé d’environnement système	`APPSIGNAL_INSTRUMENT_SEQUEL`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`1.0.0`

Description

Indique s’il faut ajouter une instrumentation pour les requêtes sequel à l’aide de l’intégration du gem Sequel, peut être true ou false.

instrument_shoryuken

Champ	Valeur
Clé du fichier de configuration	`instrument_shoryuken`
Clé d’environnement système	`APPSIGNAL_INSTRUMENT_SHORYUKEN`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`4.9.0`

Description

Active ou désactive l’instrumentation pour Shoryuken. Définir cette option sur false désactive entièrement l’intégration, y compris l’instrumentation des jobs et l’instrumentation de mise en file d’attente. Activé par défaut.

instrument_sidekiq

Champ	Valeur
Clé du fichier de configuration	`instrument_sidekiq`
Clé d’environnement système	`APPSIGNAL_INSTRUMENT_SIDEKIQ`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`4.9.0`

Description

Active ou désactive l’instrumentation pour Sidekiq. Définir cette option sur false désactive entièrement l’intégration, y compris l’instrumentation des jobs et l’instrumentation de mise en file d’attente. Activé par défaut.

keep_request_environment

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

Description

Liste des valeurs de l’environnement Rack à signaler qui ne sont pas des en-têtes de requête HTTP, telles que REMOTE_ADDR et QUERY_STRING. Les clés de l’environnement Rack sont en majuscules et séparées par des underscores. Cette option de configuration est une liste d’autorisation (allowlist), seules les valeurs qu’elle contient sont donc signalées. Définissez-la sur une liste vide pour ne signaler aucune valeur d’environnement. Utilisez keep_request_headers pour les en-têtes de requête. Tant que cette option n’est pas définie, sa valeur est dérivée de l’option de configuration request_headers. Consultez notre guide sur la collecte des en-têtes de requête pour en savoir plus.

Collecteur uniquement : cette option de configuration n’aura d’effet que lors de l’utilisation d’un collecteur externe.Consultez l’option de configuration request_headers pour connaître les en-têtes de requête et les valeurs de l’environnement Rack à signaler lors de l’utilisation de l’agent.

keep_request_headers

Champ	Valeur
Clé du fichier de configuration	`keep_request_headers`
Clé de la variable d’environnement système	`APPSIGNAL_KEEP_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	`5.0.0`

Description

Liste des en-têtes de requête HTTP à signaler. Les noms des en-têtes sont en minuscules et séparés par des tirets, comme les nomme OpenTelemetry : signalez l’en-tête X-Hub-Signature en ajoutant x-hub-signature à cette liste. Cette option de configuration est une liste d’autorisations, elle ne signale donc que les en-têtes qu’elle contient. Définissez-la comme une liste vide pour ne signaler aucun en-tête de requête. Utilisez keep_request_environment pour les valeurs de l’environnement Rack qui ne sont pas des en-têtes de requête. Tant que cette option n’est pas définie, sa valeur est dérivée de l’option de configuration request_headers. Consultez notre guide de collecte des en-têtes de requête pour en savoir plus.

log

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

Description

Cette option configure le logger que la fonctionnalité de journalisation interne d’AppSignal utilisera et n’affecte pas la fonctionnalité de journalisation.Remarque : 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)
- Imprimer les logs AppSignal dans la STDOUT du processus parent au lieu d’un fichier. Utile avec des solutions d’hébergement comme les systèmes de conteneurs et Heroku.

log_level

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

Description

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

Définit 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 n’enregistrera pas les messages de débogage. Le régler sur 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 CPU est minimale lorsque l’option de débogage est activée. Valeurs acceptées :

error
warning
info
debug
trace

log_path

Champ	Valeur
Clé du fichier de configuration	`log_path`
Clé d’environnement système	`APPSIGNAL_LOG_PATH`
Requis	non
Type	`String`
Valeur par défaut	`./log`
Disponible depuis la version	`1.0.0`

Description

Cette option configure l’emplacement du fichier de journalisation interne d’AppSignal et n’affecte pas la fonctionnalité de journalisation.
Remarque : Le chemin spécifié ne peut pas contenir d’abstractions de 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é.

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

logging_endpoint

Champ	Valeur
Clé du fichier de configuration	`logging_endpoint`
Clé d’environnement système	`APPSIGNAL_LOGGING_ENDPOINT`
Requis	non
Type	`String`
Valeur par défaut	`https://appsignal-endpoint.net`
Disponible depuis la version	`3.2.0`

Description

Configurez le point de terminaison vers lequel AppSignal envoie les logs et les check-ins. Ce paramètre ne devrait pas avoir besoin d’être modifié.

nginx_port

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

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.

ownership_set_namespace

Champ	Valeur
Clé du fichier de configuration	`ownership_set_namespace`
Clé d’environnement système	`APPSIGNAL_OWNERSHIP_SET_NAMESPACE`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`false`
Disponible depuis la version	`4.3.3`

Description

Indique si l’instrumentation du gem Ownership doit définir le namespace d’un échantillon sur son propriétaire, peut être true ou false.

request_headers

Champ	Valeur
Clé du fichier de configuration	`request_headers`
Clé de la variable d’environnement système	`APPSIGNAL_REQUEST_HEADERS`
Obligatoire	non
Type	`Array<String>`
Valeur par défaut	`["HTTP_ACCEPT", "HTTP_ACCEPT_CHARSET", "HTTP_ACCEPT_ENCODING", "HTTP_ACCEPT_LANGUAGE", "HTTP_CACHE_CONTROL", "HTTP_CONNECTION", "CONTENT_LENGTH", "PATH_INFO", "HTTP_RANGE", "REQUEST_METHOD", "REQUEST_PATH", "SERVER_NAME", "SERVER_PORT", "SERVER_PROTOCOL"]`
Disponible depuis la version	`2.6.0`
	`2.6.1` : Une mise à niveau vers cette version ou une version supérieure est recommandée. `3.5.6` : `REQUEST_URI` n’est plus inclus par défaut, c’est `REQUEST_PATH` qui est inclus à la place.

Description

Agent uniquement : lors de l’utilisation d’un collecteur externe, cette option de configuration définit la valeur par défaut des options suivantes et n’a aucun autre effet.En mode collector, nous vous recommandons d’utiliser plutôt les options de configuration suivantes :

keep_request_environment
keep_request_headers

L’option de configuration request_headers contient une liste de clés de l’environnement Rack qui sont lues et stockées par le gem AppSignal pour Ruby. Certaines de ces clés contiennent un en-tête de requête HTTP, et d’autres une valeur qui décrit la requête, comme sa méthode ou l’hôte auquel elle a été envoyée. Cette option de configuration request_headers est une liste d’autorisations, ce qui signifie qu’elle ne signalera que les clés de l’environnement Rack spécifiées par cette option de configuration. Si cette option de configuration n’est pas définie, elle utilisera la valeur par défaut d’AppSignal. Consultez notre guide sur la collecte des en-têtes de requête pour savoir comment Rack nomme la clé d’un en-tête.

Appsignal.configure do |config|
  # Add a request header
  config.request_headers << "PATH_INFO"

  # Remove a request header
  config.request_headers.delete("PATH_INFO")
end

# To add an additional request header it's necessary to list all default headers too
default: &defaults
  request_headers:
    - HTTP_ACCEPT
    - HTTP_ACCEPT_CHARSET
    - HTTP_ACCEPT_ENCODING
    - HTTP_ACCEPT_LANGUAGE
    - HTTP_CACHE_CONTROL
    - HTTP_CONNECTION
    - CONTENT_LENGTH
    - PATH_INFO
    - HTTP_RANGE
    - REQUEST_METHOD
    - REQUEST_PATH
    - SERVER_NAME
    - SERVER_PORT
    - SERVER_PROTOCOL

Rack signale la clé telle que votre application ou framework l’a indiquée. Cela peut ne pas correspondre à ce que le navigateur ou le client a envoyé. Pour configurer AppSignal afin qu’il ne stocke aucun en-tête de requête HTTP dans les transactions AppSignal, configurez l’option avec une liste vide.

Appsignal.configure do |config|
  config.request_headers = []
end

default: &defaults
  request_headers: []

response_headers

Champ	Valeur
Clé du fichier de configuration	`response_headers`
Clé d’environnement système	`APPSIGNAL_RESPONSE_HEADERS`
Requis	non
Type	`list(String)`
Valeur par défaut	`[]`
Disponible depuis la version	`5.0.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 gem AppSignal pour Ruby. Cette option de configuration response_headers est une liste d’autorisations, ce qui signifie qu’elle ne signalera que les en-têtes spécifiés par cette option de configuration. Par défaut, elle ne nomme aucun en-tête, donc aucun en-tête de réponse n’est signalé jusqu’à ce qu’elle en nomme. 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 la variable d’environnement système	`APP_REVISION`
Obligatoire	non
Type	`String`
Valeur par défaut	nil (non définie par défaut)
Disponible depuis la version	`2.6.0`
	`2.6.1` : Une mise à niveau vers cette version ou une version supérieure est recommandée. `2.9.13` : Détection automatique pour les déploiements Heroku avec la fonctionnalité Dyno Metadata labs activée. `2.9.14` : N’utilisez pas cette version si vous dépendez de la détection des métadonnées de dyno Heroku. `3.4.7` : Détection automatique pour les déploiements Render. `3.7.5` : Détection automatique pour les déploiements Kamal. `4.1.3` : Détection automatique pour les déploiements Scalingo. `4.6.0` : Détection automatique pour les déploiements Capistrano. `4.6.0` : Détection automatique pour les déploiements Hatchbox.io. `5.0.2` : Les révisions de Heroku, Render, Kamal et Scalingo sont prioritaires sur le fichier `REVISION`. `5.0.5` : Lit la variable d’environnement `HEROKU_BUILD_COMMIT`.

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. L’intégration AppSignal détecte automatiquement le commit Git déployé et l’utilise comme révision lorsque vous effectuez un déploiement à l’aide des outils ou fournisseurs suivants :

Kamal
Render
Scalingo
Heroku, lorsque la fonctionnalité Heroku Labs: Dyno Metadata est activée

Définissez l’option de configuration revision pour remplacer la révision détectée. Utilisez une valeur unique sans espaces, comme un SHA de commit Git (abc0123) ou un numéro de version (1.2.3). AppSignal construit des liens vers votre code source à partir de cette valeur. Pour en savoir plus, consultez Choisir une valeur de révision. Pour en savoir plus sur les marqueurs de déploiement, consultez le sujet sur les marqueurs de déploiement. Quand plusieurs sources définissent la révision, la gem Ruby utilise la première de cette liste qui est définie :

L’option de configuration revision ou la variable d’environnement APP_REVISION.
La variable d’environnement définie par Heroku (HEROKU_BUILD_COMMIT ou HEROKU_SLUG_COMMIT), Render (RENDER_GIT_COMMIT), Kamal (KAMAL_VERSION) ou Scalingo (CONTAINER_VERSION), dans cet ordre.
Le fichier REVISION dans le répertoire racine de l’application.

running_in_container

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

Description

AppSignal s’attend à être exécuté sur la même machine entre les 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 automatiquement définie sur true sur Heroku.

send_environment_metadata

Champ	Valeur
Clé du fichier de configuration	`send_environment_metadata`
Clé de la 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	`2.11.0`

Description

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

send_function_parameters

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

Description

Indique s’il faut envoyer les paramètres de fonction à AppSignal. Tant que cette option n’est pas définie, sa valeur est dérivée de l’option de configuration send_params.

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 la 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.9.0`
	`1.3.0` : Prise en charge ajoutée pour l’option de variable d’environnement système.

Description

Indique s’il faut ignorer l’envoi des paramètres de requête à AppSignal. Pour plus d’informations, veuillez consulter la documentation sur 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 définit la valeur par défaut des options ci-dessous et n’a pas d’autre effet.Définissez les options de configuration suivantes pour contrôler si les charges utiles de requête, les paramètres de requête et les paramètres de fonction sont envoyés :

send_function_parameters
send_request_payload
send_request_query_parameters

send_request_payload

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

Description

Indique s’il faut envoyer la charge utile de requête à AppSignal. Tant que cette option n’est pas définie, sa valeur est dérivée de l’option de configuration send_params.

send_request_query_parameters

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

Description

Indique s’il faut envoyer les paramètres de requête à AppSignal. Tant que cette option n’est pas définie, sa valeur est dérivée de l’option de configuration send_params.

send_session_data

Champ	Valeur
Clé du fichier de configuration	`send_session_data`
Clé de la 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	`3.0.20`

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 la documentation sur le filtrage des données de session de requête.

service_name

Champ	Valeur
Clé du fichier de configuration	`service_name`
Clé d’environnement système	`APPSIGNAL_SERVICE_NAME`
Requis	non
Type	`String`
Valeur par défaut	“
Disponible depuis la version	`5.0.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 ou authentication-service.

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

sidekiq_report_errors

Champ	Valeur
Clé du fichier de configuration	`sidekiq_report_errors`
Clé de la variable d’environnement système	`APPSIGNAL_SIDEKIQ_REPORT_ERRORS`
Obligatoire	non
Type	`String`
Valeur par défaut	`all`
Disponible depuis la version	`3.9.0`

Description

Configurez le signalement des erreurs qui se produisent dans les jobs Sidekiq. Valeurs acceptées :

all : Signale toutes les erreurs pour chaque exécution de jobs, y compris les nouvelles tentatives.
discard : Signale les erreurs lorsque le job est rejeté en raison de l’erreur. Utilisez cette option pour signaler les erreurs uniquement lorsque toutes les nouvelles tentatives du job ont été épuisées.
none : Ne signale aucune erreur pour les jobs, y compris les nouvelles tentatives. Utile pour le signalement d’erreurs personnalisé.

Remarque : L’option discard ne fonctionne que sur Sidekiq 5.1 et versions ultérieures. Sur les versions antérieures, discard est interprété comme all.

skip_session_data

Champ	Valeur
Clé du fichier de configuration	`skip_session_data`
Clé de la variable d’environnement système	`APPSIGNAL_SKIP_SESSION_DATA`
Obligatoire	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`false`
Disponible depuis la version	`0.11.0`
	`3.0.20` : Déconseillée au profit de `send_session_data`. `4.0.0` : Supprimée du gem. Utilisez plutôt `send_session_data`.

Description

Avertissement : Cette option de configuration a été supprimée dans le gem Ruby 4.0.0. La définir dans le gem Ruby 4.0.0 et les versions plus récentes n’a aucun effet. Utilisez plutôt l’option send_session_data.

statsd_port

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

Description

Définissez cette option pour configurer le port du serveur HTTP StatsD du processus d’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, afin d’éviter les conflits.

transaction_debug_mode

Champ	Valeur
Clé du fichier de configuration	`transaction_debug_mode`
Clé de la variable d’environnement système	`APPSIGNAL_TRANSACTION_DEBUG_MODE`
Obligatoire	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`false`
Disponible depuis la version	`2.9.18`
	`3.0.16` : Déconseillée au profit de l’option de configuration `log_level`. `4.0.0` : Supprimée du gem. Utilisez plutôt l’option de configuration `log_level`.

Description

Avertissement : Cette option de configuration a été supprimée dans le gem Ruby 4.0.0. La définir dans le gem Ruby 4.0.0 ou une version ultérieure n’a aucun effet. Veuillez utiliser l’option log_level à la place.

Active le mode débogage des transactions. Cela active une journalisation très détaillée des transactions et des événements, ce qui est utile lors du développement d’intégrations ou lorsque les événements ne sont pas suivis comme prévu. Le journal n’est écrit que si l’option générale debug est également activée.

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

working_dir_path

Champ	Valeur
Clé du fichier de configuration	`working_dir_path`
Clé de la variable d’environnement système	`APPSIGNAL_WORKING_DIR_PATH`
Obligatoire	non
Type	`String`
Valeur par défaut	détectée par l’agent

Description

Avertissement : Cette option de configuration a été supprimée dans le gem Ruby 4.0.0. La définir dans le gem Ruby 4.0.0 et les versions ultérieures n’a aucun effet. Utilisez plutôt l’option working_directory_path.

Remplace l’emplacement où AppSignal pour Ruby crée un répertoire de travail. Consultez working_directory_path pour connaître le comportement applicable. Cette option de configuration ajoute /appsignal au chemin spécifié, alors que working_directory_path ne le fait pas.

Remarque : 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 du répertoire personnel ~ pour les systèmes *NIX. Cela sera considéré comme un chemin mal formé.

working_directory_path

Champ	Valeur
Clé du fichier de configuration	`working_directory_path`
Clé de la variable d’environnement système	`APPSIGNAL_WORKING_DIRECTORY_PATH`
Obligatoire	non
Type	`String`
Valeur par défaut	détectée par l’agent
Disponible depuis la version	`2.7.0`
	`2.10.12` : Prise en charge ajoutée pour l’option de variable d’environnement système. `2.7.0` : Renommée depuis `working_dir_path`.

Description

Remplace l’emplacement où AppSignal pour Ruby peut stocker des fichiers temporaires. Utilisez cette option si l’emplacement par défaut ne convient pas. Consultez notre page comment AppSignal fonctionne pour plus d’informations sur le rôle 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 des répertoires de travail différents pour chaque instance 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.

Appsignal.configure do |config|
  config.working_directory_path = "/tmp/project_1/"
end

default: &defaults
  working_directory_path: "/tmp/project_1/"

⌘I

​Options disponibles

​active

​Description

​APPSIGNAL_APP_ENV

​Description

​Environnements personnalisés dans le fichier de configuration

​name

​Description

​push_api_key

​Description

​activejob_report_errors

​Description

​bind_address

​Description

​ca_file_path

​Description

​collector_endpoint

​Description

​cpu_count

​Description

​debug

​Description

​default_tags

​Description

​dns_servers

​Description

​enable_active_support_event_log_reporter

​Description

​enable_allocation_tracking

​Description

​enable_at_exit_hook

​Description

​enable_at_exit_reporter

​Description

​enable_frontend_error_catching

​Description

​enable_gvl_global_timer

​Description

​enable_gvl_waiting_threads

​Description

​enable_host_metrics

​Description

​enable_job_enqueue_instrumentation

​Description

​enable_minutely_probes

​Description

​enable_nginx_metrics

​Description

​enable_rails_error_reporter

​Description

​enable_rake_performance_instrumentation

​Description

​enable_statsd

​Description

​endpoint

​Description

​files_world_accessible

​Description

​filter_attributes

​Description

​filter_function_parameters

​Description

​filter_metadata

​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

Options disponibles

active

Description

APPSIGNAL_APP_ENV

Description

Environnements personnalisés dans le fichier de configuration

name

Description

push_api_key

Description

activejob_report_errors

Description

bind_address

Description

ca_file_path

Description

collector_endpoint

Description

cpu_count

Description

debug

Description

default_tags

Description

dns_servers

Description

enable_active_support_event_log_reporter

Description

enable_allocation_tracking

Description

enable_at_exit_hook

Description

enable_at_exit_reporter

Description

enable_frontend_error_catching

Description

enable_gvl_global_timer

Description

enable_gvl_waiting_threads

Description

enable_host_metrics

Description

enable_job_enqueue_instrumentation

Description

enable_minutely_probes

Description

enable_nginx_metrics

Description

enable_rails_error_reporter

Description

enable_rake_performance_instrumentation

Description

enable_statsd

Description

endpoint

Description

files_world_accessible

Description

filter_attributes

Description

filter_function_parameters

Description

filter_metadata

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