Configuration de l'agent Java : fichier de configuration

Pour créer le répertoire des extensions :

1. Accédez au répertoire où se trouvent newrelic.jar et newrelic.yml . Créez un répertoire nommé extensions.
2. Dans newrelic.yml, vérifiez que la propriété extensions.dir n'est pas définie.

Pour utiliser un répertoire d’extensions Java existant :

1. Dans votre fichier newrelic.yml, recherchez la section common .
2. Utilisez la propriété extensions.dir pour spécifier l’emplacement du fichier.

Ce paramètre est required. Vous devez spécifier la clé de licence associée à votre compte New Relic. Cette clé lie les données de votre agent à votre compte dans le service New Relic.

Ce paramètre est required. Définit le nom de l'application utilisé pour signaler les données à New Relic.

Si enable_auto_app_naming est faux, l'agent signale toutes les données à cette application. Dans le cas contraire, l'agent signale uniquement les tâches d'arrière-plan (transactions pour les applications non Web) à cette application.

Pour signaler des données à plusieurs application, séparez les noms application par un point-virgule. Par exemple, pour signaler des données à My Application et My Application 2 utilisez ceci :

app_name: My Application;My Application 2

Pour plus de méthodes de dénomination de votre application, voir Nommer votre application Java.

Drapeau pour activer l'agent. Utilisez ce paramètre pour forcer l’agent à s’exécuter ou non.

Le seuil apdex_t en secondes pour le score Apdex de l'application. Pour les versions agent Java 1.2.008 ou supérieures, la valeur apdex_t est définie dans l'UI et la valeur dans newrelic.yml est ignorée.

Numéro permettant de différencier les JVM pour la même application sur la même machine. New Relic utilise l'hôte/port pour l'unicité, vous pouvez donc distinguer les JVM en plaçant un commutateur comme celui-ci dans les arguments de démarrage de chaque JVM :

-Dnewrelic.config.appserver_port=8081

Une fois que vous avez utilisé appserver_port pour nommer les JVM et les redémarrer, vous devriez pouvoir les voir individuellement dans la liste déroulante et dans l'interface de profilage.

Active le logging en texte brut de toutes les données envoyées à New Relic dans le fichier log de l'agent. Ce paramètre est dynamique, donc l'agent en cours d'exécution remarquera les modifications apportées à newrelic.yml sans redémarrage JVM .

Spécifie un chemin vers un ensemble de certificats SSL personnalisé qui sera utilisé par l'agent pour établir une connexion sécurisée à New Relic. Si votre ensemble de certificats SSL personnalisé n'inclut pas de certificats suffisants pour vous connecter à New Relic, vous devrez fusionner les certificats requis dans votre ensemble de certificats personnalisé.

Permet la création de rapports de données séparément pour chaque application Web. Définissez sur true pour activer la prise en charge de la dénomination automatique des applications. Le nom de chaque application Web est détecté automatiquement et l'agent rapporte les données séparément pour chacune d'elles. Cela fournit une répartition plus précise des performances des applications Web dans New Relic.

Pour plus d'informations, voir Nommage automatique des applications.

Pour plus de méthodes de dénomination de votre application, voir Nommer votre application Java.

Permet la dénomination des transactions basée sur les composants. Définissez sur true pour activer la dénomination des transactions basée sur les composants. Définissez sur false pour utiliser l’URI d’une requête Web comme nom de la transaction. Pour plus d'informations, voir Nommage des transactions Web.

Active toute instrumentation utilisant une annotation @Trace . La désactivation de cette option entraîne l'ignorance de @Trace annotations.

Événement ingest URI utilisé par certaines fonctionnalités agent. La valeur par défaut est le point de terminaison d'ingestion de production américain. Peut être configuré manuellement pour envoyer l'événement à un autre point de terminaison d'ingestion (par exemple, production UE : https://insights-collector.eu01.nr-data.net/v1/accounts/events).

Les clients conformes à FedRAMP doivent utiliser le point de terminaison conforme à FedRAMP: https://gov-insights-collector.newrelic.com/v1/accounts/events

Définit l'emplacement du répertoire des extensions facultatives. Si cette propriété n'est pas définie, l'agent recherchera un sous-répertoire nommé extensions dans le même répertoire que newrelic.jar et newrelic.yml.

Pour que la haute sécurité soit activée, cette propriété doit être définie sur true et la propriété de haute sécurité dans l'interface utilisateur New Relic doit être activée. L'activation de la haute sécurité signifie que SSL est activé, que les paramètres de demande et de fichier d'attente des messages ne sont pas collectés et que la requête ne peut pas être envoyée à New Relic sous sa forme brute.

Fournit la possibilité de configurer un point de terminaison compatible FedRAMP pour l'agent à utiliser, avec la valeur gov-collector.newrelic.com.

Une clé API d'insertion valide pour votre compte. Ceci n'est pas actuellement utilisé par l'agent.

Attachez une étiquette à cette application.

Notez que cette option active désormais la balise, qui a remplacé la fonctionnalité d'étiquette. Vous pouvez toujours interroger vos étiquettes historiques. Plusieurs balises peuvent être attachées en utilisant un point-virgule comme séparateur comme suit :

-Dnewrelic.config.labels="tagName1:tagValue1;tagName2:tagValue2;tagName3:tagValue3"

Dans de rares cas, une fuite de mémoire peut se produire avec instrumentation qui utilise l'legacy asynchrone API pour suivre le cycle de vie des servlets asynchrones ou des Jetty continuations . La fuite de mémoire se manifesterait par des transactions divulguées qui ont été suspendues mais jamais reprises. Cette configuration agit comme une solution de contournement pour empêcher qu'un tel scénario ne se produise. Il est conseillé d'activer cette solution de contournement uniquement en cas de fuite de mémoire.

Limite le nombre de lignes que l'agent collecte à partir de chaque trace d'appels. L’augmentation de cette valeur peut avoir un impact sur les performances, car elle augmente la quantité de mémoire utilisée par l’agent et la quantité de données envoyées à New Relic.

Métrique ingest URI utilisé par certaines fonctionnalités agent . La valeur par défaut est le point de terminaison d'ingestion de production américain. Peut être configuré manuellement pour envoyer des métriques à d'autres points de terminaison d'ingestion (exemple d'URI de production UE : https://metric-api.eu.newrelic.com/metric/v1).

Les clients conformes à FedRAMP doivent utiliser le point de terminaison conforme à FedRAMP: https://gov-metric-api.newrelic.com/metric/v1

L'hôte proxy via lequel se connecter au collecteur New Relic. Si un proxy est utilisé, le paramètre hôte est requis. Les autres paramètres proxy sont facultatifs.

Le mot de passe pour l'authentification proxy. Si un proxy est utilisé, le paramètre hôte est requis. Les autres paramètres proxy sont facultatifs. Les paramètres de nom d'utilisateur et de mot de passe seront utilisés pour s'authentifier auprès des défis d'authentification de base à partir d'un serveur proxy.

Le numéro de port de l'hôte proxy. Si un proxy est utilisé, le paramètre hôte est requis. Les autres paramètres proxy sont facultatifs.

Le nom d'utilisateur pour l'authentification proxy, telle que l'authentification de base (texte clair). Si un proxy est utilisé, le paramètre hôte est requis. Les autres paramètres proxy sont facultatifs. Les paramètres de nom d'utilisateur et de mot de passe seront utilisés pour s'authentifier auprès des défis d'authentification de base à partir d'un serveur proxy.

Le schéma proxy utilisé. Le paramètre proxy_scheme: "https" permettra à l'agent de se connecter via des proxys en utilisant le schéma HTTPS.

Si des erreurs sont signalées pour Reactor Netty. La valeur par défaut est faux. Si défini sur vrai, les erreurs Reactor Netty seront signalées.

Activez l’arrêt différé de la JVM pour donner à l’agent une chance d’envoyer les dernières données de métrique à New Relic avant l’arrêt de la JVM.

Le nombre de secondes après lequel l'agent utilisera le paramètre send_data_on_exit .

Activer la création de rapports sur les paramètres JVM vers New Relic.

Lorsqu'il est défini sur true, les propriétés JVM seront envoyées à New Relic.

Nécessite des connexions au collecteur New Relic pour passer par SSL.

L'agent communique avec New Relic via HTTPS par défaut, et New Relic requiert HTTPS pour tout le trafic vers APMet l'API REST New Relic.

Ce travail est effectué de manière asynchrone par rapport aux threads qui traitent le code de votre application, de sorte que les temps de réponse ne seront pas directement affectés par ce changement.

Permettez à l'agent de connecter le collecteur New Relic immédiatement au démarrage de l'application.

Pour trace plus concis des détails de la transaction, l'agent ne signale pas les contrats à terme Scala comme des segments de transaction, et ces contrats à terme ne contribuent pas au temps total de la transaction.

L'activation de scala_futures_as_segments augmente vos frais généraux. Si vous souhaitez que Scala Futures génère des rapports sous forme de segments de transaction afin que vous puissiez les afficher dans une trace de transaction, vous pouvez l'activer :

scala_futures_as_segments:
  enabled: true

Lorsque le temps exclusif d'un segment est inférieur à 2 % du temps total de transaction, la métrique pour cet appel de méthode sera agrégée sous Java/other.

La définition de trim_stats sur false désactivera ce comportement, permettant aux métriques d'être affichées individuellement.

trim_stats: false

À partir de la version agent 8.7.0, si elle est définie sur true et que l'agent s'exécute avec JBoss EAP / Wildfly, cela empêchera l'agent d'exiger qu'une classe sous le package javax.management soit chargée par le chargeur de classes système. Ceci est ajouté pour aider à résoudre les problèmes de démarrage d'application avec les modules JBoss lorsque l'API de gestion J2EE/Jakarta est utilisée. Plus d'informations sont fournies dans le document de dépannage JBoss / Wildfly.

Drapeau expérimental qui permet à l'agent de s'exécuter avec des versions Java non prises en charge.

Définissez un nom d'affichage pour décorer l'étiquette « hôte : port » dans l'UI de New Relic . Nécessite l'agent Java 3.17 ou supérieur.

Chaîne contenant un chemin d'accès complet au fichier de configuration newrelic. Si vide, l'agent suppose que newrelic.yml se trouve dans le même répertoire que newrelic.jar.

Activer le logging de débogage.

Chaîne contenant la configuration de l'environnement que l'agent doit utiliser.

Chaîne contenant le répertoire personnel de l'agent. La valeur par défaut est le même répertoire que le fichier jar de l'agent.

Chaîne contenant le nom du agent fichier de log.

Lorsque défini sur true, active monitoring de l'IA.

Si défini sur false, agent omettra le contenu d'entrée et de sortie (comme les chaînes de texte de l'invite et des réponses) capturées dans l'événement LLM. Il s'agit d'un paramètre de sécurité facultatif si vous ne souhaitez pas enregistrer les données sensibles envoyées et reçues par vos LLM.

Ce paramètre peut être utilisé pour activer ou désactiver tous les attributs.

Si les attributs sont activés, les clés d'attribut trouvées dans cette liste seront envoyées à New Relic. Séparez les clés de la liste par une virgule ; par exemple :

key1, key2, key3

Reportez-vous également aux règles d’attributsagent .

Toutes les clés d'attribut trouvées dans cette liste ne seront pas envoyées à New Relic. Séparez les clés de la liste par une virgule ; par exemple :

key1, key2, key3

Reportez-vous également aux règles d’attributsagent .

Les rapports d'attributs sont configurables via les moyens suivants.

YAML:

attributes:
  http_attribute_mode: both

Propriété du système :

-Dnewrelic.config.attributes.http_attribute_mode=both

Variable d'environnement :

NEW_RELIC_ATTRIBUTES_HTTP_ATTRIBUTE=both

Les options de configuration sont :

• standard : Les rapports utiliseront la norme (c.-à-d. Attribut OTEL). Cette configuration est encouragée. Cela minimisera l’impact sur la fonctionnalité et maintiendra le niveau d’ingestion le plus bas pour les rapports d’attributs.
• legacy : Le reporting sera effectué par l'attribut HTTP réintroduit, cette configuration peut avoir un impact sur les fonctionnalités actuelles ou futures.
• both : Il s'agit de la configuration par défaut, le reporting sera effectué par l'attribut HTTP réintroduit et l'attribut OTEL. Cette configuration augmentera également votre ingestion de données.

Le nombre de secondes après lequel l'agent expirera automatiquement un jeton asynchrone qui n'a pas été explicitement expiré avec token.expire(). Pour les instructions d'utilisation, voir jeton : Connecter des threads asynchrones.

Le nombre de secondes après lequel l'agent terminera automatiquement un segment qui n'a pas été explicitement terminé par segment.end() ou segment.ignore(). Pour les instructions d'utilisation, voir Segments : Activité asynchrone arbitraire temporelle.

Par défaut, l'agent insère automatiquement l'appel d'API dans les JSP compilés pour injecter le JavaScript monitoring dans les pages Web. Définissez cet attribut sur false pour désactiver ce comportement.

Lorsque auto_instrument est true, par défaut toutes les pages sont instrumentées. Listez ici toutes les pages que vous souhaitez que l’instrumentation automatique ignore. Vous pouvez toujours utiliser l'instrumentation manuelle sur ces pages.

Par exemple:

browser_monitoring:
  disabled_auto_pages: /WEB-INF/jsp/testpage_1.jsp, /WEB-INF/jsp/testpage_2.jsp

Ce paramètre peut être utilisé pour activer ou désactiver tous les attributs de monitoring des navigateurs. Voici les données que vous pouvez interroger. Si attributes.enabled est faux au niveau racine, aucun attribut ne sera envoyé dans monitoring des navigateurs, quelle que soit la manière dont cette propriété sous browser_monitoring est définie.

Si les attributs sont activés pour browser_monitoring, toutes les clés d'attribut trouvées dans cette liste seront envoyées à New Relic dans les vues de page. Pour plus d'informations, consultez les règles d'attribut de l'agent.

Toutes les clés d'attribut trouvées dans cette liste ne seront pas envoyées à New Relic dans les vues de page. Pour plus d'informations, consultez les règles d'attribut de l'agent.

Si votre application se comporte comme prévu, vous souhaiterez peut-être désactiver le disjoncteur.

Personnalisez le pourcentage de mémoire de tas libre en dessous duquel le disjoncteur doit se déclencher. Lorsque le pourcentage de mémoire de tas libre est inférieur à memory_threshold et que le temps CPU consacré à la collecte des déchets est supérieur à gc_cpu_threshold, le disjoncteur se déclenche. Afin de réduire la probabilité de déclenchement du disjoncteur, diminuez memory_threshold et/ou augmentez gc_cpu_threshold. Ajustez ces valeurs selon vos besoins, en fonction des performances de fonctionnement et du comportement de votre application.

Personnalisez le pourcentage de temps CPU de collecte des déchets au-dessus duquel le disjoncteur doit se déclencher. Lorsque le pourcentage de mémoire de tas libre est inférieur à memory_threshold et que le temps CPU consacré à la collecte des déchets est supérieur à gc_cpu_threshold, le disjoncteur se déclenche. Afin de réduire la probabilité de déclenchement du disjoncteur, diminuez memory_threshold et/ou augmentez gc_cpu_threshold. Ajustez ces valeurs selon vos besoins, en fonction des performances de fonctionnement et du comportement de votre application.

Ce paramètre est lu par certaines de services cloud instrumentation afin que cloud.resource_id l'attribut puisse être défini dans les étendues respectives.

AWS DynamoDB et Kinesis sont des services qui nécessitent cette valeur pour pouvoir renseigner l'attribut cloud.resource_id . De même, AWS Lambda exige que cette valeur lorsque l’ID de compte ne fait pas partie du nom de la fonction.

L'appel suivant remplacera ce paramètre :

NewRelic.getAgent().getCloud().setAccountInfo(CloudAccountInfo.AWS_ACCOUNT_ID, "...");

Détermine si l'agent interroge l'API de métadonnées AWS.

Détermine si l’agent interroge l’API de métadonnées Azure.

Détermine si l'agent interroge l'API de métadonnées Google Cloud Platform.

Détermine si l'agent signale la variable d'environnement KUBERNETES_SERVICE_HOST .

Détermine si l'agent lit les variables d'environnement Pivotal Cloud Foundry.

Détermine si l'agent lit les informations Docker à partir du système de fichiers.

Les métriques au niveau du code sont désactivées par défaut dans la version 7.10.0 de l'agent. Réglez ceci sur vrai pour l'activer. À partir de la version 7.11.0 de l'agent, la valeur par défaut est, comme indiqué ci-dessus, true.

Le tracing inter-applications est activé par défaut. Réglez ceci sur faux pour le désactiver.

Cela active le service événement personnalisé.

La taille maximale d'une valeur d'attribut, après laquelle la valeur sera tronquée. La valeur par défaut est 255 octets (dans le codage de jeu de caractères UTF-8) et la limite maximale est 4095.

Cette configuration existe dans l'agent Java version 8.9.0+.

• Le nombre maximal d'événements personnalisés échantillonnés signalés toutes les 60 secondes.
• Lors de la configuration de l'agent pour monitoring de l'IA, définissez la valeur maximale sur 100000. Garantit que la quantité maximale d'événements LLM est capturée.

Lorsque cette option est activée, la dénomination améliorée des transactions Spring nommera toute transaction provenant d'un contrôleur Spring d'après l'itinéraire défini et la méthode HTTP. Par exemple : /customer/v1/edit (POST). Cela inclut les contrôleurs qui implémentent ou étendent les interfaces/classes avec des annotations liées à WebMVC (@RestController, @Controller, @RequestMapping, etc.).

Par défaut, cette valeur est configurée sur false, ce qui nommera les transactions pour ces types de contrôleurs en fonction du nom de la classe et de la méthode du contrôleur. Par exemple ; CustomerController/edit. Il s’agit de la logique de dénomination reprise des versions précédentes de l’agent. Les contrôleurs « standard », avec toutes les annotations pertinentes présentes sur la classe réelle, seront toujours nommés en fonction de l'itinéraire et de la méthode HTTP.

Cette configuration existe dans l'agent Java version 8.9.0+.

Par défaut, le point de terminaison de l'actionneur intégré et le point de terminaison de l'actionneur personnalisé (utilisant l'annotation @endpoint et ses sous-classes) seront tous nommés OperationHandler/handle dans New Relic. L'activation de ce paramètre entraînera que le nom de la transaction reflétera l'URI du point de terminaison de l'actionneur de base réel. Par exemple, l'appel de /actuator/loggers ou actuator/loggers/com.newrelic entraînera le nom de transaction actuator/loggers (GET). Ceci est pour empêcher le MGI.

Pris en charge lors de l'utilisation de Spring Boot v3 et versions ultérieures.

Cette configuration existe dans l'agent Java version 8.15.0+.

Chaîne contenant le nom complet de la classe d'annotation que l'agent utilise pour déterminer les méthodes spécifiées par l'utilisateur à instrument. Pour plus d'informations sur les annotations personnalisées, consultez Collection de métriques personnalisées Java.

Activez cette option pour capturer le nom userPrincipal . Ce nom est inclus comme attribut de trace de transaction (avec les noms d'attribut user et enduser.id) et peut être interrogé. Cela vous permet également de voir dans la boîte de réception des erreurs combien d'utilisateurs sont impactés par un groupe d'erreurs.

Définissez ceci sur false pour désactiver le tracing distribué. Par exemple, dans le fichier de configuration, vous utiliseriez :

distributed_tracing:
  enabled: false

Voici d’autres options pour désactiver le tracing distribué :

Propriété du système:

-Dnewrelic.config.distributed_tracing.enabled=false

Variable environnementale :

NEW_RELIC_DISTRIBUTED_TRACING_ENABLED=false

Par défaut, les versions prises en charge de l'agent utilisent à la fois l'en-tête newrelic et les en-têtes W3C Trace Context pour le tracing distribué. L'en-tête distribué de tracing newrelic permet l'interopérabilité avec les agents plus anciens qui ne prennent pas en charge les en-têtes W3C Trace Context . les versions d'agent qui prennent en charge les en-têtes W3C Trace Context les prioriseront par rapport aux en-têtes newrelic pour le tracing distribué.

Si vous ne souhaitez pas utiliser l'en-tête newrelic, définissez-le sur true pour que l'agent exclue l'en-tête newrelic et utilise uniquement les en-têtes W3C Trace Context pour le tracing distribué.

Par exemple, pour exclure les en-têtes newrelic dans le fichier de configuration, vous utiliseriez :

distributed_tracing:
  exclude_newrelic_header: true

Pour exclure les en-têtes newrelic à l'aide d'une propriété système, vous devez utiliser :

-Dnewrelic.config.distributed_tracing.exclude_newrelic_header=true

Cette option définit comment l'agent doit gérer les intervalles d'échantillonnage lorsque leur parent d'intervalle d'une entité en amont a été échantillonné. Par exemple, la définition de remote_parent_sampled: always_on signifie que l'agent échantillonnera toujours tout ce qui est échantillonné par une entité en amont, jusqu'à ce que le réservoir d'échantillonnage soit plein. Les valeurs possibles sont :

• default: Utilisez les règles d'échantillonnage standard de New Relic.

• always_on: Échantillonnez toujours les étendues dont le parent en amont a été échantillonné.

• always_off: Ignorez toujours les intervalles d'échantillonnage dont le parent en amont a été échantillonné.

  distributed_tracing:
    sampler:
      remote_parent_sampled: default

  Copier

Cette option définit comment l'agent doit gérer les intervalles d'échantillonnage lorsque leur parent d'intervalle d'une entité en amont n'a pas été échantillonné. Par exemple, la définition de remote_parent_not_sampled: always_off signifie que l'agent n'essaiera pas d'échantillonner quoi que ce soit si l'entité en amont n'a pas échantillonné le parent. Les valeurs possibles sont :

• default: Utilisez les règles d'échantillonnage standard de New Relic.

• always_on: Échantillonnez toujours les étendues dont le parent en amont n'a pas été échantillonné.

• always_off: Ignorez toujours les intervalles d'échantillonnage dont le parent en amont n'a pas été échantillonné.

  distributed_tracing:
    sampler:
      remote_parent_not_sampled: default

  Copier

Activer la collecte des erreurs.

Les noms de classe d'exception spécifiés seront ignorés et n'affecteront pas le taux d'erreur ou le score Apdex, ni ne seront signalés à APM. Cannot be specified by system property.

Ce paramètre est dynamique, donc l'agent en cours d'exécution remarquera les modifications apportées à newrelic.yml sans redémarrage JVM .

Par exemple:

error_collector:
  ignore_classes:
    - "com.example.MyException"
    - "com.example.DifferentException"

Une variable d'environnement peut être utilisée pour répertorier les noms de classes d'exception que vous souhaitez ignorer :

NEW_RELIC_ERROR_COLLECTOR_IGNORE_CLASSES="[\"com.example.MyException\", \"com.example.DifferentException\"]"

Spécifiez les noms de classe d’exception que l’agent doit ignorer. Les messages ignorés n'affecteront pas le taux d'erreur ou le score Apdex, et ne seront pas signalés à APM. Contient yaml paires constituées de :

• Un nom de classe d'exception entièrement qualifié qui ne doit pas être signalé à APM

  AND

• Une liste d'exceptions messageà comparer (au moins une est obligatoire)

  Si le nom de la classe d'exception correspond à une erreur mais pas le message, alors cette erreur will not doit être ignorée. Les chaînes de message utilisent contains pour la correspondance. Un message ne peut pas être fourni seul et doit toujours être associé à un nom de classe complet. Cannot be specified by system property.

  Ce paramètre est dynamique, donc l'agent en cours d'exécution remarquera les modifications apportées à newrelic.yml sans redémarrage JVM .

  Par exemple:

  error_collector:
    ignore_messages:
      com.example.MyException:
        - "Some error message to ignore"
        - "Some other error message to ignore"
      com.example.DifferentException:
        - "Some different error message to ignore"

  Copier

  Une variable d'environnement peut être utilisée pour répertorier les noms de classes d'exception et les messages que vous souhaitez ignorer :

  NEW_RELIC_ERROR_COLLECTOR_IGNORE_MESSAGES="{\"com.example.MyException\": [\"Some error message to ignore\", \"Some other error message to ignore\"], \"com.example.DifferentException\": [\"Some different error message to ignore\"]}"

  Copier

Une liste séparée par des virgules composée de plages individuelles et en pointillés de codes d'état HTTP qui ne doivent pas être traités comme des erreurs.

Si cette propriété est placée en commentaire dans le fichier configuration newrelic.yml, alors le code d'état 404 sera automatiquement ignoré. Lors de l'utilisation de la configuration côté serveur, le code d'état 404 doit être spécifié pour qu'il soit ignoré.

Ce paramètre est dynamique, donc l'agent en cours d'exécution remarquera les modifications apportées à newrelic.yml sans redémarrage JVM .

Par exemple:

error_collector:
  ignore_status_codes: 404,507-511

Empêche les classes d'exception spécifiées d'affecter le taux d'erreur ou le score Apdex tout en signalant les erreurs à APM. Cannot be specified by system property.

Ce paramètre est dynamique, donc l'agent en cours d'exécution remarquera les modifications apportées à newrelic.yml sans redémarrage JVM .

Par exemple:

error_collector:
  expected_classes:
    - "com.example.MyException"
    - "com.example.DifferentException"

Une variable d'environnement peut être utilisée pour répertorier les noms de classe d'exception attendus :

NEW_RELIC_ERROR_COLLECTOR_EXPECTED_CLASSES="[\"com.example.MyException\", \"com.example.DifferentException\"]"

Contient des paires yaml constituées d'un nom de classe d'exception entièrement qualifié qui doit être marqué comme prévu et ainsi empêché d'affecter le taux d'erreur ou le score Apdex et une liste d'exceptions messageà comparer, dont au moins une est requise. Si le nom de la classe d'exception correspond à une erreur mais pas le message, alors cette erreur will not sera marquée comme attendue et affectera donc le taux d'erreur et le score Apdex.

Les chaînes de message utilisent contains pour la correspondance. Un message ne peut pas être fourni seul et doit toujours être associé à un nom de classe complet. Cannot be specified by system property.

Ce paramètre est dynamique, donc l'agent en cours d'exécution remarquera les modifications apportées à newrelic.yml sans redémarrage JVM .

Par exemple:

error_collector:
  expected_messages:
    com.example.MyException:
      - "Some expected error message"
      - "Some other expected error message"
    com.example.DifferentException:
      - "Some different expected error message"

Une variable d’environnement peut être utilisée pour répertorier les noms de classe et les messages d’exception attendus :

NEW_RELIC_ERROR_COLLECTOR_EXPECTED_MESSAGES="{\"com.example.MyException\": [\"Some error message to ignore\", \"Some other error message to ignore\"], \"com.example.DifferentException\": [\"Some different error message to ignore\"]}"

Une liste séparée par des virgules composée de plages individuelles et en pointillés de codes d'état HTTP à marquer comme prévu et ainsi à empêcher d'affecter le taux d'erreur ou le score Apdex.

Ce paramètre est dynamique, donc l'agent en cours d'exécution remarquera les modifications apportées à newrelic.yml sans redémarrage JVM .

Par exemple:

error_collector:
  expected_status_codes: 415,500-506

Les codes d'état attendus peuvent également être avec la variable d'environnement NEW_RELIC_ERROR_COLLECTOR_EXPECTED_STATUS_CODES .

Ce paramètre peut être utilisé pour activer ou désactiver tous les attributs pour les erreurs de trace. Si attributes.enabled est false au niveau racine, alors aucun attribut ne sera envoyé pour tracer les erreurs, quelle que soit la manière dont cette propriété est définie sous error_collector.

Si les attributs sont activés pour les erreurs de trace, toutes les clés d'attribut trouvées dans cette liste seront envoyées à New Relic dans les erreurs de trace. Pour plus d'informations, consultez les règles d'attribut de l'agent.

les clés d'attribut trouvées dans cette liste ne seront pas envoyées à New Relic en cas d'erreurs de trace. Pour plus d'informations, consultez les règles d'attribut de l'agent.

Lorsque plusieurs erreurs sont constatées dans une transaction, seule la dernière erreur sera signalée par défaut. La définition de cette propriété sur false signalera uniquement la première erreur détectée. Pour plus d'informations, consultez l'API noticeError. Par exemple:

error_collector:
  ignoreErrorPriority: false

Tous les noms de classe d’exception spécifiés ne seront pas traités comme des erreurs. Obsolète à partir de l'agent Java 3.40.0 et remplacé par ignore_classes.

Par exemple:

error_collector:
  ignore_errors: some.other.MyException

Ce paramètre peut être utilisé pour contrôler la collecte des URI de demande sortante pour les erreurs et le suivi des transactions. Définissez cette option sur vrai pour désactiver la collecte de ces informations.

Définissez un nom d'affichage pour décorer l'étiquette « hôte : port » dans l'UI de New Relic .

Si le nom d’hôte ne peut pas être déterminé, l’adresse IP de l’hôte sera utilisée. Cette propriété détermine si l'adresse IPv4 ou IPv6 doit être utilisée. La valeur par défaut est IPv4.

Pour obtenir de l'aide pour obtenir une entrée d'hôte d'observateur trace Infinite Tracing valide, consultez rechercher ou créer un observateur de trace.

Vous pouvez configurer cela via YAML :

infinite_tracing:
  trace_observer:
    host: YOUR_TRACE_OBSERVER_HOST

Vous pouvez également utiliser la propriété système newrelic.config.infinite_tracing.trace_observer.host ou la variable d’environnement NEW_RELIC_INFINITE_TRACING_TRACE_OBSERVER_HOST.

Par défaut, les annotations @TraceLambda sont désactivées. Pour utiliser la fonctionnalité d'annotation pour le tracing des méthodes lambda, vous devez activer explicitement la fonctionnalité comme suit :

Vous pouvez configurer cela via YAML :

instrumentation:
  trace_lambda:
    enabled: true

Vous pouvez également utiliser la propriété système newrelic.config.instrumentation.trace_lambda.enabled=true ou la variable d’environnement NEW_RELIC_INSTRUMENTATION_TRACE_LAMBDA_ENABLED.

Utilisé pour activer/désactiver la collecte et la création de rapports jar.

Utilisé pour activer/désactiver la collecte de fichiers jar temporaires. Les fichiers JAR temporaires sont ceux résidant dans le répertoire spécifié par la propriété système java.io.tmpdir.

Le nombre maximal de pots à traiter par seconde. Doit être positif.

Définissez sur true pour activer le profilage en temps réel avec JFR. Ce paramètre s'appliquera de manière dynamique et ne nécessite pas de redémarrage de la JVM.

Définissez sur true pour activer le logging d'audit qui affichera toutes les métriques et événements JFR dans chaque lot de récolte. Le logging d'audit est extrêmement détaillée et ne doit être utilisée qu'à des fins de dépannage.

Ce paramètre peut être utilisé pour activer ou désactiver toutes les fonctionnalités JMX.

Ce paramètre peut être activé pour permettre à l'agent Java d'exposer des métadonnées de liaison sur JMX distant.

Utilisé pour activer/désactiver obfuscation des propriétés JVM .

Si obfuscation est activé, lorsque la clé de propriété correspond à une valeur dans cette liste, la valeur ne sera pas obscurcie.

Les éléments de cette liste peuvent avoir des caractères génériques, * comme dernier caractère. Les conflits avec la liste de blocage sont résolus en suivant les règles d'attribut, où allow fonctionne comme include.

Si obfuscation est activé, lorsque la clé de propriété correspond à une valeur dans cette liste, la valeur sera obscurcie.

Les éléments de cette liste peuvent avoir des caractères génériques, * comme dernier caractère. Les conflits avec la liste de domaines autorisés sont résolus en suivant les règles d'attribut, où block fonctionne comme exclude.

Définissez sur true pour activer les logs principaux en fonction du contexte. Lorsque cette option est activée, de logging supplémentaire framework instrumentation est activée, que les logs soient ou non décorés ou envoyés à New Relic.

Définissez sur false pour désactiver complètement cette fonctionnalité, y compris la collecte des métriques log .

Permet l'envoi du log d'application à New Relic.

Réglez ceci sur true pour que votre log décoré soit envoyé à New Relic.

Réglez ceci sur false si vous ne souhaitez pas que votre log décoré soit envoyé à New Relic.

Un entier positif spécifiant le nombre maximal de lignes de log par minute à envoyer.

Définissez cette valeur sur 0 pour désactiver efficacement l’envoi du log.

Définissez cette valeur sur une valeur inférieure pour réduire la quantité de lignes log envoyées (peut provoquer un échantillonnage log ). Définissez cette valeur sur une valeur plus élevée pour envoyer plus de lignes log .

Chaque log reçoit la même priorité que sa transaction associée. Les logs qui se produisent en dehors d'une transaction recevront une priorité aléatoire. Certains logs peuvent ne pas être inclus car ils sont limités par max_samples_stored. Par exemple, si le logging max_samples_stored est définie sur 10 000 et que la transaction 1 comporte 10 000 entrées log, seules les entrées log de la transaction 1 seront enregistrées. Si la transaction 1 contient moins de 10 000 logs, vous recevez tous les logs de la transaction 1. S'il reste de la place, vous recevez l'intégralité du log de la transaction 2, et ainsi de suite.

Si après tout le log des transactions échantillonnées est enregistré et qu'elles n'ont pas atteint la limite de max_samples_stored, alors les messages de log des transactions qui n'étaient pas dans notre échantillonnage sont envoyés. S'il en reste, les messages de log en dehors des transactions sont enregistrés.

Active ou désactive l'ajout d'étiquettes par l'agent aux logs transmis à New Relic.

Une liste insensible à la casse de noms d'étiquettes à exclure lorsque les étiquettes de logs sont activées. Cet attribut ne prend pas en charge les caractères génériques ou les expressions régulières.

Définissez ceci sur true pour l'envoi de données de contexte en tant qu'attribut log à New Relic.

Définissez cette valeur sur false si vous ne souhaitez pas que les données de contexte du log soient envoyées à New Relic.

Si context_data est activé pour le transfert de log, toutes les clés d'attribut trouvées dans cette liste seront envoyées à New Relic dans les enregistrements log . Si cette liste est vide, tous les attributs seront envoyés.

Si context_data est activé pour le transfert de log, toutes les clés d'attribut trouvées dans cette liste ne seront PAS envoyées à New Relic dans les enregistrements log .

La liste d'inclusion et d'exclusion suit les règles Exclude overrides include, More specific rules take priority, Keys are case-sensitive et Use an asterisk for wildcards définies dans les règles d'attribut.

Permet la capture d'informations métriques sur votre log et votre niveau de log, qui sont affichées dans un graphique sur la page APM Summary.

Laissez ce paramètre sur true pour permettre à l'agent de capturer des informations métriques sur votre log.

Réglez ceci sur false pour désactiver cette fonctionnalité.

Cela contrôle si les lignes log stockées localement sont décorées ou non. Ceci est indépendant du fait que le transfert de logsoit activé ou non et est utilisé pour aider les clients qui souhaitent utiliser une solution de transfert de logdistincte.

Définissez cette valeur sur true pour que l'agent ajoute des logs en contexte liant les métadonnées aux lignes log stockées localement par l'infrastructure prise en charge.

Réglez ceci sur false pour désactiver la fonctionnalité de décoration locale. Cela n'aura aucun impact sur la décoration des lignes log envoyées à New Relic.

Réglez sur true pour faire rouler le log quotidiennement.

Le nombre maximal de fichiers de log à conserver lors de l'utilisation de la rotation log .

Le nom non qualifié du fichier de log ou la chaîne STDOUT qui sera log à la sortie standard.

Le chemin du fichier de log.

Le niveau de verbosité log . Lorsque vous modifiez ce paramètre dans le fichier de configuration yaml de l'agent, il sera mis à jour de manière dynamique. Cependant, la variable d'environnement et la propriété système ne seront pas mises à jour de manière dynamique.

L'agent utilise son propre fichier de log pour conserver son logging séparée de celle de votre application. Les options valides, par ordre de verbosité, sont :

• off

• severe

• warning

• info

• fine

• finer

• finest

  Prudence

  N'utilisez pas le logging debug ou trace à moins que le support New Relic ne vous demande de les utiliser. Ces niveaux de logging peuvent générer une surcharge excessive. Dans la plupart des situations, utilisez info.

  Ce paramètre est dynamique, donc l'agent en cours d'exécution remarquera les modifications apportées à newrelic.yml sans redémarrage JVM .

La taille du fichier log en kilo-octets à laquelle les fichiers log sont tournés. Réglez sur 0 pour aucune limite.

Ajoute des propriétés de message à l'attribut traceur. Réglez ceci sur false pour le désactiver.

Permet d'activer la fonctionnalité d'autoconfiguration du SDK OpenTelemetry de l'agent. Peut être défini via la propriété système :

-Dnewrelic.config.opentelemetry.sdk.autoconfigure.enabled=true

La valeur par défaut est vrai.

Pour désactiver complètement toutes les fonctionnalités de sécurité, définissez cet indicateur sur faux. Cette propriété est lue une seule fois au démarrage de l'application. La valeur par défaut est faux.

Détermine si les données de sécurité sont envoyées à New Relic ou non. Lorsque cette option est désactivée et que agent.enabled est vrai, le module de sécurité s'exécutera mais les données ne seront pas envoyées. La valeur par défaut est faux.

Mode de sécurité New Relic : IAST. La valeur par défaut est IAST. En raison de la nature invasive de l'analyse IAST, N'ACTIVEZ PAS ce mode dans un environnement de production ou dans un environnement où des données de production sont traitées.

URL de connexion SaaS de New Relic Security. Il s’agit du point de terminaison auquel l’agent de sécurité envoie les données. Il doit correspondre à l’environnement que vous avez défini pour l’agent Java APM.

Production américaine : wss\://csec.nr-data.net

Activez la détection des événements de sécurité RCI. La valeur par défaut est vrai.

Activez la détection des événements de sécurité RXSS. La valeur par défaut est vrai.

Activer la détection des événements de sécurité de désérialisation. La valeur par défaut est vrai.

Utilisé pour activer/désactiver la détection des transactions lentes.

Détermine le temps en millisecondes nécessaire à une transaction pour qu'un événement SlowTransaction soit signalé.

Si cette option est définie sur vrai, chaque transaction sera vérifiée pour vérifier si elle dépasse le seuil défini à la fin de la transaction. Notez que si un grand nombre de transactions dépasse le seuil, cela peut être coûteux en termes de calcul puisqu'une trace d'appels est envoyée à chaque événement SlowTransaction.

Utilisé pour activer/désactiver les rapports d'événements SPAN.

• Détermine le nombre d'événements span qui peuvent être capturés pendant un cycle de collecte agent . Disponible dans l'agent Java 7.4.0 et supérieur.

• Lors de la configuration de l'agent pour monitoring de l'IA, définissez la valeur maximale sur 10000. Garantit que la quantité maximale de traces soit capturée.

  Important

  L'augmentation du nombre d'événements SPAN peut entraîner une surcharge supplémentaire agent .

Ce paramètre peut être utilisé pour activer ou désactiver tous les attributs d'un événement SPAN. Si attributes.enabled au niveau racine est false, aucun attribut ne sera envoyé à l'événement span, quelle que soit la manière dont cette propriété (span_events.attributes.enabled) est définie.

Si les attributs sont activés pour l'événement SPAN, toutes les clés d'attribut trouvées dans cette liste seront envoyées à New Relic dans span_events. Pour plus d'informations, consultez les règles d'attribut de l'agent.

Toutes les clés d'attribut trouvées dans cette liste ne seront pas envoyées à New Relic lors de l'événement SPAN. Pour plus d'informations, consultez les règles d'attribut de l'agent.

Par défaut, cette valeur est définie sur false, ce qui signifie que l'agent envoie les messages de toutes les exceptions au collecteur New Relic.

• Si vous définissez cette valeur sur true, l'agent supprime les messages des exceptions afin d'éviter de capturer par inadvertance des informations sensibles.
• Si vous activez le mode haute sécurité, celui-ci est automatiquement défini sur true.
• Si vous définissez enabled sur true mais que vous souhaitez que l'agent capture les messages provenant d'exceptions spécifiques, ajoutez les exceptions à votre liste de domaines autorisés.

Si vous définissez enabled sur true mais que vous souhaitez que l'agent capture les messages pour des exceptions spécifiques, ajoutez chaque exception à whitelist, séparée par une virgule.

Si vous définissez enabled sur true mais que vous souhaitez que l'agent capture les messages pour des exceptions spécifiques, ajoutez chaque exception à allowed_classes, séparée par une virgule.

Activer le profileur de thread.

Activez le service transaction événement.

Le nombre maximal d'événements de transaction échantillonnés signalés toutes les 60 secondes.

Une liste de cartes avec les clés appariées header_name et l'optionnelle header_alias. Choisissez un ou plusieurs en-têtes de requête HTTP personnalisés à ajouter comme attribut de transaction.

Vous pouvez répertorier plusieurs configurations d’en-tête :

transaction_events:
  custom_request_headers:
    -
      header_name: "X-Custom-Header-1"
    -
      header_name: "X-Custom-Header-2"
      header_alias: "CustomHeader2alias"

Dans le premier ensemble de cartes, X-Custom-Header-1 est capturé et signalé par l'agent comme nom d'en-tête pour une valeur correspondante de l'objet de demande. Le header_name sera également le nom de l'attribut envoyé à New Relic.

Dans le deuxième ensemble de cartes, l'en-tête de la requête est X-Custom-Header-2, mais CustomHeader2alias est le nom envoyé à New Relic.

Ce paramètre peut être utilisé pour activer ou désactiver tous les attributs d'un événement de transaction. Si attributes.enabled est false au niveau racine, alors aucun attribut ne sera envoyé à l'événement de transaction, quelle que soit la manière dont cette propriété est définie sous transaction_events.

Si les attributs sont activés pour l'événement de transaction, toutes les clés d'attribut trouvées dans cette liste seront envoyées à New Relic dans l'événement de transaction. Pour plus d'informations, consultez les règles d'attribut de l'agent.

Toutes les clés d'attribut trouvées dans cette liste ne seront pas envoyées à New Relic dans l'événement de transaction. Pour plus d'informations, consultez les règles d'attribut de l'agent.

Ce paramètre peut être utilisé pour activer ou désactiver tous les attributs des segments de transaction. Si attributes.enabled au niveau racine est false, aucun attribut ne sera envoyé aux segments de transaction, quelle que soit la manière dont cette propriété (transaction_segments.attributes.enabled) est définie.

Si les attributs sont activés pour les segments de transaction, toutes les clés d'attribut trouvées dans cette liste seront envoyées à New Relic dans les segments de transaction. Pour plus d'informations, consultez les règles d'attribut de l'agent.

Toutes les clés d’attribut trouvées dans cette liste ne seront pas envoyées à New Relic dans les segments de transaction. Pour plus d'informations, consultez les règles d'attribut de l'agent.

Le traceur de transaction est activé par défaut. Réglez ceci sur false pour le désactiver.

Détermine si l'agent capturera le plan EXPLAIN pour la requête lente. Uniquement pris en charge pour MySQL et PostgreSQL.

seuil en secondes pour le temps d'exécution de la requête en dessous duquel la lente de la requête et le plan EXPLAIN (si supporté) ne seront pas capturés. Concerne la requête lente uniquement lorsque record_sql est défini sur raw ou obfuscated. Concerne les plans EXPLAIN uniquement lorsque explain_enabled est défini sur true.

La limite de caractères pour la chaîne de requête SQL. Si vous avez de nombreuses requêtes SQL lentes avec de gros morceaux d'informations, cela pourrait affecter négativement les performances ou la rapidité avec laquelle vous voyez vos données dans New Relic. Augmentez progressivement la valeur jusqu’à trouver le bon équilibre entre informations et performances.

Définissez sur true pour activer le logging de la requête dans le agent fichier de au log lieu du téléchargement vers New Relic. les requêtes sont enregistrées en utilisant le mode record_sql .

Lorsque le traceur de transaction est activé, les instructions de requête peuvent éventuellement être enregistrées. L'enregistreur dispose de trois modes :

• off: N'envoyez aucune requête.
• raw: Envoyez l'instruction de requête dans sa forme originale.
• obfuscated: Supprime les littéraux numériques et les chaînes.

Cette option est réservée à Play 2.x+ uniquement. L'instrumentation Play/Scala peut utiliser Thread.getStackTrace() pour améliorer la dénomination du traceur, mais au prix d'une surcharge accrue.

Définit un seuil (en secondes) pour collecter la trace d'appels d'un appel SQL. Lorsque les instructions SQL dépassent ce seuil, l'agent capturera la trace d'appels en cours. Cela est utile pour identifier l’origine des appels SQL longs.

Utilisez ce paramètre pour contrôler la variété de votre trace de transaction. top_n est un entier qui représente le nombre de transactions uniques et lentes pour lesquelles une trace sera créée.

• Si vous souhaitez que le suivi des transactions reflète plus précisément les transactions les plus lentes de votre application, définissez cette valeur sur lower.

• Si vous souhaitez échantillonner un éventail plus diversifié de transactions, définissez la valeur higher.

  Une valeur de 0 signifie que only la transaction la plus lente est toujours tracée. Cela n'est toutefois pas considéré comme optimal, car vous pouvez avoir une ou deux transactions qui sont toujours les plus lentes, et voir à plusieurs reprises ces mêmes traces de transaction ne vous apportera probablement pas beaucoup de valeur.

  Si la même transaction est souvent la plus lente, le paramètre top_n permet à l'agent Java (au fil du temps) d'échantillonner les transactions n les plus lentes. Cela vous donne une plus grande variété et des informations plus détaillées dans votre application.

Le seuil de temps utilisé pour déterminer quand une transaction est éligible au tracing. Lorsque le temps de réponse de la transaction dépasse ce seuil, une trace de transaction sera enregistrée et envoyée à New Relic.

La valeur par défaut est apdex_f (par défaut), ce qui définit le seuil sur le niveau Apdex « Frustré » (quatre fois la apdex_t valeur ). Vous pouvez également définir un seuil de temps spécifique en saisissant une valeur de virgule flottante qui représente un nombre de secondes.

Par défaut, le mode haute sécurité ne permet pas à l'agent de collecter les requêtes lentes. Activez cette option pour collecter les requêtes Cassandra du pilote DataStax, même avec une sécurité élevée activée. Si vous n'utilisez pas une sécurité élevée, l'agent collecte automatiquement les requêtes lentes.

Pour le pilote DataStax 2.1.2, ajoutez cette règle à votre liste de domaines autorisés :

transaction_tracer:
  slow_query_whitelist:
    'com.newrelic.instrumentation.cassandra-datastax-2.1.2'

Pour le pilote DataStax 3.0.0, ajoutez cette règle à votre liste de domaines autorisés :

transaction_tracer:
  slow_query_whitelist:
    'com.newrelic.instrumentation.cassandra-datastax-3.0.0'

Par défaut, le mode haute sécurité ne permet pas à l'agent de collecter les requêtes lentes. Activez cette option pour collecter les requêtes Cassandra du pilote DataStax, même avec une sécurité élevée activée. Si vous n'utilisez pas une sécurité élevée, l'agent collecte automatiquement les requêtes lentes.

Pour le pilote DataStax 2.1.2, ajoutez cette règle à votre liste de domaines autorisés :

transaction_tracer:
  collect_slow_queries_from:
    'com.newrelic.instrumentation.cassandra-datastax-2.1.2'

Pour le pilote DataStax 3.0.0, ajoutez cette règle à votre liste de domaines autorisés :

transaction_tracer:
  collect_slow_queries_from:
    'com.newrelic.instrumentation.cassandra-datastax-3.0.0'

Ce paramètre peut être utilisé pour activer ou désactiver tous les attributs de suivi de transaction. Si attributes.enabled au niveau racine est false, aucun attribut ne sera envoyé pour tracer la transaction, quelle que soit la manière dont cette propriété (transaction_tracer.attributes.enabled) est définie.

Si les attributs sont activés pour le suivi de transaction, toutes les clés d'attribut trouvées dans cette liste seront envoyées à New Relic dans le suivi de transaction. Pour plus d'informations, consultez les règles d'attribut de l'agent.

Toutes les clés d'attribut trouvées dans cette liste ne seront pas envoyées à New Relic lors de la trace de la transaction. Pour plus d'informations, consultez les règles d'attribut de l'agent.

Limite le nombre de jetons pouvant être créés par transaction. L’augmentation de cette valeur peut avoir un impact sur les performances, car elle augmente la quantité de mémoire utilisée par l’agent et la quantité de données envoyées à New Relic.

Limite le nombre de segments pouvant être créés par transaction. L’augmentation de cette valeur peut avoir un impact sur les performances, car elle augmente la quantité de mémoire utilisée par l’agent et la quantité de données envoyées à New Relic.