Додавання до реєстру

Ви підтримуєте або берете участь в інтеграції для OpenTelemetry? Ми б хотіли розмістити ваш проєкт у реєстрі!

Щоб додати свій проєкт, надішліть pull request. Вам потрібно буде створити файл даних у data/registry для вашого проєкту, використовуючи наступний шаблон: registry-entry.yml.

Переконайтеся, що назви та описи ваших проєктів відповідають нашим настановам з маркетингу, а також брендингу Linux Foundation та настановам з використання торгових марок.

Типи реєстрів

Додаючи проєкт до реєстру, потрібно вказати registryType. Це поле класифікує проєкт на основі його звʼязку з OpenTelemetry. Нижче наведено можливі значення та їхні визначення:

application integration

Використовується для: Застосунків або служб, які мають вбудовану підтримку OpenTelemetry (вбудована підтримка) без необхідності використання зовнішніх втулків або бібліотек інструментування.

Приклади: Дивіться список вбудованих інтеграцій застосунків на сторінці Інтеграції.

core

Використовується для: Основних компонентів проєкту OpenTelemetry. Це ніколи не застосовується до компонентів третіх сторін або не компонентів проєкту OpenTelemetry.

exporter

Використовується для: Експортерів OpenTelemetry Collector або бібліотек експортерів у рамках специфічних SDK.

Приклади: OTLP експортери, Prometheus експортери або будь-який компонент, який надсилає телеметричні дані до зовнішніх систем.

Примітка: Не застосовується до сторонніх компонентів, які експортують телеметрію.

extension

Використовується для: Розширень Collector або SDK, які розширюють функціональність OpenTelemetry.

Приклади: Автентифікатори, джерела/постачальники конфігурацій, виявлення сервісів, перевірки стану/pprof/zpages або інші компоненти, які доповнюють поведінку Collector/SDK.

instrumentation

Використовується для: Бібліотек інструментування або нативного інструментування для специфічних бібліотек/фреймворків.

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

log-bridge

Використовується для: Адаптерів, специфічних для мови, які зʼєднують наявні фреймворки/API для ведення логів з веденням логів OpenTelemetry, що дозволяє застосункам надавати логи OTel через знайомі API для ведення журналів.

Приклади: Мости/обробники/доповнювачі для фреймворків, таких як Java SLF4J/Log4j/Logback, Python logging, JavaScript Winston/Pino та Go log/slog/zap.

processor

Використовується для: Компонентів процесорів OpenTelemetry Collector.

Приклади: Пакетні процесори, процесори атрибутів, процесори вибірки або будь-які компоненти, що обробляють телеметричні дані в конвеєрі колектора.

provider

Використовується для: Компонентів постачальників OpenTelemetry Collector.

Приклади: Провайдери конфігурації, провайдери облікових даних або будь-який компонент, що надає ресурси або конфігурацію колектору.

receiver

Використовується для: Компонентів приймача OpenTelemetry Collector.

Приклади: Приймачі OTLP, приймачі Prometheus або будь-які компоненти, що отримують телеметричні дані із зовнішніх джерел.

resource-detector

Використовується для: Виявлення ресурсів для конкретних мовних SDK.

Приклади: Детектори ресурсів AWS, детектори ресурсів GCP або будь-який компонент, який автоматично виявляє та додає інформацію про ресурси до телеметрії.

utilities

Використовується для: Будь-якого іншого інструменту, який люди можуть використовувати для роботи з OpenTelemetry.

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