Налаштування експорту даних OBI Prometheus та OpenTelemetry

OBI може експортувати метрики та трейси OpenTelemetry до точки доступу OTLP.

Загальна конфігурація метрик

Розділ YAML: metrics.

Розділ metrics містить загальну конфігурацію для експортерів метрик та трасування OpenTelemetry.

Наразі він підтримує вибір різних наборів метрик для експорту.

Приклад:

metrics:
  features: ['network', 'network_inter_zone']

Обʼєкти експорту метрик

Експортер метрик OBI може експортувати наступні групи даних метрик для процесів, що відповідають записам у конфігурації metrics discovery.

• application: Метрики на рівні застосунку.
• application_host: Метрики хосту на рівні застосунку для тарифікації на основі хосту.
• application_span: метрики відрізків трасування на рівні застосунку в застарілому форматі (наприклад, traces_spanmetrics_latency); spanmetrics не є окремим.
• application_span_otel: метрики відрізків трасування на рівні застосунку в форматі OpenTelemetry (наприклад, traces_span_metrics_calls_total); span_metrics є окремим.
• application_span_sizes: метрики відрізків трасування на рівні застосунку, що повідомляють інформацію про розміри запитів і відповідей.
• application_service_graph: метрики графіків сервісів на рівні застосунку. Рекомендується використовувати DNS для виявлення сервісів і переконатися, що імена DNS відповідають іменам сервісів OpenTelemetry, які використовує OBI. У середовищах Kubernetes найкращим вибором для метрик графіків сервісів є імʼя сервісу OpenTelemetry, встановлене виявленням імені сервісу.
• network: Метрики на рівні мережі. Для отримання додаткової інформації див. документацію з конфігурації мережевих метрик.
• network_inter_zone: Метрики міжзональних мереж. Для отримання додаткової інформації див. документацію з конфігурації мережевих метрик.

Функції експорту метрик для кожного застосунку

Крім того, OBI дозволяє перевизначити глобальні функції експорту метрик на рівні кожного застосунку, додавши metrics > features як властивість до кожного запису discovery > instrument.

Наприклад, у наступній конфігурації:

• Екземпляри сервісів apache, nginx і tomcat експортуватимуть лише метрики application_service_graph (як визначено у глобальній конфігурації metrics > features).

• Сервіс pyserver експортуватиме лише групу метрик application.

• Сервіси, що прослуховують порти 3030 або 3040, експортуватимуть групи метрик application, application_span і application_service_graph.

metrics:
  features: ['application_service_graph']
discovery:
  instrument:
    - open_ports: 3030,3040
      metrics:
        features:
          - 'application'
          - 'application_span'
          - 'application_service_graph'
    - name: pyserver
      open_ports: 7773
      metrics:
        features:
          - 'application'
    - name: apache
      open_ports: 8080
    - name: nginx
      open_ports: 8085
    - name: tomcat
      open_ports: 8090

Компонент експорту метрик OpenTelemetry

Секція YAML: otel_metrics_export

Увімкніть компонент експорту метрик OpenTelemetry, встановивши атрибут endpoint у вашому конфігураційному файлі або через змінну середовища, зверніться до опцій конфігурації експорту метрик.

Налаштуйте компонент у секції otel_metrics_export вашого YAML-конфігураційного файлу або через змінні середовища.

На додачу до конфігурації, задокументованої в цій статті, компонент підтримує змінні середовища з стандартної конфігурації експортерів OpenTelemetry.

Наприклад:

otel_metrics_export:
  ttl: 5m
  endpoint: http://otelcol:4318
  protocol: grpc
  buckets:
    duration_histogram: [0, 1, 2]
  histogram_aggregation: base2_exponential_bucket_histogram

Протокол експорту метрик

Якщо ви не встановите протокол, OBI встановлює протокол наступним чином:

• grpc: якщо порт закінчується на 4317, наприклад 4317, 14317 або 24317.
• http/protobuf: якщо порт закінчується на 4318, наприклад 4318, 14318 або 24318.

Метрики інструментації

Список областей інструментації, з яких OBI може збирати дані:

• *: всі інструментації, якщо * присутній, OBI ігнорує інші значення
• http: HTTP/HTTPS/HTTP/2 метрики застосунків
• grpc: gRPC метрики застосунків
• sql: SQL метрики викликів клієнтів бази даних
• redis: Redis метрики клієнтів/серверів бази даних
• kafka: Kafka метрики клієнтів/серверів черг повідомлень
• gpu: метрики продуктивності GPU
• mongo: метрики викликів клієнтів MongoDB
• dns: метрики DNS-запитів

Наприклад, встановлення параметра instrumentations на: http,grpc дозволяє збір метрик HTTP/HTTPS/HTTP2 та gRPC застосунків і відключає інші інструментації.

Компонент експортерів трейсів OpenTelemetry

Секція YAML: otel_traces_export

Ви можете налаштувати компонент в секції otel_traces_export вашої YAML конфігурації або через змінні середовища.

На додачу до конфігурації, задокументованої в цій статті, компонент підтримує змінні середовища з стандартної конфігурації експортерів OpenTelemetry.

otel_traces_export:
  endpoint: http://jaeger:4317
  protocol: grpc
  instrumentations: ["http, "sql"]

Протокол експорту трейсів

Якщо ви не встановите протокол, OBI встановлює протокол наступним чином:

• grpc: якщо порт закінчується на 4317, наприклад 4317, 14317 або 24317.
• http/protobuf: якщо порт закінчується на 4318, наприклад 4318, 14318 або 24318.

Інструментування трейсів

Список областей інструментації, з яких OBI може збирати дані:

• *: вся інструментація, якщо * присутній, OBI ігнорує інші значення
• http: HTTP/HTTPS/HTTP/2 трейси застосунків
• grpc: gRPC трейси застосунків
• sql: SQL трейси бази даних клієнтських викликів
• redis: Redis трейси клієнтів/серверів бази даних
• kafka: Kafka трейси клієнтів/серверів черг повідомлень
• gpu: метрики продуктивності GPU
• mongo: метрики викликів клієнтів MongoDB
• dns: метрики DNS-запитів

Наприклад, якщо ви встановите параметр instrumentations на: http,grpc, це дозволить збір трейсів застосунків HTTP/HTTPS/HTTP2 та gRPC, а також відключить інші інструментації.

Компонент експортера Prometheus

Секція YAML: prometheus_export

Ви можете налаштувати компонент в секції prometheus_export вашої YAML конфігурації або через змінні середовища. Цей компонент відкриває точку доступу HTTP в інструменті автоматичного інструментування, який дозволяє будь-якому зовнішньому скреперу отримувати метрики у форматі Prometheus. Він активується, якщо встановлено властивість port.

prometheus_export:
  port: 8999
  path: /metrics
  extra_resource_attributes: ["deployment_environment"]
  ttl: 1s
  buckets:
    request_size_histogram: [0, 10, 20, 22]
    response_size_histogram: [0, 10, 20, 22]
  instrumentations: ["http, "sql"]

Додаткові атрибути ресурсів Prometheus

Через обмеження внутрішнього клієнта API Prometheus, OBI потрібно заздалегідь знати, які атрибути відкриті для кожної метрики. Це призведе до того, що деякі атрибути, які виявляються під час виконання, під час інструментації, не будуть стандартно видимими. Наприклад, атрибути, визначені для кожного застосунку через анотації Kubernetes або в змінній середовища OTEL_RESOURCE_ATTRIBUTES цільового застосунку.

Наприклад, застосунок, що визначає OTEL_RESOURCE_ATTRIBUTES=deployment.environment=production як змінну середовища, атрибут target_info{deployment.environment="production"} буде стандартно видимий, якщо метрики експортуються через OpenTelemetry, але не якщо вони експортуються через Prometheus.

Щоб зробити deployment_environment видимим у Prometheus, вам потрібно додати його до списку extra_resource_attributes.

Інструментація Prometheus

Список областей інструментування, з яких OBI може збирати дані:

• *: всі області інструментування, якщо * присутній, OBI ігнорує інші значення
• http: метрики застосунків HTTP/HTTPS/HTTP/2
• grpc: метрики застосунків gRPC
• sql: метрики викликів клієнтів SQL бази даних
• redis: метрики клієнтів/серверів Redis бази даних
• kafka: метрики клієнтів/серверів Kafka черг повідомлень

Наприклад, якщо встановити параметр instrumentations на: http,grpc, це дозволить збір метрик застосунків HTTP/HTTPS/HTTP2 і gRPC, а також вимкне інші області інструментування.