Початок роботи

Налаштування

1. Завантажте opentelemetry-javaagent.jar з Releases репозиторію opentelemetry-java-instrumentation і розмістіть JAR у вашій улюбленій теці. Файл JAR містить агент та бібліотеки інструментування.
2. Додайте -javaagent:path/to/opentelemetry-javaagent.jar та інші налаштування до аргументів запуску JVM і запустіть ваш застосунок:

   • Безпосередньо командою запуску:

     java -javaagent:path/to/opentelemetry-javaagent.jar -Dotel.service.name=your-service-name -jar myapp.jar
     

   • Через JAVA_TOOL_OPTIONS та інші змінні середовища:

     export JAVA_TOOL_OPTIONS="-javaagent:path/to/opentelemetry-javaagent.jar"
     export OTEL_SERVICE_NAME="your-service-name"
     java -jar myapp.jar
     

Декларативна конфігурація

Декларативна конфігурація використовує файл YAML замість змінних середовища або властивостей системи. Це корисно, коли потрібно встановити багато параметрів конфігурації або якщо ви хочете використовувати параметри конфігурації, які недоступні як змінні середовища або властивості системи.

Докладнішу інформацію дивіться на сторінці Декларативна конфігурація.

Налаштування агента

Агент має широкі можливості для налаштування.

Один з варіантів — передати властивості конфігурації через прапорець -D. У цьому прикладі налаштовано імʼя сервісу та експортер Zipkin для трейсів:

java -javaagent:path/to/opentelemetry-javaagent.jar \
     -Dotel.service.name=your-service-name \
     -Dotel.traces.exporter=zipkin \
     -jar myapp.jar

Ви також можете використовувати змінні середовища для налаштування агента:

OTEL_SERVICE_NAME=your-service-name \
OTEL_TRACES_EXPORTER=zipkin \
java -javaagent:path/to/opentelemetry-javaagent.jar \
     -jar myapp.jar

Ви також можете використовувати файл властивостей Java і завантажувати значення конфігурації звідти:

java -javaagent:path/to/opentelemetry-javaagent.jar \
     -Dotel.javaagent.configuration-file=path/to/properties/file.properties \
     -jar myapp.jar

або

OTEL_JAVAAGENT_CONFIGURATION_FILE=path/to/properties/file.properties \
java -javaagent:path/to/opentelemetry-javaagent.jar \
     -jar myapp.jar

Щоб побачити повний спектр параметрів конфігурації, дивіться Конфігурація агента.

Підтримувані бібліотеки, фреймворки, сервіси додатків та JVM

Java-агент постачається з бібліотеками інструментування для багатьох популярних компонентів. Для повного списку дивіться Підтримувані бібліотеки, фреймворки, сервіси додатків та JVM.

Розвʼязання проблем

Наступні кроки

Після того, як ви налаштували автоматичне інструментування для вашого застосунку або сервісу, ви можете захотіти анотувати вибрані методи або додати ручне інструментування для збору власних даних телеметрії.