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: debugL'agent Ruby recherche les variables d'environnement suivantes, dans cet ordre, pour trouver l'environnement de l'application :
NEW_RELIC_ENVRUBY_ENVRAILS_ENVAPP_ENVRACK_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 ordre croissant de verbosité, sont : fatal, error, warn, info ou debug.
Type | Array |
|---|---|
Défaut |
|
Variable d'environnement |
|
Un éventail de noms d’événements personnalisés ActiveSupport auxquels s’abonner et à instrument. Par exemple : [one.custom.event, another.event, a.third.event]
Type | Booléen |
|---|---|
Défaut |
|
Variable d'environnement |
|
Si true, l’agent utilisera le nom de la table du modèle ActiveRecord au lieu du nom de la classe lors du nommage des métriques, des spans et des segments de trace de transaction ActiveRecord. Cela peut réduire la cardinalité lorsque plusieurs modèles partagent une table de base de données. La valeur par défaut est false.
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 |
|
Si true, l’agent capture les clés memcache dans 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 non dé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 |
|
Si true, supprime l’en-tête de tracing distribué newrelic sur les requests sortantes.
Type | Booléen |
|---|---|
Défaut |
|
Variable d'environnement |
|
Si true, force l’agent à installer son gestionnaire de sortie (qui envoie toutes les données mises en cache au collecteur avant de s’arrêter), même dans les cas où l’agent l’ignorerait normalement, comme lorsqu’il détecte que Sinatra s’exécute en tant que service intégré dans un autre framework. Sinatra exécute l’application entière dans son propre bloc at_exit, l’agent ignore donc son propre gestionnaire at_exit par défaut pour éviter les conflits. Ce paramètre remplace ce comportement. Remarque : send_data_on_exit doit également être true pour que ce paramètre prenne effet.
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, sans le nom du fichier. Si vous souhaitez envoyer les logs de votre agent vers la sortie standard, définissez ce paramètre sur STDOUT.
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 | 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.notifyCet 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, les métriques des appels de diffusion Action Cable n'incluront pas la valeur broadcasting pour une diffusion donnée. Par défaut false. La valeur par défaut peut changer lors d'une future sortie de version majeure.
Type | Array |
|---|---|
Défaut |
|
Variable d'environnement |
|
Une liste de noms de classes ou de modules de middleware que l'agent doit ignorer. Exemple : ["Rack::Cors", "ActionDispatch::Reloader"]
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 | Booléen |
|---|---|
Défaut |
|
Variable d'environnement |
|
Si true, une fois que transaction_tracer.limit_segments est atteint, l’agent arrêtera également d’enregistrer le temps exclusif pour tous les segments créés par la suite dans cette transaction. Cela peut réduire l’utilisation de la mémoire pour les transactions très longues avec de nombreux segments, au prix de données de chronométrage moins précises pour les segments de la transaction si la limite de segments est atteinte.
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 séparée par des virgules de codes d’état HTTP et/ou de plages de codes d’état (par exemple, 404, 429, 500-599). Les erreurs associées à un code d’état correspondant, si l’erreur en a un, 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 séparée par des virgules de codes d’état HTTP et/ou de plages de codes d’état (par exemple, 404, 429, 500-599). Les erreurs associées à un code d’état correspondant, si l’erreur en a un, seront ignorées.
Type | Entier |
|---|---|
Défaut |
|
Variable d'environnement |
|
Définit le nombre maximal de frames dans une trace d’erreur. Les backtraces dépassant cette quantité sont tronquées au milieu par défaut, préservant le début et la fin de la trace d’appels. Consultez error_collector.backtrace_truncate_location pour personnaliser l’emplacement de la troncature.
Type | Chaîne |
|---|---|
Défaut |
|
Variable d'environnement |
|
Spécifie où tronquer la trace de pile lorsque le nombre de cadres dépasse error_collector.max_backtrace_frames. Les options sont top (supprimer les cadres du début), middle (supprimer les cadres du milieu, en conservant le début et la fin) ou end (supprimer les cadres de la fin).
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+.
Type | Chaîne |
|---|---|
Défaut |
|
Variable d'environnement |
|
Épinglez la version du chargeur de l'agent de navigateur que New Relic injecte, telle que 1.317.0. S’il n’est pas défini, New Relic injecte la dernière version disponible. Consultez la politique de fin de vie de l’agent de navigateur pour connaître les versions actuellement disponibles et prises en charge.
É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 transféré à New Relic. Les logs au niveau configuré et de toute gravité supérieure sont transférés, par exemple, debug transfère tous les événements de log, tandis que error transfère uniquement les événements error, fatal, et unknown. Valeurs valides, de la gravité la plus faible à la plus élevée : debug, info, warn, error, fatal, unknown (insensibles à la casse).
Cet ordre est basé sur les valeurs entières des constantes Logger::Severity de Ruby (voir https://github.com/ruby/logger/blob/113b82a06b3076b93a71cd467e1605b23afb3088/lib/logger/severity.rb).
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 span 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, l'instrumentation LLM (OpenAI uniquement pour le moment) ne capturera pas l'attribut content sur les événements LlmChatCompletionMessage ou l'attribut input sur les événements LlmEmbedding. Il s'agit d'un paramètre de sécurité facultatif pour empêcher l'enregistrement des données sensibles envoyées à vos LLM et reçues de ces derniers.
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 le 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 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/
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 maximal 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 aux traces SQL lentes.
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, les noms d'étape de Rails Active Job Continuations ne seront pas inclus dans les noms de métriques. Cela réduit la cardinalité des métriques mais réduit également la visibilité sur la performance des étapes individuelles. Définissez ceci sur true uniquement si vous rencontrez des problèmes de cardinalité de métriques dus à des jobs comportant de nombreuses étapes ou des étapes nommées dynamiquement.
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é lors de la récupération de mémoire.
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 le middleware de l'agent pour Sinatra. Ce middleware est responsable de la prise en charge des fonctionnalités avancées telles que le suivi distribué, le chronométrage du chargement de la page et la collecte des erreurs.
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.
Type | Booléen |
|---|---|
Défaut |
|
Variable d'environnement |
|
Si true, désactive l’instrumentation des statistiques du serveur Puma qui échantillonne les métriques Ruby/Puma/* à partir du processus maître Puma. Cette instrumentation est désactivée par défaut. Lorsqu’elle est activée, l’agent démarre un thread de reporting dans le processus maître Puma pour fournir ces métriques.
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 |
|
Ce paramètre contrôle le comportement de l’échantillonnage des transactions pour les transactions sans parent distant (les traces qui proviennent de cette instance de l’agent New Relic). Les valeurs disponibles sont adaptive (par défaut), always_on, always_off et trace_id_ratio_based.
Type | Chaîne |
|---|---|
Défaut |
|
Variable d'environnement |
|
Ce paramètre contrôle le comportement de l'échantillonnage des transactions lorsqu'un parent distant est échantillonné. Les valeurs disponibles sont adaptive (la valeur par défaut), always_on, always_off et trace_id_ratio_based.
Type | Chaîne |
|---|---|
Défaut |
|
Variable d'environnement |
|
Ce paramètre contrôle le comportement de l'échantillonnage des transactions lorsqu'un parent distant n'est pas échantillonné. Les valeurs disponibles sont adaptive (par défaut), always_on, always_off et trace_id_ratio_based.
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 spans 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 | Array |
|---|---|
Défaut |
|
Variable d'environnement |
|
Une liste d’autorisation de noms d’événements de notification ActiveSupport (principalement des événements de mise en cache, et des événements de sérialisation de messages) auxquels l’agent s’abonne. Tout nom d’événement non inclus ici est ignoré. Fournissez uniquement des noms d’événements complets, tels que cache_fetch_hit.active_support. Ne fournissez pas d’astérisques ou de modèles regex, et n’échappez à aucun caractère avec des barres obliques inversées.
Pour la liste complète des noms d’événements possibles, consultez la liste des noms de mise en cache, et des noms de messages de la documentation de Rails.
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 semantic_logger au démarrage. Peut être l'un de auto, prepend, chain, disabled.
Type | Chaîne |
|---|---|
Défaut |
|
Variable d'environnement |
|
Contrôle l'auto-instrumentation de la bibliothèque parallèle au démarrage. Peut être l'un de 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 d’ethon au démarrage. Peut être l’un de 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 |
|
Une liste séparée par des virgules de modèles d’expressions régulières correspondant aux noms d’hôte gRPC dont New Relic doit ignorer le trafic. L’instrumentation du client gRPC de New Relic ignore le tracing des appels effectués vers un hôte correspondant à l’un de ces modèles, et son instrumentation du serveur gRPC ignore le tracing des requests reçues par un serveur s’exécutant sur un hôte correspondant. Par exemple, "private.com$,exception.*" Empty by default, meaning no traffic is ignored..
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 de 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 de logging au démarrage. Peut être l'un de 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'instrumentation de Rails.event sous forme de logs structurés. Peut être l'un des suivants : enabled, disabled.
Type | Array |
|---|---|
Défaut |
|
Variable d'environnement |
|
Un éventail de noms de Rails.event à capturer en tant qu’événements de log structurés. Par exemple : [utilisateur.signup, payment.processed, order.created]. Laissez vide pour capturer toutes les notifications Rails.event. Les événements sont enregistrés dans le log avec le niveau UNKNOWN (garantissant qu’ils ne sont jamais filtrés), à moins d’être remplacés via une clé :level dans la charge de l’événement.
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 spans à 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 tracing à 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.
OpenTelemetry
Type | Booléen |
|---|---|
Défaut |
|
Variable d'environnement |
|
Une option de configuration globale pour désactiver tous les signaux OpenTelemetry envoyés via New Relic. Si défini sur false, aucun signal OpenTelemetry ne sera envoyé à New Relic. Si défini sur true, l’option de configuration d’activation spécifique au signal (par ex. opentelemetry.traces.enabled) détermine si la télémétrie de ce type de signal sera rapportée à New Relic.
Type | Booléen |
|---|---|
Défaut |
|
Variable d'environnement |
|
Permet la création de segments de traces de transaction et de métriques de tranches de temps à partir des spans OpenTelemetry. Cela aidera à piloter l'expérience de l'interface utilisateur New Relic pour les spans OpenTelemetry.
Type | Chaîne |
|---|---|
Défaut |
|
Variable d'environnement |
|
Une liste de traceurs OpenTelemetry délimitée par des virgules, représentée sous forme de chaîne (par ex. "AppTracer1,OpenTelemetry::Instrumentation::Bunny::Instrumentation"), dont les traces seront envoyées à New Relic.
Type | Chaîne |
|---|---|
Défaut |
|
Variable d'environnement |
|
Une liste de traceurs OpenTelemetry délimitée par des virgules, représentée sous forme de chaîne (par ex. "AppTracer1,OpenTelemetry::Instrumentation::Bunny::Instrumentation"), dont les traces ne seront pas envoyées à New Relic.
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.
Puma
Type | Entier |
|---|---|
Défaut |
|
Variable d'environnement |
|
Nombre de secondes entre les échantillons de statistiques du serveur Puma prélevés dans le processus maître Puma.
Râteau
Type | Array |
|---|---|
Défaut |
|
Variable d'environnement |
|
Spécifiez un éventail de tâches Rake à instrumenter automatiquement. Cette option de configuration convertit l'éventail en une liste RegEx. Aucune tâche rake ne sera instrumentée à moins qu'elle ne soit ajoutée à cette liste. Si vous souhaitez autoriser toutes les tâches par défaut, utilisez rake.tasks: [.+]. Pour plus d'informations, consultez la documentation sur l'instrumentation New Relic Rake.
Type | Entier |
|---|---|
Défaut |
|
Variable d'environnement |
|
Définit le nombre de secondes à attendre pour qu’une connexion aboutisse avant d’exécuter une tâche 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 aux URI à exclure. Pour plus de détails, consultez la documentation pour ignorer des 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 effectué).
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 de 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 défini sur 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, et 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 scans 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 |
|
Spécifie la durée (en minutes) pendant laquelle l'analyse IAST est 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 maximum de requests HTTP autorisées par minute pour l’analyse IAST. Doit être un entier compris entre 12 et 3600 (par défaut).
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 d’IAST dans un environnement CI/CD (intégration et livraison continues) pour différencier les différentes exécutions de test. 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 éventail de chaînes qui servira collectivement de liste d’autorisation pour filtrer les arguments de tâche Sidekiq qui sont rapportés à New Relic. Pour capturer tout argument Sidekiq, job.sidekiq.args.* doit également ê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 les hacher d’arguments de tâche, si une clé ou une valeur correspond, la paire sera incluse. Tous les éléments d’éventail d’arguments de tâche et les scalaires d’arguments de tâche correspondants seront inclus.
Type | Array |
|---|---|
Défaut |
|
Variable d'environnement |
|
Un éventail de chaînes qui serviront collectivement de liste de blocage pour filtrer les arguments de tâche Sidekiq signalés à New Relic. Pour capturer tout argument Sidekiq, job.sidekiq.args.* doit également ê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 les hacher d'arguments de tâche, si une clé ou une valeur correspond, la paire sera exclue. Tous les éléments d'éventail d'arguments de tâche et les scalaires d'arguments de tâche correspondants seront exclus.
Type | Booléen |
|---|---|
Défaut |
|
Variable d'environnement |
|
Si true, l'agent ignorera les exceptions levées lors des tentatives de nouvelle tentative de Sidekiq et ne signalera l'erreur que si la tâche échoue définitivement.
Type | Booléen |
|---|---|
Défaut |
|
Variable d'environnement |
|
Si true, l'agent démarre une nouvelle transaction lorsqu'une tâche Sidekiq est exécutée pendant une transaction web. Cela empêche le temps d'exécution des tâches Sidekiq d'être inclus dans les métriques de transaction web.
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 |
|
Si true, l’agent génère un sql_id plus long pour les traces SQL lentes. 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 maximum d’événements span signalés à partir d’une seule collecte. Tout entier entre 1 et 10000 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 true, l’agent supprime les messages de toutes les exceptions, sauf celles de la liste des classes autorisées. Activé automatiquement en mode haute sécurité.
Type | Array |
|---|---|
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 signale l'ID d’instance GCP comme nom d’hôte lors de son exécution sur Google Cloud Run (Services, Worker Pools, et Jobs).
Type | Booléen |
|---|---|
Défaut |
|
Variable d'environnement |
|
Si true, l’agent ajoute le nom de révision Cloud Run au début de l’ID d’instance GCP pour former le nom d’hôte ({revision}-{instance id}) sur Google Cloud Run. Le nom de révision provient de K_REVISION sur un Cloud Run Service, CLOUD_RUN_REVISION sur un Cloud Run Worker Pool, et CLOUD_RUN_EXECUTION sur un Cloud Run Job. N’a aucun effet à moins que utilization.gcp_cloud_run.use_instance_as_host ne soit également true.
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.
Type | Booléen |
|---|---|
Défaut |
|
Variable d'environnement |
|
Si true, l'Agent effectue la détection de l'environnement en parallèle pour accélérer le temps de démarrage de l'Agent.
Erreurs configuration de la boîte de réception
Définir l'une des variables d'environnement suivantes vous aidera à identifier quelles versions de votre logiciel ont produit les erreurs.
NEW_RELIC_METADATA_SERVICE_VERSIONcréetags.service.versionsur les données d'événement contenant la version de votre code qui est déployée, dans de nombreux cas une version sémantique telle que1.2.3, mais pas toujours.NEW_RELIC_METADATA_RELEASE_TAGcréetags.releaseTagsur les données d’événement contenant le tag de sortie (tel quev0.1.209ourelease-209).NEW_RELIC_METADATA_COMMITcréetags.commitsur les données d’événement contenant le SHA de commit. Le SHA complet peut être utilisé ou seulement les sept premiers caractères (par exemple,734713b).
Errors Inbox suivra automatiquement les versions de votre logiciel qui produisent des erreurs.