На основі коду

Імпорт API та SDK OpenTelemetry

Спочатку вам потрібно імпортувати OpenTelemetry у ваш код. Якщо ви розробляєте бібліотеку або інший компонент, який призначений для використання виконуваним бінарним файлом, то вам потрібно буде взяти залежність тільки від API. Якщо ваш артефакт є автономним процесом або сервісом, то вам потрібно буде взяти залежність від API та SDK. Для отримання додаткової інформації про API та SDK OpenTelemetry, дивіться специфікацію.

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

Щоб створювати трасування або метрики, спочатку потрібно створити провайдера трасувальника та/або лічильника. Загалом, ми рекомендуємо, щоб SDK стандартно надавав єдиного провайдера для цих обʼєктів. Потім ви отримаєте екземпляр трасувальника або лічильника від цього провайдера і надасте йому імʼя та версію. Імʼя, яке ви виберете, повинно ідентифікувати, що саме інструментується — якщо ви пишете бібліотеку, наприклад, то ви повинні назвати її на честь вашої бібліотеки (наприклад, com.example.myLibrary), оскільки це імʼя буде іменем простору для всіх створених відрізків або подій метрик. Також рекомендується вказати рядок версії (тобто, semver:1.0.0), який відповідає поточній версії вашої бібліотеки або сервісу.

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

Якщо ви створюєте сервісний процес, вам також потрібно буде налаштувати SDK з відповідними параметрами для експорту ваших телеметричних даних до якоїсь аналітичної бекенд-системи. Ми рекомендуємо, щоб це налаштування виконувалося програмно через конфігураційний файл або інший механізм. Також є параметри налаштування для кожної мови програмування, які ви можете використовувати.

Створення даних телеметрії

Після налаштування API та SDK ви зможете створювати трасування та події метрик через обʼєкти трасувальника та лічильника, отримані від провайдера. Використовуйте бібліотеки інструментування для ваших залежностей — перегляньте реєстр або репозиторій вашої мови програмування для отримання додаткової інформації про них.

Експорт даних

Після створення даних телеметрії ви захочете відправити їх кудись. OpenTelemetry підтримує два основні методи експорту даних з вашого процесу до аналітичної бекенд-системи: безпосередньо з процесу або через проксі-сервер OpenTelemetry Collector.

Експорт у процесі вимагає імпорту та залежності від одного або більше експортерів, бібліотек, які перетворюють обʼєкти відрізків та метрик OpenTelemetry в памʼяті у відповідний формат для інструментів аналізу телеметрії, таких як Jaeger або Prometheus. Крім того, OpenTelemetry підтримує протокол передачі даних, відомий як OTLP, який підтримується всіма SDK OpenTelemetry. Цей протокол можна використовувати для надсилання даних до OpenTelemetry Collector, автономного бінарного процесу, який може працювати як проксі або sidecar для ваших екземплярів сервісу або на окремому хості. Collector потім можна налаштувати для пересилання та експорту цих даних до вибраних вами інструментів аналізу.

Крім відкритих інструментів, таких як Jaeger або Prometheus, список, що зростає, компаній які підтримують отримання даних телеметрії від OpenTelemetry. Для деталей дивіться Постачальники.