> ## Documentation Index > Fetch the complete documentation index at: https://docs.appsignal.com/llms.txt > Use this file to discover all available pages before exploring further. # 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 rubrique [Configuration](/ruby/configuration). ## Options disponibles * Options requises * [`active`](#option-active) * [`APPSIGNAL_APP_ENV`](#option-appsignal_app_env) * [`name`](#option-name) * [`push_api_key`](#option-push_api_key) * Options * [`activejob_report_errors`](#option-activejob_report_errors) * [`bind_address`](#option-bind_address) * [`ca_file_path`](#option-ca_file_path) * [`cpu_count`](#option-cpu_count) * [`debug`](#option-debug) * [`default_tags`](#option-default_tags) * [`dns_servers`](#option-dns_servers) * [`enable_active_support_event_log_reporter`](#option-enable_active_support_event_log_reporter) * [`enable_allocation_tracking`](#option-enable_allocation_tracking) * [`enable_at_exit_hook`](#option-enable_at_exit_hook) * [`enable_at_exit_reporter`](#option-enable_at_exit_reporter) * [`enable_frontend_error_catching`](#option-enable_frontend_error_catching) * [`enable_gvl_global_timer`](#option-enable_gvl_global_timer) * [`enable_gvl_waiting_threads`](#option-enable_gvl_waiting_threads) * [`enable_host_metrics`](#option-enable_host_metrics) * [`enable_minutely_probes`](#option-enable_minutely_probes) * [`enable_nginx_metrics`](#option-enable_nginx_metrics) * [`enable_rails_error_reporter`](#option-enable_rails_error_reporter) * [`enable_rake_performance_instrumentation`](#option-enable_rake_performance_instrumentation) * [`enable_statsd`](#option-enable_statsd) * [`endpoint`](#option-endpoint) * [`files_world_accessible`](#option-files_world_accessible) * [`filter_metadata`](#option-filter_metadata) * [`filter_parameters`](#option-filter_parameters) * [`filter_session_data`](#option-filter_session_data) * [`host_role`](#option-host_role) * [`hostname`](#option-hostname) * [`http_proxy`](#option-http_proxy) * [`ignore_actions`](#option-ignore_actions) * [`ignore_errors`](#option-ignore_errors) * [`ignore_logs`](#option-ignore_logs) * [`ignore_namespaces`](#option-ignore_namespaces) * [`instrument_code_ownership`](#option-instrument_code_ownership) * [`instrument_http_rb`](#option-instrument_http_rb) * [`instrument_net_http`](#option-instrument_net_http) * [`instrument_ownership`](#option-instrument_ownership) * [`instrument_redis`](#option-instrument_redis) * [`instrument_sequel`](#option-instrument_sequel) * [`log`](#option-log) * [`log_level`](#option-log_level) * [`log_path`](#option-log_path) * [`nginx_port`](#option-nginx_port) * [`ownership_set_namespace`](#option-ownership_set_namespace) * [`request_headers`](#option-request_headers) * [`revision`](#option-revision) * [`running_in_container`](#option-running_in_container) * [`send_environment_metadata`](#option-send_environment_metadata) * [`send_params`](#option-send_params) * [`send_session_data`](#option-send_session_data) * [`sidekiq_report_errors`](#option-sidekiq_report_errors) * [`skip_session_data`](#option-skip_session_data) * [`statsd_port`](#option-statsd_port) * [`transaction_debug_mode`](#option-transaction_debug_mode) * [`working_dir_path`](#option-working_dir_path) * [`working_directory_path`](#option-working_directory_path) ## 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` | | | | ### Description **Note** : Lorsque la variable d'environnement [`APPSIGNAL_PUSH_API_KEY`](#option-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](/ruby/configuration) 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` | | | | ### 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`. ```sh Shell theme={null} export APPSIGNAL_APP_ENV=staging rackup ``` Cette option sera utilisée pour charger la configuration à partir des [fichiers de configuration](/ruby/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. ```sh Shell theme={null} heroku config:set APPSIGNAL_APP_ENV=staging ``` Si l'environnement est défini à l'aide de l'[assistant `Appsignal.configure`](/ruby/configuration/load-order#configure-helper), il remplacera la variable d'environnement `APPSIGNAL_APP_ENV`. **Note** : Modifier le [nom](#option-name) 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](/ruby/instrumentation/integrating-appsignal#configuration-file).

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 YAML theme={null} # 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`](/ruby/configuration#ruby-configuration-file). **Note** : Modifier le [nom](#option-name) 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](#option-env) 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](/appsignal/terminology#push-api-key). **Remarque** : Lorsque la variable d'environnement système [`APPSIGNAL_PUSH_API_KEY`](#option-push_api_key) est définie, l'option [`active`](#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`](#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` | | | | ### Description Configurez le signalement des erreurs qui se produisent dans les jobs [Active Job](/ruby/integrations/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](#option-enable_statsd), [OpenTelemetry](#option-enable_opentelemetry_http) et [NGINX](#option-enable_nginx_metrics)). ## 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](https://github.com/appsignal/appsignal-ruby/blob/4eed259e122d10df66655098ad0aa8a362f3297d/resources/cacert.pem) 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é. ## 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` | | | | ### Description **Avertissement** : Cette option de configuration est dépréciée dans le gem Ruby 3.0.16. Veuillez utiliser l'option [`log_level`](#option-log_level) à la place pour le gem Ruby 3.0.16 et versions ultérieures. 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](/logging). ## 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 | undefined | | 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`](/guides/tagging#ruby) remplaceront les tags par défaut ayant la même clé. ```ruby title="config/appsignal.rb" theme={null} Appsignal.configure do |config| config.default_tags = { "region" => "europe", "shard" => "shard-1" } end ``` ```yaml title="config/appsignal.yml" theme={null} 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. ```bash Shell theme={null} 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](/guides/tagging). ## dns\_servers | Champ | Valeur | | ------------------------------- | ------------------------------------------------------------------------------------------- | | Clé du fichier de configuration | `dns_servers` | | Clé d'environnement système | `APPSIGNAL_DNS_SERVERS` | | Requis | non | | Type | `Array` | | Valeur par défaut | `[]` | | Disponible depuis la version | `2.2.0.beta.1` | | | | ### Description Configurez les serveurs DNS à utiliser par l'agent AppSignal. ```ruby title="config/appsignal.rb" theme={null} Appsignal.configure do |config| config.dns_servers = ["8.8.8.8", "8.8.4.4"] end ``` ```yaml title="config/appsignal.yml" theme={null} default: &defaults dns_servers: - 8.8.8.8 - 8.8.4.4 ``` ```sh title="Environment variables" theme={null} # 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](/support/known-issues#dns-timeouts), 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 | `true` | | Disponible depuis la version | `4.8.0` | ### Description Active l'intégration de [rapport d'événements structurés](https://edgeapi.rubyonrails.org/classes/ActiveSupport/EventReporter.html) `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](/ruby/instrumentation/background-jobs). ## 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 Ruby theme={null} 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` | | | | ### 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`](#option-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](/ruby/integrations/global-vm-lock#waiting-threads). 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](/ruby/integrations/global-vm-lock#waiting-threads). 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](/metrics/host-metrics). 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](/heroku/host-metrics). ## 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` | | | | ### Description Active le système de [sondes à la minute](/ruby/instrumentation/minutely-probes). ## 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.](/metrics/nginx) 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.](/ruby/integrations/rails) ## 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](/ruby/integrations/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](/standalone-agent/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` | | | | ### 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](/appsignal/how-appsignal-operates#working-directory) 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\_metadata | Champ | Valeur | | ------------------------------- | --------------------------- | | Clé du fichier de configuration | `filter_metadata` | | Clé d'environnement système | `APPSIGNAL_FILTER_METADATA` | | Requis | non | | Type | `Array` | | 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 dans les échantillons, 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. ```ruby title="config/appsignal.rb" theme={null} Appsignal.configure do |config| config.filter_metadata += ["path", "request_id"] end ``` ```yaml title="config/appsignal.yml" theme={null} 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` | | Valeur par défaut | `[]` | | Disponible depuis la version | `1.3.0` | | | | ### 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. ```ruby title="config/appsignal.rb" theme={null} Appsignal.configure do |config| config.filter_parameters += ["password", "email", "api_token", "token"] end ``` ```yaml YAML theme={null} # config/appsignal.yml default: &defaults filter_parameters: - password - email - api_token - token ``` En savoir plus sur le [filtrage des paramètres](/application/parameter-filtering). ## 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` | | Valeur par défaut | `[]` | | Disponible depuis la version | `2.6.0` | | | | ### 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. ```ruby title="config/appsignal.rb" theme={null} Appsignal.configure do |config| config.filter_session_data += ["name", "email", "api_token", "token"] end ``` ```yaml YAML theme={null} # config/appsignal.yml default: &defaults filter_session_data: - name - email - api_token - token ``` En savoir plus sur le [filtrage des données de session](/application/session-data-filtering). ## 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` | | 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](/guides/filter-data/ignore-actions). ## ignore\_errors | Champ | Valeur | | ------------------------------- | ------------------------- | | Clé du fichier de configuration | `ignore_errors` | | Clé d'environnement système | `APPSIGNAL_IGNORE_ERRORS` | | Requis | non | | Type | `Array` | | 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](/guides/filter-data/ignore-errors). ## ignore\_logs | Champ | Valeur | | ------------------------------- | ----------------------- | | Clé du fichier de configuration | `ignore_logs` | | Clé d'environnement système | `APPSIGNAL_IGNORE_LOGS` | | Requis | non | | Type | `Array` | | 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](/guides/filter-data/ignore-logs). ## ignore\_namespaces | Champ | Valeur | | ------------------------------- | ----------------------------- | | Clé du fichier de configuration | `ignore_namespaces` | | Clé d'environnement système | `APPSIGNAL_IGNORE_NAMESPACES` | | Requis | non | | Type | `Array` | | 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](/application/namespaces). ## 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](/ruby/integrations/code-ownership), peut être `true` ou `false`. ## 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](https://github.com/httprb/http). 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](/ruby/integrations/ownership), peut être `true` ou `false`. ## 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](https://rubygems.org/gems/redis), peut être `true` ou `false`. ## 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](/ruby/integrations/sequel), peut être `true` ou `false`. ## 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](/logging). **Remarque** : L'[agent AppSignal](/appsignal/how-appsignal-operates), 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](https://heroku.com)) * 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](/logging). 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](/logging).
**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. ## 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](/ruby/integrations/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` | | 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` | | | | ### 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 gem AppSignal pour Ruby. Cette option de configuration `request_headers` est une *liste d'autorisation*, ce qui signifie qu'elle ne prendra en compte que les en-têtes spécifiés par cette option. Si cette option de configuration n'est pas définie, la valeur par défaut d'AppSignal sera utilisée. ```ruby title="config/appsignal.rb" theme={null} Appsignal.configure do |config| # Add a request header config.request_headers << "PATH_INFO" # Remove a request header config.request_headers.delete("PATH_INFO") end ``` ```yaml title="config/appsignal.yml" theme={null} # 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 ``` Notez qu'AppSignal lit les en-têtes depuis votre application et qu'ils peuvent ne pas correspondre exactement à ce qui est envoyé dans le navigateur/client. Dans les [applications Rack](https://rack.github.io/) ([Rails](/ruby/integrations/rails), [Sinatra](/ruby/integrations/sinatra), etc.), tous les en-têtes personnalisés sont préfixés par la chaîne `HTTP_`, tous les noms d'en-têtes sont en majuscules et les tirets (`-`) sont remplacés par des tirets bas (`_`). Par exemple, l'en-tête `X-Hub-Signature` peut être accédé par votre application et par AppSignal avec le nom `HTTP_X_HUB_SIGNATURE`. Pour configurer AppSignal de manière à ne stocker aucun en-tête de requête HTTP dans les transactions AppSignal, configurez l'option avec un tableau vide. ```ruby title="config/appsignal.rb" theme={null} Appsignal.configure do |config| config.request_headers = [] end ``` ```yaml title="config/appsignal.yml" theme={null} default: &defaults request_headers: [] ``` ## 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` | | | | ### 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](https://devcenter.heroku.com/articles/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 détectées automatiquement dans Heroku, Render ou Kamal en définissant manuellement l'option de configuration `revision` sur une valeur personnalisée. Pour en savoir plus sur les marqueurs de déploiement, consultez le [sujet sur les marqueurs de déploiement](/application/markers/deploy-markers). ## 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` | | | | ### 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](mailto:support@appsignal.com). Cette option est automatiquement définie sur `true` sur [Heroku](http://heroku.com/). ## 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](/application/environment-metadata). ## 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` | | | | ### 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](/application/parameter-filtering) dans le filtrage des paramètres de requête. ## 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](/application/session-data-filtering). ## 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](/ruby/integrations/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` | | | | ### Description **Avertissement** : Cette option de configuration est déconseillée dans le gem Ruby 3.0.20. Veuillez utiliser l'option [`send_session_data`](#option-send_session_data) à la place pour les versions plus récentes du gem Ruby. ## 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` | | | | ### Description **Avertissement** : Cette option de configuration est déconseillée dans le gem Ruby 3.0.16. Veuillez utiliser l'option [`log_level`](#option-log_level) à la place pour le gem Ruby 3.0.16 et versions ultérieures. 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](/logging). ## 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 est déconseillée dans le gem Ruby 2.7.0. Veuillez utiliser l'option [`working_directory_path`](#option-working_directory_path) à la place pour le gem Ruby 2.7.0 et versions ultérieures. Remplace l'emplacement où AppSignal pour Ruby crée un répertoire de travail. Consultez [`working_directory_path`](#appsignal_working_directory_path-working_directory_path) pour connaître le comportement applicable. Cette option de configuration ajoute `/appsignal` au chemin spécifié, alors que [`working_directory_path`](#appsignal_working_directory_path-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` | | | | ### 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](/appsignal/how-appsignal-operates) 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](/guides/application/multiple-applications-on-one-host). ```ruby title="config/appsignal.rb" theme={null} Appsignal.configure do |config| config.working_directory_path = "/tmp/project_1/" end ``` ```yaml title="config/appsignal.yml" theme={null} default: &defaults working_directory_path: "/tmp/project_1/" ``` **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é.