Создайте файл конфигурации sqlquery.yml.

В созданном файле конфигурации укажите параметры подключения к базе данных в разделе receivers.sqlquery:

receivers:
  sqlquery:
    driver: postgres
    host: localhost
    port: 5432
    database: postgres
    username: postgres
    password: ${env:POSTGRESQL_PASSWORD}
    # Дополнительные параметры подключения для драйвера
    additional_params:
      application_name: pgpro-otel-collector
      sslmode: disable
    # Интервал между выполнениями запросов. По умолчанию: 10s
    collection_interval: 60s
    # Определяет настройку телеметрии самого компонента
    telemetry:
      logs:
        # Если true, каждый выполненный запрос журналируется на уровне debug
        query: false
    # Максимальное количество открытых соединений с сервером Postgres Pro. По умолчанию: 0 (не ограничено)
    max_open_conn: 5

Параметр password поддерживает подстановку переменных окружения, как показано в примере. Специальные символы в учётных данных автоматически кодируются в URL-формате для обеспечения корректного форматирования строки подключения.

Также можно использовать параметр datasource для указания полной строки подключения:

datasource: "host=localhost port=5432 user=postgres password=postgres application_name=pgpro-otel-collector sslmode=disable"

Укажите запросы для сбора метрик. Каждый запрос состоит из SQL-оператора и раздела metrics. Разделов metrics может быть несколько, но хотя бы один такой раздел обязателен. Каждая метрика в конфигурации создаёт одну метрику OpenTelemetry для каждой строки, возвращённой SQL-запросом.

receivers:
  sqlquery:
    ...
    queries:
      - sql: >-
          SELECT p.id, p.name, p.price, sum(s.units) AS sold
          FROM products p LEFT JOIN sales s ON (p.id = product_id)
          GROUP BY p.id, p.name, p.price
        metrics:
          # Пример метрики типа gauge
          # Имя, присваиваемое метрике OpenTelemetry
          - metric_name: postgresql.products.price
            value_column: price
            data_type: gauge
            value_type: double
            description: Price of the product
            unit: rub
            static_attributes:
              database: postgres
            attribute_columns: ["name"]
          # Пример метрики типа sum
          - metric_name: postgresql.products.sold
            value_column: sold
            data_type: sum
            value_type: int
            description: Total count of sold products
            # Указывает, является ли кумулятивное значение суммы монотонно возрастающим (т.е. никогда не сбрасывается и не переполняется)
            # По умолчанию = false
            monotonic: true
            aggregation: cumulative
            static_attributes:
              database: postgres
            attribute_columns: ["name"]

В этом примере предполагается следующая схема базы данных:

CREATE TABLE products (id INTEGER, name TEXT, price NUMERIC);
INSERT INTO products VALUES (1, 'Cheese', 9.99), (2, 'Bread', 1.99), (3, 'Milk', 2.99);

CREATE TABLE sales (id BIGINT, product_id BIGINT, units INT, sold_at TIMESTAMP DEFAULT now());
INSERT INTO sales VALUES (1, 1, 10), (2, 2, 20), (2, 2, 50), (3, 3, 30);

Запрос создаёт две метрики: измеритель (gauge) для текущих цен товаров и кумулятивную сумму (cumulative sum) для общего количества проданных единиц по каждому товару.

Используйте параметр data_type для указания типа метрики. Установите его в значение gauge для метрик, представляющих текущее значение, или в sum для метрик, представляющих агрегированную сумму. При использовании sum установите параметр aggregation в значение cumulative (по умолчанию) или delta.

Настройте экспортёры, процессоры и конвейер службы:

...
exporters:
  prometheus:
    endpoint: :8889
    send_timestamps: true
  otlphttp/sqlquery/metrics:
    compression: ''
    endpoint: https://metrics.example.org:8080
    headers:
      X-Ppem-Source-Agent-Name: local
      X-Ppem-Source-Instance-Port: '5432'
processors:
  batch/sqlquery:
    send_batch_size: 2048
    timeout: 10s
service:
  # Телеметрия для самого коллектора
  telemetry:
    logs:
      # Задаёт минимальный уровень журналирования
      # Значения: debug, info, warn, error
      # По умолчанию = info
      level: info
  pipelines:
    metrics/sqlquery:
      receivers: [ sqlquery ]
      processors: [ batch/sqlquery ]
      exporters: [ prometheus, otlphttp/sqlquery/metrics ]

Запустите pgpro-otel-collector с созданным файлом конфигурации:

build/pgpro-otel-collector/pgpro-otel-collector --config configs/sqlquery.yml

Создайте файл конфигурации metrics_transform.yml.

Добавьте в файл конфигурации подходящие для ваших задач разделы из примеров ниже:

Настройте экспортёры и конвейер службы в соответствии с выбранными разделами:

exporters:
  prometheus:
    endpoint: :8889
    send_timestamps: true
    # translation_strategy: UnderscoreEscapingWithoutSuffixes
    # Если true, все атрибуты ресурса по умолчанию будут преобразованы в метки метрик
    # resource_to_telemetry_conversion:
    #   enabled: true
service:
  pipelines:
    metrics:
      receivers:
        - postgrespro
      processors:
        - metricstransform/rename
        # - metricstransform/rename_by_regexp
        # - metricstransform/create_new
        # - metricstransform/add_label
        # - metricstransform/rename_label
        # - metricstransform/rename_label_multiple
        # - metricstransform/rename_label_value
        # - metricstransform/delete_by_label_value
        # - metricstransform/convert_data_type
        # - metricstransform/aggregate_labels
        # - metricstransform/aggregate_label_values
        # - metricstransform/combine_metrics
        # - metricstransform/group_metrics
        # - metricstransform/experimental_create_by_label
        # - metricstransform/experimental_scale_value
      exporters:
        - prometheus

Запустите pgpro-otel-collector с основным файлом конфигурации и metrics_transform.yml:

build/pgpro-otel-collector/pgpro-otel-collector --config configs/basic.yml --config configs/metrics_transform.yml

Создайте файл конфигурации с именем biha.yml со следующим содержимым:

receivers:
  postgrespro/biha:
    transport: tcp
    endpoint: &endpoint localhost:5432
    database: biha_db
    username: biha_replication_user
    password: ${env:POSTGRESQL_PASSWORD}
    collection_interval: 60s
    initial_delay: 1s
    max_threads: 3
    plugins:
      biha:
        enabled: true
        cluster_name: cluster_name
exporters:
  prometheus/biha:
    endpoint: :8889
    send_timestamps: true
    # Определяет, как долго метрики остаются доступными без обновлений
    # Поскольку некоторые метрики BiHA включают 'biha_state' в свои метки,
    # лучше установить этот параметр равным collection_interval,
    # чтобы устаревшие состояния не появлялись на странице Prometheus
    metric_expiration: 60s
processors:
  batch/metrics:
    send_batch_size: 8192
    timeout: 10s
  memory_limiter/metrics:
    check_interval: 1s
    limit_mib: 2048
service:
  pipelines:
    metrics/biha:
      receivers:
        - postgrespro/biha
      processors:
        - memory_limiter/metrics
        - batch/metrics
      exporters:
        - prometheus/biha

Запустите pgpro-otel-collector с созданным файлом конфигурации:

build/pgpro-otel-collector/pgpro-otel-collector --config configs/biha.yml