Отправка метрик Telegraf в Ключ-АСТРОМ

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

Telegraf — это управляемый плагинами серверный агент для сбора, обработки, агрегирования и записи метрик. Telegraf поставляется с плагином вывода Ключ-АСТРОМ, который позволяет легко отправлять метрики Telegraf в Ключ-АСТРОМ.

Включение приема данных Telegraf

Функция сбора метрик Telegraf доступна в ЕдиномАгенте версии 1.201 и выше. Самый простой вариант настройки — установить Telegraf и ЕдиныйАгент на одном хосте. В этом случае вам нужно будет только включить плагин вывода Ключ-АСТРОМ в конфигурации Telegraf (версия Telegraf 1.16 и выше) и включить сбор метрик Telegraf на уровне среды или хоста в конфигурации Ключ-АСТРОМ. Обратите внимание, что конфигурация на уровне хоста переопределяет конфигурацию на уровне среды.

Включение плагин вывода Ключ-АСТРОМ в конфигурации Telegraf

Telegraf и ЕдиныйАгент установлены на одном хосте

  1. Отредактируйте файл конфигурации Telegraf telegraf.conf.
  2. Прокомментируйте строку [[outputs.astromkey]].
  3. Необязательно Прокомментируйте строку prefix = "telegraf." и установите префикс, чтобы легко находить метрики, полученные Telegraf. Префикс также будет виден в ключе метрики Ключ-АСТРОМ.
  4. Сохраните файл.
# # Send telegraf metrics to a astromkey environment

outputs.astromkey

# ## For usage with the astromkey OneAgent you can omit any configuration,

# ## the only requirement is that the OneAgent is running on the same host.

# ## Only setup environment url and token if you want to monitor a Host without the OneAgent present.

# ##

# ## Your astromkey environment URL.

# ## For astromkey OneAgent you can leave this empty or set it to "http://127.0.0.1:14499/metrics/ingest" (default)

# ## For astromkey SaaS environments the URL scheme is "https://{your-environment-id}.live.astromkey.com/api/v2/metrics/ingest"

# ## For astromkey Managed environments the URL scheme is "https://{your-domain}/e/{your-environment-id}/api/v2/metrics/ingest"

# url = ""

#

# ## Your astromkey API token.

# ## Create an API token within your astromkey environment, by navigating to Settings > Integration > astromkey API

# ## The API token needs data ingest scope permission. When using OneAgent, no API token is required.

# api_token = ""

#

# ## Optional prefix for metric names (e.g.: "telegraf.")

prefix = "telegraf."

#

# ## Optional TLS Config

# # tls_ca = "/etc/telegraf/ca.pem"

# # tls_cert = "/etc/telegraf/cert.pem"

# # tls_key = "/etc/telegraf/key.pem"

#

# ## Optional flag for ignoring tls certificate check

# # insecure_skip_verify = false

#

#

# ## Connection timeout, defaults to "5s" if not set.

# timeout = "5s"

Если на хосте отсутствует ЕдиныйАгент

Если вам не удается установить ЕдиныйАгент на хост, контролируемый Telegraf, вы можете настроить плагин вывода Ключ-АСТРОМ для прямой отправки метрик в вашу среду Ключ-АСТРОМ через Metrics API v2.

Предварительные требования

  • API-токен с областью действия «Ввод метрик» .
  • Идентификатор вашей среды .
  1. Отредактируйте файл конфигурации Telegraf telegraf.conf.
  2. Прокомментируйте строку # [[outputs.astromkey]].
  3. Необязательно Прокомментируйте строку # prefix = "telegraf." и установите префикс, чтобы легко находить метрики, полученные Telegraf. Префикс также будет виден в ключе метрики Ключ-АСТРОМ.
  4. Прокомментируйте строку # api_token = "" и добавьте свой API-токен, например api_token = "abcdefjhij1234567890".
  5. Прокомментируйте строку # url = "" и добавьте конечную точку API метрик Ключ-АСТРОМ. Например,
    • Ключ-АСТРОМ SaaS url = "https://{your-environment-id}.live.astromkey.com/api/v2/metrics/ingest"
    • Ключ-АСТРОМ Managed https://{your-domain}/e/{your-environment-id}/api/v2/metrics/ingest
  6. Сохраните файл.
# # Send telegraf metrics to a astromkey environment

outputs.astromkey

# ## For usage with the astromkey OneAgent you can omit any configuration,

# ## the only requirement is that the OneAgent is running on the same host.

# ## Only setup environment url and token if you want to monitor a Host without the OneAgent present.

# ##

# ## Your astromkey environment URL.

# ## For astromkey OneAgent you can leave this empty or set it to "http://127.0.0.1:14499/metrics/ingest" (default)

# ## For astromkey SaaS environments the URL scheme is "https://{your-environment-id}.live.astromkey.com/api/v2/metrics/ingest"

# ## For astromkey Managed environments the URL scheme is "https://{your-domain}/e/{your-environment-id}/api/v2/metrics/ingest"

# url = "https://abd12345.live.astromkey.com/api/v2/metrics/ingest"

#

# ## Your astromkey API token.

# ## Create an API token within your astromkey environment, by navigating to Settings > Integration > astromkey API

# ## The API token needs data ingest scope permission. When using OneAgent, no API token is required.

# api_token = "abcdefjhij1234567890"

#

# ## Optional prefix for metric names (e.g.: "telegraf.")

prefix = "telegraf."

#

# ## Optional TLS Config

# # tls_ca = "/etc/telegraf/ca.pem"

# # tls_cert = "/etc/telegraf/cert.pem"

# # tls_key = "/etc/telegraf/key.pem"

#

# ## Optional flag for ignoring tls certificate check

# # insecure_skip_verify = false

#

#

# ## Connection timeout, defaults to "5s" if not set.

# timeout = "5s"

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

  1. Перейдите в Настройки и выберите Предпочтения > Контроллер выполнения расширений.
  2. Включите параметр Контроллер выполнения расширений .
  3. Включите локальный API для сбора HTTP-метрик, логов и событий.

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

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

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

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

Информация о топологии

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

Формат метрик

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

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

Плагин вывода Telegraf Ключ-АСТРОМ отправляет метрики на конечную точку API метрик ЕдиногоАгента.

Порт приема метрик по умолчанию — 14499. При необходимости вы можете использовать команду oneagentctl для проверки или изменения порта. Изменение порта приема метрик требует перезапуска OneAgent. Добавьте --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

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

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

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

  1. Отредактируйте файл конфигурации Telegraf telegraf.conf.
  2. Установите свойство url в значение url = "http://127.0.0.1:<your-custom-port>/metrics/ingest".
  3. Сохраните файл.

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