Vous pouvez configurer l'agent Ruby New Relic avec des paramètres dans un fichier de configuration, des variables d'environnement ou par programmation avec une configuration côté serveur. Ce document résume les options de configuration disponibles pour l'agent Ruby.
Si la valeur par défaut d'une option de configuration est (Dynamic)
, cela signifie que l'agent Ruby calcule la valeur par défaut au moment de l'exécution. La valeur du paramètre de configuration par défaut correspond à la valeur d'un autre paramètre, le cas échéant.
Méthodes de configuration et priorité
La méthode principale (par défaut) pour configurer l'agent Ruby s'effectue via le fichier de configuration (newrelic.yml
) dans le sous-répertoire config
. Pour définir les valeurs de configuration à l’aide de variables d’environnement :
- Ajoutez le préfixe
NEW_RELIC_
au nom du paramètre. - Remplacez tous les points
.
par des traits de soulignement_
.
Vous pouvez également configurer quelques valeurs dans l'UI via configuration côté serveur.
L'agent Ruby suit cet ordre de priorité pour la configuration :
- Variables d'environnement
- Configuration côté serveur
- Fichier de configuration (
newrelic.yml
) - Paramètres de configuration par défaut
En d'autres termes, les variables d'environnement remplacent tous les autres paramètres et informations de configuration, la configuration côté serveur remplace le fichier de configuration et les paramètres de configuration par défaut, et ainsi de suite.
Afficher et modifier les options du fichier de configuration
Le newrelic.yml
de l'agent Ruby est un fichier de configuration YAML standard. Il comprend généralement une section Defaults
en haut, ainsi que des sections en dessous pour chaque environnement d'application (Development
, Test
, Staging
et Production
).
L'agent Ruby détermine la section du fichier de configuration newrelic.yml
à lire en examinant certaines variables d'environnement pour dériver l'environnement de l'application. Cela peut être utile lorsque vous souhaitez utiliser info
pour le paramètre de configuration log_level
dans votre environnement de production et que vous souhaitez des paramètres de configuration log_level
plus détaillés (tels que debug
) dans votre environnement de développement.
Voici un exemple de fichier de configuration newrelic.yml
:
common: &default_settings license_key: 'YOUR_LICENSE_KEY' app_name: 'My Application Name'production: <<: *default_settings log_level: infodevelopment: <<: *default_settings log_level: debug
L'agent Ruby recherche les variables d'environnement suivantes, dans cet ordre, pour trouver l'environnement de l'application :
NEW_RELIC_ENV
RUBY_ENV
RAILS_ENV
APP_ENV
RACK_ENV
Si l'agent Ruby ne détecte aucune valeur pour aucune de ces variables d'environnement, il définira par défaut l'environnement d'application sur development
et lira à partir de la section development
du fichier de configuration newrelic.yml
.
Lors de l'exécution de l'agent Ruby dans une application Rails, l'agent recherche d'abord la variable d'environnement NEW_RELIC_ENV
pour trouver l'environnement de l'application et la section de newrelic.yml
à utiliser. Si NEW_RELIC_ENV
n'est pas présent, l'agent utilise l'environnement Rails (RAILS_ENV
).
Lorsque vous modifiez le fichier de configuration, assurez-vous de :
- Indenter uniquement avec deux espaces.
- Indentez uniquement si cela est pertinent, dans des sections telles que
error_collector
.
Si vous n'effectuez pas l'indentation correctement, l'agent peut générer une erreur Unable to parse configuration file
au démarrage.
Pour afficher la liste la plus récente des options de configuration de l'agent Ruby disponibles, utilisez la commande rake newrelic:config:docs
. Ce document décrit les options les plus courantes.
Mettre à jour le fichier de configuration
Cette documentation s'applique à la dernière sortie de l'agent Ruby . Pour plus de détails sur les versions antérieures, reportez-vous aux commentaires dans newrelic.yml
lui-même.
Pour mettre à jour le fichier newrelic.yml
après une nouvelle sortie, utilisez le modèle dans le répertoire de base du gem agent. Lorsque vous effectuez une mise à jour vers de nouvelles versions de gems, examinez ou comparez config/newrelic.yml
et newrelic.yml
dans le répertoire d'installation pour profiter des nouvelles options de configuration.
Important
La mise à jour de la gem ne met pas automatiquement à jour config/newrelic.yml
.
Général
Ces paramètres sont disponibles pour la configuration de l'agent. Certains paramètres dépendent de votre niveau d'abonnement New Relic.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, autorise l'exécution de l'agent Ruby.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Spécifiez le nom de l’application utilisée pour agréger les données dans l’ UI New Relic. Pour signaler des données à plusieurs applications en même temps, spécifiez une liste de noms séparés par un point-virgule ;
. Par exemple, MyApp
ou MyStagingApp;Instance1
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Votre New Relic .
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Définit le niveau de détail du message de log. Les niveaux de log possibles, par verbosité croissante, sont : error
, warn
, info
ou debug
.
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Une gamme de noms d'événements ActiveSupport personnalisés auxquels s'abonner et instrument. Par exemple,
- one.custom.event
- another.event
- a.third.event
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Votre New Relic . Obligatoire lors de l'utilisation de l'API New Relic REST v2 pour enregistrer le déploiement à l'aide de la commande newrelic deployments
.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Rétroporte la recherche de connexion ActiveRecord plus rapide introduite dans Rails 6, qui améliore les performances de l'agent lors de l'instrumentation d'ActiveRecord. Notez que ce paramètre peut ne pas être compatible avec d'autres gems qui corrigent ActiveRecord.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Remplacement manuel du chemin d'accès à votre bundle CA local. Ce bundle CA valide le certificat SSL présenté par le service de collecte de données de New Relic.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Activer ou désactiver la capture des clés memcache à partir de la trace de transaction.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Lorsque true
, l'agent capture les paramètres de requête HTTP et les attache à la trace de transaction, à la trace des erreurs et à l'événementTransactionError
.
Prudence
Lorsque vous utilisez le paramètre capture_params
, l'agent Ruby ne tentera pas de filtrer les informations secrètes. Recommendation:
Pour filtrer les informations secrètes des paramètres de demande, utilisez plutôt le paramètreattributes.include
. Pour plus d'informations, consultez les exemples d'attributsRuby .
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent effacera Tracer::State
dans Agent.drop_buffered_data
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Chemin vers newrelic.yml
. Si indéfini, l'agent vérifie les répertoires suivants (dans l'ordre) :
config/newrelic.yml
newrelic.yml
$HOME/.newrelic/newrelic.yml
$HOME/newrelic.yml
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Permet de supprimer les en-têtes de tracing distribué Newrelic sur requests sortantes.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Le gestionnaire de sortie qui envoie toutes les données mises en cache au collecteur avant l'arrêt est installé de force. Cela est vrai même lorsqu’il détecte des scénarios dans lesquels il ne devrait généralement pas l’être. Le cas d'utilisation connu de cette option est lorsque Sinatra s'exécute en tant que service intégré dans un autre framework. L'agent détecte l'application Sinatra et ignore le gestionnaire at_exit
en conséquence. Sinatra exécute classiquement l'intégralité de l'application dans un bloc at_exit
et se comporterait autrement mal si le gestionnaire at_exit
de l'agent était également installé dans ces circonstances. Remarque : send_data_on_exit
doit également être défini sur true
en tandem avec ce paramètre.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, active le mode haute sécurité. Assurez-vous de comprendre les implications du mode haute sécurité avant d'activer ce paramètre.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Un dictionnaire de noms d’étiquettes et de valeurs qui seront appliqués aux données envoyées par cet agent. Peut également être exprimé sous la forme d'une chaîne ;
délimitée par des points-virgules et composée de paires :
séparées par des deux-points. Par exemple, Server:One;Data Center:Primary
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Définit un nom pour le fichier de log.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Définit un chemin vers le fichier de log de l'agent, excluant le nom de fichier.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Spécifie un marshaller pour transmettre des données au collecteur New Relic. Actuellement, json
est la seule valeur valide pour ce paramètre.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Lorsque true
, l'agent transmet des données sur votre application au collecteur New Relic.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, utilise Module#prepend
plutôt que alias_method
pour l'instrumentation ActiveRecord.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Définit un hôte pour communiquer avec le collecteur New Relic via un serveur proxy.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Définit un mot de passe pour communiquer avec le collecteur New Relic via un serveur proxy.
Type | Entier |
---|---|
Défaut |
|
Variable d'environnement |
|
Définit un port pour communiquer avec le collecteur New Relic via un serveur proxy.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Définit un utilisateur pour communiquer avec le collecteur New Relic via un serveur proxy.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Applique les paramètres de la politique de sécurité de l'agent linguistique.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, active le gestionnaire de sortie qui envoie des données au collecteur New Relic avant l'arrêt.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Lorsqu'il est défini sur true
, force une connexion synchrone au collecteur New Relic lors du démarrage de l'application. Pour les processus de très courte durée, cela permet de garantir que l'agent New Relic a le temps de signaler.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, le stockage de l'état du traceur est local au thread, sinon, local à la fibre
Type | Entier |
---|---|
Défaut |
|
Variable d'environnement |
|
Définit le nombre maximal de secondes que l'agent doit passer à tenter de se connecter au collecteur.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, active la capture de tous les en-têtes de requête HTTP pour toutes les destinations.
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Un éventail de chaînes CLASS#METHOD
(pour les méthodes instance ) et/ou CLASS.METHOD
(pour les méthodes de classe) représentant des méthodes Ruby auxquelles l'agent peut automatiquement ajouter instrumentation personnalisée. Cela ne nécessite aucune modification du code source qui définit les méthodes.
Utilisez des noms de classe entièrement qualifiés (en utilisant le délimiteur ::
) qui incluent tout espace de noms de module ou de classe.
Voici une source de code Ruby qui définit une méthode d'instance render_png
pour une classe Image
et une méthode de classe notify
pour une classe User
, toutes deux dans un espace de nommage de module MyCompany
:
module MyCompany class Image def render_png # code to render a PNG end end
class User def self.notify # code to notify users end end end
Étant donné le code source, le fichier de configuration newrelic.yml
peut demander une instrumentation pour ces deux méthodes comme suit :
automatic_custom_instrumentation_method_list: - MyCompany::Image#render_png - MyCompany::User.notify
Cet exemple configuration utilise la syntaxe éventail YAML pour spécifier les deux méthodes. Alternativement, vous pouvez utiliser une chaîne délimitée par des virgules :
automatic_custom_instrumentation_method_list: 'MyCompany::Image#render_png, MyCompany::User.notify'
Les espaces autour des virgules dans la liste sont facultatifs. Lors de la configuration de l'agent avec une liste de méthodes via la variable d'environnement NEW_RELIC_AUTOMATIC_CUSTOM_INSTRUMENTATION_METHOD_LIST
, utilisez ce format de chaîne délimitée par des virgules :
$export NEW_RELIC_AUTOMATIC_CUSTOM_INSTRUMENTATION_METHOD_LIST='MyCompany::Image#render_png, MyCompany::User.notify'
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, lorsque l'agent est dans une application utilisant Ruby on Rails, il démarrera après l'exécution de config/initializers
.
Prudence
Cette option ne peut être définie que par une variable d'environnement.
Traceur de transaction
La fonctionnalité de trace de transaction collecte des informations détaillées à partir d'une sélection de transactions, y compris un résumé de la séquence d'appel, une répartition du temps passé et une liste des requêtes SQL et de leurs plans de requête (sur MySQL et postgresql). Les fonctionnalités disponibles dépendent de votre niveau d’abonnement New Relic.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, permet la collecte de la trace de transaction.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, active la collecte des plans explicatifs dans la trace de transaction. Ce paramètre s'appliquera également pour expliquer les plans dans la trace SQL lente si slow_sql.explain_enabled
n'est pas défini séparément.
Type | Virgule flottante |
---|---|
Défaut |
|
Variable d'environnement |
|
seuil (en secondes) au-delà duquel l'agent devra collecter les plans explicatifs. Pertinent uniquement lorsque explain_enabled
est vrai.
Type | Entier |
---|---|
Défaut |
|
Variable d'environnement |
|
Nombre maximal de nœuds de trace de transaction à enregistrer dans une seule trace de transaction.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent enregistre les arguments de commande Redis dans la trace de transaction.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Niveau d'obfuscation pour la requête SQL signalé dans les nœuds de trace de transaction. Par défaut, cette valeur est définie sur obfuscated
, ce qui supprime les littéraux numériques et de chaîne.
- Si vous ne souhaitez pas que l'agent capture les informations de requête, définissez cette valeur sur
none
. - Si vous souhaitez que l'agent capture toutes les informations de requête dans leur forme d'origine, définissez cette valeur sur
raw
. - Lorsque vous activez le mode haute sécurité, celui-ci est automatiquement défini sur
obfuscated
.
Type | Virgule flottante |
---|---|
Défaut |
|
Variable d'environnement |
|
Spécifiez un seuil en secondes. L'agent inclut la trace d'appels dans les nœuds trace de transaction lorsque la durée de trace d'appels dépasse ce seuil.
Type | Virgule flottante |
---|---|
Défaut |
|
Variable d'environnement |
|
Spécifiez un seuil en secondes. Les transactions dont la durée est supérieure à ce seuil sont éligibles à la trace de transaction. Spécifiez une valeur flottante ou la chaîne apdex_f
.
Collectord'erreurs
Par défaut, l'agent collecte et signale toutes les exceptions non détectées. Ces options de configuration vous permettent de personnaliser la collecte des erreurs.
Pour plus d'informations sur les erreurs ignorées et les erreurs attendues, consultez cette page sur l'analyse des erreurs dans APM. Pour définir l'erreur attendue via la méthode Ruby NewRelic::Agent.notice_error
, consultez l'API de l'agent Ruby.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent collecte TransactionError
événement.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent capture les erreurs de trace et les métriques de nombre d'erreurs.
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Une liste de classes d’erreurs que l’agent doit traiter comme prévu.
Prudence
Cette option ne peut pas être définie via une variable d'environnement.
Type | hacher |
---|---|
Défaut |
|
Variable d'environnement |
|
Une carte des classes d'erreur vers une liste de messages. Lorsqu'une erreur d'une des classes spécifiées ici se produit, si son message d'erreur contient l'une des chaînes lui correspondant ici, cette erreur sera traitée comme prévu.
Prudence
Cette option ne peut pas être définie via une variable d'environnement.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Une liste de codes d'état séparés par des virgules, incluant éventuellement des plages. Les erreurs associées à ces codes d’état, le cas échéant, seront traitées comme prévu.
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Une liste de classes d’erreurs que l’agent doit ignorer.
Prudence
Cette option ne peut pas être définie via une variable d'environnement.
Type | hacher |
---|---|
Défaut |
|
Variable d'environnement |
|
Une carte des classes d'erreur vers une liste de messages. Lorsqu'une erreur d'une des classes spécifiées ici se produit, si son message d'erreur contient l'une des chaînes lui correspondant ici, cette erreur sera ignorée.
Prudence
Cette option ne peut pas être définie via une variable d'environnement.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Une liste de codes d'état séparés par des virgules, incluant éventuellement des plages. Les erreurs associées à ces codes d’état, le cas échéant, seront ignorées.
Type | Entier |
---|---|
Défaut |
|
Variable d'environnement |
|
Définit le nombre maximal d'images dans une trace d'erreur. Les backtraces supérieures à ce montant sont tronquées au milieu, préservant le début et la fin de la trace d'appels.
Type | Entier |
---|---|
Défaut |
|
Variable d'environnement |
|
Définit le nombre maximum de TransactionError
événements signalés par cycle de collecte.
Monitoring de navigateurs
La fonctionnalitéde synchronisation de chargement des pages (parfois appelée monitoring des utilisateurs réels ou RUM) vous donne des informations détaillées sur les performances des utilisateurs réels avec votre site Web. Cela se fait en mesurant le temps qu'il faut au navigateur de votre utilisateur pour télécharger et restituer vos pages Web en injectant une petite quantité de code JavaScript dans l'en-tête et le pied de page de chaque page.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, active l'auto-injection de l'en-tête JavaScript pour le temps de chargement de la page (parfois appelé monitoring des utilisateurs réels ou RUM).
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, activeinjection automatique du Nonce de la politique de sécurité du contenu dans le script monitoring des navigateurs. Pour l'instant, l'injection automatique ne fonctionne qu'avec Rails 5.2+.
Événement de transaction
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, active l'échantillonnage des événements de transaction.
Type | Entier |
---|---|
Défaut |
|
Variable d'environnement |
|
Définit le nombre maximal d'événements de transaction signalés à partir d'une seule récolte.
Logging des applications
L'agent Ruby prend en charge les logs APM dans ce contexte. Pour quelques conseils sur la configuration du log pour l'agent Ruby , voir Configurer les logs Ruby en contexte.
Les options de configuration liées au logging disponibles incluent :
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, active la décoration log et la collecte des événements de log et des métriques.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent capture les enregistrements log émistre par votre application.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Définit le niveau minimum qu'un événement de log doit avoir pour être transmis à New Relic.
Ceci est basé sur les valeurs entières des constantes Logger::Severity
de Ruby.
L'intention est de transmettre le log avec le niveau donné à la configuration, ainsi que tout log avec un niveau de gravité plus élevé.
Par exemple, définir cette valeur sur « debug » transmettra tous les événements de log à New Relic. La définition de cette valeur sur « erreur » ne transmettra que les événements de log avec les niveaux « erreur », « fatal » et « inconnu ».
Valeurs valides (classées du plus bas au plus haut) :
- "déboguer"
- "infos"
- "avertir"
- "erreur"
- "fatal"
- "inconnu"
Type | hacher |
---|---|
Défaut |
|
Variable d'environnement |
|
Un hacher avec des paires de valeurs clés à ajouter comme attribut personnalisé à tout événement de log transmis à New Relic. Si vous envoyez à l'aide d'une variable d'environnement, la valeur doit être formatée comme suit : « key1=value1,key2=value2 »
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent attache des étiquettes aux log log.
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Un éventail insensible à la casse ou une chaîne délimitée par des virgules contenant les étiquettes à exclure des enregistrements log .
Type | Entier |
---|---|
Défaut |
|
Variable d'environnement |
|
Définit le nombre maximal d'enregistrements log à mettre en mémoire tampon à la fois.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent décore le log avec des métadonnées pour créer un lien vers l'entité, les hôtes, la trace et les spans.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent capture les métriques liées au logging de votre application.
Monitoring de l'IA
Cette section comprend la configuration de l'agent Ruby pour la mise en place monitoring de l'IA.
Important
Vous devez activer le tracing distribué pour capturer les données trace et de commentaires. Il est activé par défaut dans les agents Ruby 8.0.0 et supérieurs.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si false
, toute instrumentation LLM (OpenAI uniquement pour l'instant) sera désactivée et aucune métrique, événement ou étendue ne sera envoyé. Le monitoring de l'IA est automatiquement désactivée si le mode high_security
est activé.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si false
, instrumentation LLM (OpenAI uniquement pour l'instant) ne capturera pas le contenu d'entrée et de sortie sur un événement LLM spécifique.
Les attributs exclus incluent :
content
de LlmChatCompletionMessage événementinput
de l'événement LlmEmbeddingIl s'agit d'un paramètre de sécurité facultatif pour empêcher l'enregistrement des données sensibles envoyées et reçues par vos LLM.
Attributs
Les attributs sont des paires valeur clé contenant des informations qui déterminent les propriétés d'un événement ou d'une transaction. Ces paires valeur-clé peuvent être visualisées dans la trace de transaction dans APM, la trace des erreurs dans APM, l'événement de transaction dans le dashboard et les pages vues dans le dashboard. Vous pouvez personnaliser exactement quel attribut sera envoyé à chacune de ces destinations
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, active la capture de l'attribut pour toutes les destinations.
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Préfixe d'attribut à exclure de toutes les destinations. Autorise *
comme caractère générique à la fin.
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Préfixe d'attribut à inclure dans toutes les destinations. Autorise *
comme caractère générique à la fin.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent capture l'attribut de monitoring des navigateurs.
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Préfixe d'attribut à exclure de monitoring des navigateurs. Autorise *
comme caractère générique à la fin.
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Préfixe d'attribut à inclure dans monitoring des navigateurs. Autorise *
comme caractère générique à la fin.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l' agent capture l'attribut de la collection d'erreurs.
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Préfixe de l'attribut à exclure de la collecte des erreurs. Autorise *
comme caractère générique à la fin.
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Préfixe d'attribut à inclure dans la collection d'erreurs. Autorise *
comme caractère générique à la fin.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent capture l'attribut lors de l'événement span.
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Préfixe d'attribut à exclure de l'événement span. Autorise *
comme caractère générique à la fin.
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Préfixe de l'attribut à inclure sur l'événement span. Autorise *
comme caractère générique à la fin.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l' agent capture l'attribut de l'événement de transaction.
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Préfixe d'attribut à exclure de l'événement de transaction. Autorise *
comme caractère générique à la fin.
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Préfixe d'attribut à inclure dans l'événement de transaction. Autorise *
comme caractère générique à la fin.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent capture l'attribut sur les segments de transaction.
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Préfixe d'attribut à exclure des segments de transaction. Autorise *
comme caractère générique à la fin.
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Préfixe d'attribut à inclure dans les segments de transaction. Autorise *
comme caractère générique à la fin.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l' agent capture l'attribut à partir de la trace de transaction.
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Préfixe d'attribut à exclure de la trace de transaction. Autorise *
comme caractère générique à la fin.
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Préfixe d'attribut à inclure dans la trace de transaction. Autorise *
comme caractère générique à la fin.
Log d'audit
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, active un log d'audit qui enregistre les communications avec le collecteur New Relic.
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Liste des points de terminaison autorisés à inclure dans log d'audit.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Spécifie un chemin d'accès au fichier log d'audit (y compris le nom du fichier).
Démarrage automatique
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Spécifiez une liste de constantes qui doivent empêcher l’agent de démarrer automatiquement. Séparez les constantes individuelles par une virgule ,
. Par exemple, "Rails::Console,UninstrumentedBackgroundJob"
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Définit une liste délimitée par des virgules d'exécutables que l'agent ne doit pas instrument. Par exemple, "rake,my_ruby_script.rb"
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Définit une liste délimitée par des virgules de tâches Rake que l'agent ne doit pas instrument. Par exemple, "assets:precompile,db:migrate"
.
Cloud
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
L'ID de compte AWS pour le compte AWS associé à cette application
niveau du code Métriques
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent signalera les métriques au niveau de la source du code pour les méthodes de trace. Voir : https://docs.newrelic.com/docs/apm/agents/ruby-agent/features/ruby-codestream-integration/
traceur inter-applications
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
DEPRECATED Veuillez consulter : distributor_tracing.enabled.
Si true
, active le traçage inter-applications lorsque distributed_tracing.enabled
est défini sur false
.
attribut personnalisé
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si false
, l'attribut personnalisé ne sera pas envoyé sur événement.
événement personnalisé
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent capture l'événement personnalisé.
Type | Entier |
---|---|
Défaut |
|
Variable d'environnement |
|
- Spécifiez un nombre maximum d'événements personnalisés à mettre en mémoire tampon à la fois.
- Lors de la configuration de l'agent pour monitoring de l'IA, définissez la valeur maximale sur
100000
. Cela garantit que l'agent capture la quantité maximale d'événements LLM.
Traceur de datastore
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si false
, l' agent n'ajoutera pas le paramètre database_name
à la transaction ou ne ralentira pas la trace SQL.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si false
, l'agent ne signalera pas les métriques de l'instance datastore, n'ajoutera pas host
de port_path_or_id
paramètres ou à la transaction ni ne ralentira la trace SQL.
Désactiver
Utilisez ces paramètres pour basculer entre les types d’instrumentation lors du démarrage de l’agent.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, désactive l'instrumentation du câble d'action.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, désactive l'instrumentation du contrôleur d'action.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, désactive l’instrumentation de la boîte aux lettres d’action.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, désactive l'instrumentation Action Mailer.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, désactive l'instrumentation du travail actif.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, désactive l’instrumentation Active Storage.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, désactive l'instrumentation de support actif.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, désactive l'instrumentation Active Record.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, désactive l'instrumentation pour Active Record 4+
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l’agent n’échantillonnera pas l’utilisation du processeur du processus hôte.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent ne mesurera pas la profondeur des files d'attente de tâches retardées.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, désactive l'utilisation de GC::Profiler
pour mesurer le temps passé dans le garbage collection
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l’agent n’échantillonnera pas l’utilisation de la mémoire du processus hôte.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent n'encapsulera pas les middlewares tiers dans l'instrumentation (qu'ils soient installés via Rack::Builder
ou Rails).
Important
Lorsque l'instrumentation middleware est désactivée, si une application utilise un middleware susceptible de modifier le code de réponse, le code d'état HTTP signalé sur la transaction peut ne pas refléter la valeur modifiée.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, désactive la collecte des métriques de l'échantillonneur. Les métriques de Sampler sont des métriques qui ne sont pas basées sur des événements (comme le temps CPU ou l'utilisation de la mémoire).
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, désactive l'instrumentation Sequel.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, désactive l'instrumentation Sidekiq.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, désactive l'agent middleware pour Roda. Ce middleware est responsable de la prise en charge des fonctionnalités avancées telles que le temps de chargement des pages et la collecte des erreurs.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, désactive l'agent middleware pour Sinatra. Ce middleware est responsable de la prise en charge des fonctionnalités avancées telles que le traçage inter-applications, le temps de chargement des pages et la collecte des erreurs.
Important
Le tracing inter-applications est déconseillé au profit du tracing distribué. Le tracing distribué est activé par défaut pour les versions 8.0.0 et supérieures de l'agent Ruby . Les intergiciels ne sont pas tenus de prendre en charge le tracing distribué.
Pour continuer à utiliser le traçage inter-applications, mettez à jour les options suivantes dans votre fichier de configuration newrelic.yml
:
cross_application_tracer: enabled: true distributed_tracing: enabled: false
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, désactive l'instrumentation de vue.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent n'échantillonnera pas les mesures de performances de la machine virtuelle Ruby.
Tracing distribué
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Le tracing distribué vous permet de voir le chemin qu'emprunte une requête à travers vos systèmes distribués. L'activation du tracing distribué modifie le comportement de certaines fonctionnalités de New Relic. Consultez donc attentivement le guide de transition avant d'activer cette fonctionnalité.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
This setting controls the behavior of transaction sampling when a remote parent is sampled and the trace flag is set in the traceparent. Available values are default
, always_on
, and always_off
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
This setting controls the behavior of transaction sampling when a remote parent is not sampled and the trace flag is not set in the traceparent. Available values are default
, always_on
, and always_off
.
Elasticsearch
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent capture le nom du cluster d'Elasticsearch dans la trace de transaction.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent capture la requête Elasticsearch dans la trace de transaction.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent obscurcit la requête Elasticsearch dans la trace de transaction.
Heroku
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l' agent utilise les noms dyno Heroku comme nom d'hôte.
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
En règle générale, l'agent signale les noms des dynamomètres avec un point de fin et un ID de processus (par exemple, worker.3
). Vous pouvez supprimer ces données de fin en spécifiant les préfixes que vous souhaitez signaler sans données de fin (par exemple, worker
).
Infinite Tracing
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Configure le nom d'hôte pour l'Hôte observateur de trace. Une fois configuré, il permet l'échantillonnage en fin de flux de travail en envoyant toutes les étendues enregistrées à un observateur trace pour d'autres décisions d'échantillonnage, indépendamment de toute décision d'échantillonnage habituelle de l'agent.
Type | Entier |
---|---|
Défaut |
|
Variable d'environnement |
|
Configure le port TCP/IP pour l'Hôte observateur de trace
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
(valeur par défaut), les données envoyées à l'observateur de trace sont regroupées au lieu d'être envoyées chaque plage individuellement.
Type | Symbole |
---|---|
Défaut |
|
Variable d'environnement |
|
Configurez le niveau de compression des données envoyées à l'observateur de trace. Peut être l'un des suivants : :none
, :low
, :medium
, :high
. Réglez le niveau sur :none
pour désactiver la compression.
Instrumentation
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de ActiveSupport::BroadcastLogger
au démarrage. Peut être l’un des suivants : auto
, prepend
, chain
, disabled
. Utilisé dans les versions Rails >= 7.1.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de ActiveSupport::Logger
au démarrage. Peut être l’un des suivants : auto
, prepend
, chain
, disabled
. Utilisé dans les versions Rails inférieures à 7.1.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de Async::HTTP au démarrage. Peut être l'un des suivants : auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation du lapin au démarrage. Peut être l'un des suivants : auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de la bibliothèque aws-sdk-firehose au démarrage. Peut être l’un des auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de la bibliothèque aws_sdk_lambda au démarrage. Peut être l’un des auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de la bibliothèque aws-sdk-kinesis au démarrage. Peut être l’un des auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de la bibliothèque ruby-kafka au démarrage. Peut être l’un des auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de la bibliothèque opensearch-ruby au démarrage. Peut être l’un des auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de la bibliothèque rdkafka au démarrage. Peut être l’un des auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de la bibliothèque aws-sdk-sqs au démarrage. Peut être l'un des suivants : auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de la bibliothèque aws-sdk-dynamodb au démarrage. Peut être l’un des auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de la classe Fibre au démarrage. Peut être l'un des suivants : auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de la bibliothèque concurrent-ruby au démarrage. Peut être l'un des suivants : auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation du Curb au démarrage. Peut être l'un des suivants : auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation du travail différé au démarrage. Peut être l'un des suivants : auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de la bibliothèque elasticsearch au démarrage. Peut être l'un des suivants : auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de l'éthon au démarrage. Peut être l'un des auto
, prepend
, chain
, disabled
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation d'Excon au démarrage. Peut être l’un des suivants : enabled
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle auto-instrumentation du Grape au démarrage. Peut être l'un des suivants : auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation des clients gRPC au démarrage. Peut être l'un des suivants : auto
, prepend
, chain
, disabled
.
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Spécifie une liste de modèles de nom d'hôte séparés par des virgules qui correspondront au nom d'hôte gRPC pour lequel le trafic doit être ignoré par New Relic. du client de New Relic gRPC instrumentation ignorera le trafic diffusé vers un hôte correspondant à l'un de ces modèles, et du gRPC serveur de New Relic instrumentation ignorera le trafic d'un serveur exécuté sur un hôte dont le nom d'hôte correspond à l'un de ces modèles. Par défaut, aucun trafic n'est ignoré lorsque l'instrumentation gRPC est elle-même activée. Par exemple, "private.com$,exception.*"
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation des serveurs gRPC au démarrage. Peut être l'un des suivants : auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de HTTPClient au démarrage. Peut être l'un des suivants : auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation du gem http.rb au démarrage. Peut être l'un des suivants : auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de httpx au démarrage. Peut être l'un des auto
, prepend
, chain
, disabled
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle auto-instrumentation de la bibliothèque standard Ruby activer au démarrage. Peut être l'un des suivants : auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de la bibliothèque LogStasher au démarrage. Peut être l'un des suivants : auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de la gem dalli pour Memcache au démarrage. Peut être l'un des suivants : auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de la gem memcached pour Memcache au démarrage. Peut être l'un des suivants : auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de la gem memcache-client pour Memcache au démarrage. Peut être l'un des suivants : auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de Mongo au démarrage. Peut être l’un des suivants : enabled
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de Net::HTTP
au démarrage. Peut être l’un des suivants : auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de la gem ruby-openai au démarrage. Peut être l'un des suivants : auto
, prepend
, chain
, disabled
. La valeur par défaut est disabled
en mode haute sécurité.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de Puma::Rack
. Lorsqu'elle est activée, l'agent se connecte à la méthode to_app
dans Puma::Rack::Builder
pour trouver les gems à instrumenter lors du démarrage de l'application. Peut être l'un des suivants : auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de Puma::Rack::URLMap
au démarrage. Peut être l’un des suivants : auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation du Rack. Lorsqu'elle est activée, l'agent se connecte à la méthode to_app
dans Rack::Builder
pour trouver les gems à instrumenter lors du démarrage de l'application. Peut être l’un des suivants : auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de Rack::URLMap
au démarrage. Peut être l’un des suivants : auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation du râteau au démarrage. Peut être l'un des suivants : auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de Redis au démarrage. Peut être l'un des suivants : auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation du resque au démarrage. Peut être l'un des suivants : auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de Roda au démarrage. Peut être l'un des suivants : auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de Sinatra au démarrage. Peut être l'un des suivants : auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de Stripe au démarrage. Peut être l’un des suivants : enabled
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de ViewComponent au démarrage. Peut être l'un des suivants : auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de la classe Thread au démarrage pour permettre à l'agent d'imbriquer correctement les étendues à l'intérieur d'une transaction asynchrone. Cela ne permet pas à l'agent de trace automatiquement tous les threads créés (voir instrumentation.thread.tracing
). Peut être l’un des suivants : auto
, prepend
, chain
, disabled
.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de la classe Thread au démarrage pour ajouter automatiquement le traçage à tous les threads créés dans l'application.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de la bibliothèque de rendu de modèles Tilt au démarrage. Peut être l'un des suivants : auto
, prepend
, chain
, disabled
.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de Typhoeus au démarrage. Peut être l'un des suivants : auto
, prepend
, chain
, disabled
.
Traceur de messages
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent collectera des métadonnées sur les messages et les joindra en tant que paramètres de segment.
Mongo
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent capture la requête Mongo dans la trace de transaction.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent obscurcit la requête Mongo dans la trace de la transaction.
Recherche ouverte
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent capture la requête OpenSearch dans la trace de transaction.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent obscurcit la requête OpenSearch dans la trace de transaction.
Hôte de processus
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Spécifiez un nom d'hôte personnalisé à afficher dans l'UI de New Relic.
Râteau
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Spécifiez un éventail de tâches Rake à instrumenter automatiquement. Cette option configuration convertit l'éventail en une liste RegEx. Si vous souhaitez autoriser toutes les tâches par défaut, utilisez rake.tasks: [.+]
. Aucune tâche de râteau ne sera instrumentée à moins qu'elle ne soit ajoutée à cette liste. Pour plus d'informations, consultez la documentation sur l'instrumentation New Relic Rake.
Type | Entier |
---|---|
Défaut |
|
Variable d'environnement |
|
Délai d'attente avant la fin de la connexion avant une tâche de rake
Règles
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Définissez les transactions que vous souhaitez que l'agent ignore, en spécifiant une liste de modèles correspondant à l'URI que vous souhaitez ignorer. Pour plus de détails, consultez la documentation sur l'ignorance de transactions spécifiques.
Sécurité
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent de sécurité est chargé (un « require » Ruby est exécuté)
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent de sécurité est démarré (l'agent s'exécute dans sa boucle d'événements)
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Définit le mode de fonctionnement de l'agent de sécurité. Actuellement, seul IAST
est pris en charge
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Définit l'URL du point de terminaison pour la publication des données liées à la sécurité
Type | Entier |
---|---|
Défaut |
|
Variable d'environnement |
|
Le port sur lequel l'application écoute. Ce paramètre est obligatoire pour les serveurs passagers. L'agent détecte d'autres serveurs par défaut.
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Définit les chemins d'API que l'agent de sécurité doit ignorer dans les analyses IAST. Accepte un éventail de modèles d'expressions régulières correspondant à l'URI à ignorer. Le modèle regex doit trouver une correspondance complète pour l'URL sans le point de terminaison. Par exemple, [".*account.*"], [".*/\api\/v1\/.*?\/login"]
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Un éventail d'en-têtes de requête HTTP que l'agent de sécurité doit ignorer dans les analyses IAST . L'éventail doit spécifier une liste de modèles correspondant aux en-têtes à ignorer.
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Un éventail de paramètres de requête HTTP que l'agent de sécurité doit ignorer dans les analyses IAST . L'éventail doit spécifier une liste de modèles correspondant aux paramètres de requête HTTP à ignorer.
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Un éventail de clés de corps de requête HTTP que l'agent de sécurité doit ignorer dans les analyses IAST .
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, désactive la détection des paramètres non sécurisés de faible gravité. Par exemple, hacher, crypto, cookie, générateurs aléatoires, limite de confiance).
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, désactive les détections IAST liées aux opérations de fichiers (violation de l'accès aux fichiers et de l'intégrité des applications)
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, désactive la détection d’injection SQL dans les analyses IAST.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, désactive la détection d'injection NOSQL dans les analyses IAST.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, désactive la détection d’injection LDAP dans les analyses IAST.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, désactive la détection d'injection Javascript dans les analyses IAST.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, désactive la détection d'injection de commande système dans les analyses IAST.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, désactive la détection d'injection XPATH dans les analyses IAST.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, désactive la détection de falsification de requête côté serveur (SSRF) dans les analyses IAST.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, désactive la détection de script intersite réfléchi (RXSS) dans les analyses IAST .
Type | Entier |
---|---|
Défaut |
|
Variable d'environnement |
|
Spécifie le délai (en minutes) avant le début de l'analyse IAST après le démarrage de l'application.
Type | Entier |
---|---|
Défaut |
|
Variable d'environnement |
|
Indique la durée (en minutes) pendant laquelle l'analyse IAST sera effectuée.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Spécifie une expression cron qui définit quand l'analyse IAST doit être exécutée.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, permet à IAST de collecter en continu des données de trace en arrière-plan. L'agent de sécurité utilise les données collectées pour effectuer une analyse IAST à l'heure programmée.
Type | Entier |
---|---|
Défaut |
|
Variable d'environnement |
|
Définit le nombre maximal de requests HTTP autorisées pour l'analyse IAST par minute. Tout entier compris entre 12 et 3600 est valide. La valeur par défaut est 3600.
Type | Entier |
---|---|
Défaut |
|
Variable d'environnement |
|
Le nombre d'instances d'application pour une entité spécifique sur laquelle effectuer une analyse IAST .
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, active l'envoi des corps de réponses HTTP. La désactivation de cette option désactive également la détection des vulnérabilités du script Reflected Cross-Site (RXSS).
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Un identifiant de test unique lors de l'exécution IAST dans un environnement CI/CD (intégration et livraison continue) pour différencier les différentes exécutions de tests. Par exemple, un numéro de build.
Mode Serverless
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent fonctionnera dans un mode simplifié adapté à une utilisation avec un serveur sans serveur à fonction de courte durée. REMARQUE : seules les fonctions AWS Lambda sont actuellement prises en charge et cette option n'est pas destinée à être utilisée sans l'offre de couche Ruby Lambda de New Relic .
Sidekiq
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Un ensemble de chaînes qui serviront collectivement de liste blanche pour filtrer les arguments de tâche Sidekiq signalés à New Relic. Pour capturer tous les arguments Sidekiq, 'job.sidekiq.args.*' doit être ajouté à l'option de configuration :'attributes.include'
distincte. Chaque chaîne de cet éventail sera transformée en expressions régulières via Regexp.new
pour permettre une correspondance avancée. Pour l'argument de travail hacher, si une clé ou une valeur correspond, la paire sera incluse. Tous les éléments d'éventail d'arguments de travail correspondants et les scalaires d'arguments de travail seront inclus.
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Un ensemble de chaînes qui serviront collectivement de liste de refus pour filtrer les arguments de tâche Sidekiq signalés à New Relic. Pour capturer tous les arguments Sidekiq, 'job.sidekiq.args.*' doit être ajouté à l'option de configuration :'attributes.include'
distincte. Chaque chaîne de cet éventail sera transformée en expressions régulières via Regexp.new
pour permettre une correspondance avancée. Pour l'argument de travail hacher, si une clé ou une valeur correspond, la paire sera exclue. Tous les éléments d'éventail d'arguments de travail correspondants et les scalaires d'arguments de travail seront exclus.
SQL lent
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent collecte les requêtes SQL lentes.
Type | Virgule flottante |
---|---|
Défaut |
|
Variable d'environnement |
|
Spécifiez un seuil en secondes. L'agent collecte les requêtes SQL lentes et explique les plans qui dépassent ce seuil.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent collecte des plans explicatifs dans une requête SQL lente. Si ce paramètre est omis, le paramètre transaction_tracer.explain_enabled
sera également appliqué comme paramètre par défaut pour expliquer les plans dans SQL lent.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Définit un niveau obfuscation pour les requêtes SQL lentes. Les options valides sont obfuscated
, raw
ou none
.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Générer un sql_id
plus long pour une trace SQL lente. sql_id
est utilisé pour l'agrégation de requêtes similaires.
Événement de span
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, active l'échantillonnage d'événements sur plusieurs périodes.
Type | Entier |
---|---|
Défaut |
|
Variable d'environnement |
|
Définit le nombre maximal d'événements span à mettre en mémoire tampon lors de la diffusion vers l'observateur de trace .
Type | Entier |
---|---|
Défaut |
|
Variable d'environnement |
|
- Définit le nombre maximal d'événements de portée signalés à partir d'une seule récolte. Tout entier compris entre
1
et10000
est valide. - Lors de la configuration de l'agent pour monitoring de l'IA, définissez la valeur maximale sur
10000
. Cela garantit que l'agent capture la quantité maximale de traces distribuées.
Supprimer les messages d'exception
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si cette valeur est vraie, l'agent supprime les messages de toutes les exceptions, à l'exception de celles figurant dans la liste des classes autorisées. Activé automatiquement en mode haute sécurité.
Type | Chaîne |
---|---|
Défaut |
|
Variable d'environnement |
|
Spécifiez une liste d'exceptions que vous ne souhaitez pas que l'agent supprime lorsque strip_exception_messages est true
. Séparez les exceptions par une virgule. Par exemple, "ImportantException,PreserveMessageException"
.
Stripe
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Un ensemble de chaînes permettant de spécifier quelles clés à l'intérieur du hachoir user_data
d'un événement Stripe doivent être signalées à New Relic. Chaque chaîne de cet éventail sera transformée en expressions régulières via Regexp.new
pour permettre une correspondance avancée. La définition de la valeur sur ["."]
signalera tous user_data
.
Type | Array |
---|---|
Défaut |
|
Variable d'environnement |
|
Un ensemble de chaînes permettant de spécifier quelles clés et/ou valeurs à l'intérieur du hachage user_data
d'un événement Stripe ne doivent pas être signalées à New Relic. Chaque chaîne de cet éventail sera transformée en expressions régulières via Regexp.new
pour permettre une correspondance avancée. Pour chaque paire Hacher, si la clé ou la valeur correspond, la paire n'est pas signalée. Par défaut, aucun user_data
n'est signalé. Utilisez cette option uniquement si l’option stripe.user_data.include
est également utilisée.
Profileur de filetage
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, active l'utilisation du profileur de thread.
Utilisation
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l’agent détecte automatiquement qu’il s’exécute dans un environnement AWS.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l’agent détecte automatiquement qu’il s’exécute dans un environnement Azure.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l’agent détecte automatiquement qu’il s’exécute dans Docker.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent détecte automatiquement qu'il s'exécute dans un environnement Google Cloud Platform.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l’agent détecte automatiquement qu’il s’exécute dans Kubernetes.
Type | Booléen |
---|---|
Défaut |
|
Variable d'environnement |
|
Si true
, l'agent détecte automatiquement qu'il s'exécute dans un environnement Pivotal Cloud Foundry.