Définir une dimension de ressource

Une fois l'agent Java APM déployé, vous pouvez définir la dimension de ressource de 2 façons différentes :

Définition de ressource simplifiée

La dimension de ressource simplifiée peut être définie avec des propriétés de paire clé/valeur.

La clé de la propriété doit commencer par com.oracle.apm.agent.resource.tag.

Le tableau suivant présente différentes méthodes de définition simplifiée de la dimension Ressource :

Type et description de propriété Pris en charge par Propriété Exemple

AgentConfig.properties

Mettez à jour le fichier AgentConfig.properties situé sous le répertoire oracle-apm-agent/config/<version>.

Agent APM com.oracle.apm.agent.resource.tag.<ResourceName> com.oracle.apm.agent.resource.tag.MyDepartment=Sales

Propriétés système

Mettez à jour les propriétés système.

Agent APM et traceur APM com.oracle.apm.agent.resource.tag.<ResourceName>

-Dcom.oracle.apm.agent.resource.tag.MyDepartment=Sales

-Dcom.oracle.apm.agent.resource.tag.MyUser=${USERNAME}

-Dcom.oracle.apm.agent.resource.tag.MyAppVersion=${com.mycompany.myapp.version}

Variables d'environnement

Mettez à jour les variables d'environnement.

Agent APM et traceur APM com_oracle_apm_agent_resource.tag_<ResourceName>
Pour Windows :
set com_oracle_apm_agent_resource_tag_MyDepartment=Sales
set com.oracle.apm.agent.resource.tag.MyUser=${USERNAME}
Pour Linux :
export com_oracle_apm_agent_resource_tag_MyDepartment=Sales

Générateur de trace

Traceur APM com.oracle.apm.agent.resource.tag.<ResourceName>
new ApmTracer.Builder(...)
    ...
    .withProperty("com.oracle.apm.agent.resource.tag.MyDepartment", "Sales")
    .withProperty("com.oracle.apm.agent.resource.tag.MyUser", "${USERNAME}")
    ...
    .build();

La valeur de la propriété de ressource peut être un texte statique et/ou une variable entourée de symboles ${ et }.

Une ou plusieurs des valeurs suivantes sont acceptées en tant que valeur de dimension de ressource :
  • Tout texte.
  • Clé des propriétés système Java entourées de symboles ${ et }.
  • Clé des variables d'environnement entourées de symboles ${ et }. Par exemple :
    ${USERNAME}

Définition de ressource complète

Vous pouvez définir une dimension de ressource de serveur d'applications personnalisé pour répondre à des exigences spécifiques.

Pour définir une dimension de ressource de serveur d'applications personnalisée, créez un fichier de configuration nommé ResourceCollection.acml dans le répertoire oracle-apm-agent/config/<version>.

Le fichier ResourceCollection.acml n'est pas créé par le déploiement d'agent APM et doit être créé manuellement.

Le format de ResourceCollection.acml est un format ACML personnalisé (sous-ensemble de YAML).

Balise ACML Type de données Requis Description
RESSOURCES :   oui En-tête d'ensemble de ressources.
<resource_entry_name> : chaîne oui Nom de la ressource de reporting.
propriété : <property key> chaîne oui Clé de propriété APM de la ressource.

Clé de propriété de cette valeur de ressource. Il est également utilisé par d'autres ressources pour la résolution de variables.

type : <resource type> chaîne oui Type de cette propriété.
scalaire : <resource scalar> chaîne oui Type de valeur de la ressource.

Les valeurs prises en charge sont String, Long ou Double.

identité : <resource as identity> Booléen Non Indicateur signalant si cette ressource est utilisée pour le calcul de l'identité du serveur d'applications.

Toute ressource avec une valeur non NULL est utilisée pour le calcul de dimension appserverId.

priorité : <collection Priority> entier non signé Non Nombre entier positif indiquant la priorité de collecte de ressources. 0 (zéro) est la priorité la plus élevée. La ressource personnalisée doit toujours définir cette valeur sur 0.
par défaut : <valeur par défaut> chaîne Non Valeur par défaut de la ressource lorsqu'aucune des sources spécifiées ne renvoie une valeur non NULL.
source: Non applicable oui Noeud de tableau des sources de cette ressource.

Un ou plusieurs éléments enfant peuvent être définis pour ce tableau source. Chaque élément est évalué dans l'ordre défini et le premier avec une valeur non NULL est utilisé.

Si aucune évaluation d'élément n'a renvoyé une valeur autre que NULL, cette ressource est ignorée.
- tapez : mbean chaîne Non Collecter les métadonnées de ressource à partir du MBean JMX. Plusieurs peuvent être définis pour chaque ressource.
mbean_name : <mbean object name> chaîne Non mbean_name est le ObjectName du MBean.
value_path : <chemin de sélection de valeur> chaîne Non

value_path est le chemin de sélection délimité par des barres obliques commençant par le MBean spécifié.

Le premier noeud de chemin est l'attribut du MBean, puis la valeur de l'attribut est évaluée avec chaque noeud de chemin successif.

L'évaluation prend en charge les éléments suivants :

  • Attribut MBean
  • ObjectName
  • Nom de champ d'objet Java
  • nom de la méthode no-arg d'objet java
  • Clé de CompositeData
  • Clé de TubularData
  • Index du tableau
  • Clé de la carte
  • Index de la collecte
<analyse de l'expression régulière> chaîne Non

La valeur de ressource sélectionnée peut être traitée ultérieurement à l'aide de balises d'analyse d'expression régulière. Pour plus d'informations, reportez-vous à Analyse régulière.

type : property chaîne Non Valeur de ressource de la propriété système ou de la variable d'environnement. Plusieurs peuvent être définis pour chaque ressource.
clé : <property key> chaîne Non Nom de clé de la propriété système ou de la variable d'environnement.
- type : value chaîne Non Valeur statique. Vous devez en définir au maximum une dans chaque ressource car cette valeur n'est jamais NULL.
valeur : <valeur statique et/ou variable> chaîne Non Les valeurs possibles sont les suivantes :
  • Chaîne fixe.
  • Propriété système.
  • Variable d'environnement.
  • Propriété de ressource.

Les clés de propriétés contiennent les symboles ${ et } qui seront résolus lors de l'exécution en une valeur de clé spécifiée. Si la clé de propriété spécifiée est introuvable, la valeur de cette ressource contiendra la clé non résolue, y compris les symboles ${ et }.

<analyse de l'expression régulière> chaîne Non La valeur de ressource sélectionnée peut être traitée ultérieurement à l'aide de balises d'analyse d'expression régulière. Pour plus d'informations, reportez-vous à Analyse régulière.

Analyse d'expression régulière

L'analyse d'expression régulière est une balise supplémentaire du noeud source permettant d'extraire une valeur de ressource spécifique avec une expression régulière. Pour des détails sur la syntaxe, reportez-vous aux sections suivantes :

Indicateur Type de base Description
regex : <regex : : chaîne Expression régulière par rapport à la valeur de ressource avec construction de groupe.
<analyse de l'expression régulière> entier non signé Numéro de groupe de l'expression régulière. La valeur du groupe spécifié est la valeur de ressource finale.