API метрик ЕдиногоАгента

Материал из Документация Ключ-АСТРОМ

Вы можете использовать локальную конечную точку API http://localhost:<port>/metrics/ingest для передачи локально полученных метрик в Ключ-АСТРОМ по безопасному и аутентифицированному каналу. Эта конечная точка доступна только локальным клиентам и недоступна с удалённых хостов.

Если вы не можете отправлять метрики с помощью локальной конечной точки API, вы также можете использовать публичную конечную точку API метрик v2 (см. ниже).

Включить API метрик ЕдиногоАгента

АктивныйШлюз версии 1.243+

ЕдиныйАгент версии 1.243+

API метрик ЕдиногоАгента по умолчанию входит в состав ЕдиногоАгента версии 1.201. Вам нужно включить API метрик ЕдиногоАгента только на уровне среды или хоста. Обратите внимание, что конфигурация на уровне хоста переопределяет конфигурацию среды.

Если вы хотите изменить лимиты потребления ресурсов EEC, см. Профиль производительности.

Включить на уровне среды

  1. Перейдите в раздел Настройки и выберите Предпочтения > Контроллер выполнения расширений.
  2. Включите опцию Включить контроллер выполнения расширений.
  3. Включите функцию Включить локальный API HTTP Metric, Log and Event Ingest.

Включить для одного хоста

  1. Перейдите в раздел Хосты.
  2. Найдите и выберите свой хост, чтобы отобразить страницу обзора хостов.
  3. В правом верхнем углу страницы обзора хоста выберите Дополнительно ( … ) > Настройки.
  4. В настройках хоста выберите Контроллер выполнения расширений.
  5. Включите опцию Включить контроллер выполнения расширений.

Включить для группы хостов

  1. Перейдите в раздел Состояние развертывания, а затем выберите ЕдиныеАгенты.
  2. На странице развертывания ЕдиногоАгента отключите опцию Показывать новые развертывания ЕдиногоАгента.
  3. Отфильтруйте таблицу по Host group и выберите группу хостов, которую вы хотите настроить. Свойство Группа хостов не отображается, если выбранный хост не принадлежит ни одной группе хостов. Отобразится страница развёртывания ЕдиногоАгента, отфильтрованная по выбранной группе хостов. Для каждого указанного хоста есть ссылка Группа хостов: <group name>, где <group name>— имя группы хостов, которую нужно настроить.
  4. Выберите название группы хостов в любой строке. Поскольку вы отфильтровали данные по группе хостов, все отображаемые хосты относятся к одной и той же группе.
  5. В настройках группы хостов выберите Контроллер выполнения расширений.
  6. Включите опцию Включить контроллер выполнения расширений.

Топология

Используя локальную конечную точку API, идентификатор хоста и контекст имени хоста автоматически добавляются к каждой метрике в качестве измерений. Узнайте, как дополнить свои метрики другими специфичными для Ключ-АСТРОМ измерениями и применить информацию о причинно-следственных связях Ключ-АСТРОМ ИИ к полученным данным.

Метрический формат

Предоставленные точки данных должны соответствовать протоколу приема метрик .

Запрос text/plain использует полезную нагрузку с указанным набором символов charset=utf-8. Полезная нагрузка ограничена 1,000 строками.

Пример

С помощью этой curl команды вы получите метрику cpu.temperature, назначенную измерению cpu=1. Метрика будет автоматически назначена соответствующему идентификатору и имени хоста.

curl --data "cpu.temperature,cpu=1 55" http://localhost:14499/metrics/ingest \

     -H "Content-Type: text/plain; charset=utf-8"

Успешный ответ:

{

"error": null,

"linesValid": 1,

"linesInvalid": 0

}

Коммуникационный порт

Начиная с версии ЕдиногоАгента 1.267+, системы AIX также поддерживают прием метрик.

Порт для сбора метрик по умолчанию — 14499. При необходимости вы можете проверить или изменить порт с помощью команды oneagentctl --restart-service. Изменение порта для сбора метрик требует перезапуска ЕдиногоАгента. Добавьте к команде для автоматического перезапуска ЕдиногоАгента.

Проверьте порт приема

Используйте параметр --get-extensions-ingest-port, чтобы показать текущий локальный порт приема по умолчанию 14499.

  • Linux, AIX : ./oneagentctl --get-extensions-ingest-port
  • Windows : .\oneagentctl.exe --get-extensions-ingest-port

Установите пользовательский порт приема

Используйте параметр --set-extensions-ingest-port=<arg> для установки локального порта приема.

  • Linux, AIX : ./oneagentctl --set-extensions-ingest-port=14499 --restart-service
  • Windows : .\oneagentctl.exe --set-extensions-ingest-port=14499 --restart-service

Настроить прокси

Настройте прокси-сервер своего хоста так, чтобы разрешить трафику localhost проходить через порт сбора метрик по умолчанию 14499.

Обратите внимание, что изменение порта для API метрик ЕдиногоАгента также влияет на интеграцию скриптов и Telegraf.

API метрик v2

В отличие от локального интерфейса загрузки, который автоматически добавляет топологический контекст (каждая метрика назначается соответствующему хосту), метрики, передаваемые через общедоступный Metrics API v2, по умолчанию являются плоскими. Это особенно полезно для бизнес-метрик, которые не имеют никакого отношения к топологическим сущностям вашей среды.

Однако, чтобы события генерировались для выбранного хоста и Ключ-АСТРОМ ИИ выполнял причинно-следственный анализ на основе ваших метрик, вы можете настроить приложение для добавления измерения dt.entity.host. Чтобы автоматически дополнить идентификатор группы процессов метрикой, укажите измерение dt.process.pid. Подробнее см. в разделе API метрик - POST прием точек данных.