Configuration
Cette page décrit les différentes manières dont la configuration peut être fournie à l’agent Java. Pour des informations sur les options de configuration elles-mêmes, consultez Configurer le SDK.
Configuration de l’agent
L’agent peut trouver sa configuration d’une ou plusieurs des sources suivantes (classées de la plus haute à la plus basse priorité) :
- Propriétés système
- Variables d’environnement
- Fichier de configuration
- Propriétés fournies par la fonction
AutoConfigurationCustomizer#addPropertiesSupplier(); en utilisant l’interface de prestation de service (SPI)AutoConfigurationCustomizerProvider
Configurer avec des variables d’environnement
Dans certains environnements, la configuration des paramètres via des variables d’environnement est souvent préférée. Tout paramètre qui peut être configuré en utilisant une propriété système peut également être défini en utilisant une variable d’environnement. Bien que de nombreux paramètres ci-dessous fournissent des exemples pour les deux formats, pour ceux qui ne le font pas, utilisez les étapes suivantes pour déterminer le mappage de nom correct pour la propriété système souhaitée :
- Convertissez le nom de la propriété système en majuscules.
- Remplacez tous les caractères
.et-par_.
Par exemple, otel.instrumentation.common.default-enabled se convertirait en
OTEL_INSTRUMENTATION_COMMON_DEFAULT_ENABLED.
Fichier de configuration
Vous pouvez fournir un chemin vers un fichier de configuration d’agent en définissant la propriété suivante :
System property:
otel.javaagent.configuration-file
Environment variable:
OTEL_JAVAAGENT_CONFIGURATION_FILEDescription: Chemin vers un fichier de propriétés Java valide qui contient la configuration de l'agent.
Extensions
Vous pouvez activer les extensions en définissant la propriété suivante :
System property:
otel.javaagent.extensions
Environment variable:
OTEL_JAVAAGENT_EXTENSIONSDescription: Chemin vers un fichier jar d'extension ou un dossier contenant des fichiers jar. Si vous pointez vers un dossier, chaque fichier jar dans ce dossier sera traité comme une extension distincte et indépendante.
Sortie de journalisation de l’agent Java
La sortie de journalisation de l’agent peut être configurée en définissant la propriété suivante :
System property:
otel.javaagent.logging
Environment variable:
OTEL_JAVAAGENT_LOGGINGDescription: L'agent Java supporte ces 3 modes de journalisation :
simple: L'agent imprimera ses journaux en utilisant le flux d'erreur standard. Seuls les journaux de niveauINFOou supérieur seront imprimés. C'est le mode de journalisation par défaut de l'agent Java.none: L'agent ne journalisera rien - pas même sa propre version.application: L'agent tentera de rediriger ses propres journaux vers le logger slf4j de l'application instrumentée. Cela fonctionne le mieux pour les applications simples à un seul jar qui n'utilisent pas plusieurs chargeurs de classe (Classloader) ; les applications Spring Boot sont également supportées. La sortie des journaux de l'agent Java peut être configurée davantage en utilisant la configuration de journalisation de l'application instrumentée (par exemplelogback.xmloulog4j2.xml). Assurez-vous de tester que ce mode fonctionne pour votre application avant de l'exécuter dans un environnement de production.
Configuration du SDK
Le module d’autoconfiguration du SDK est utilisé pour la configuration de base de l’agent. Lisez la documentation pour trouver des paramètres tels que la configuration de l’exportation ou de l’échantillonnage.
Contrairement à l’autoconfiguration du SDK, les versions 2.0+ de l’agent Java et
du Spring Boot Starter OpenTelemetry utilisent http/protobuf comme protocole
par défaut, et non grpc.
Activer les fournisseurs de ressources qui sont désactivés par défaut
En plus de la configuration des ressources de l’autoconfiguration du SDK, vous pouvez activer des fournisseurs de ressources supplémentaires qui sont désactivés par défaut :
System property:
otel.resource.providers.aws.enabled
Environment variable:
OTEL_RESOURCE_PROVIDERS_AWS_ENABLEDDefault: false
Description:
Active le
fournisseur de ressources AWS.
System property:
otel.resource.providers.gcp.enabled
Environment variable:
OTEL_RESOURCE_PROVIDERS_GCP_ENABLEDDefault: false
Description:
Active le
fournisseur de ressources GCP.
System property:
otel.resource.providers.azure.enabled
Environment variable:
OTEL_RESOURCE_PROVIDERS_AZURE_ENABLEDDefault: false
Description:
Active le
fournisseur de ressources Azure.
Feedback
Cette page est-elle utile?
Thank you. Your feedback is appreciated!
Please let us know how we can improve this page. Your feedback is appreciated!