Интеграция скриптов метрик

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

С помощью инструмента astromkey_ingest вы можете передавать локально полученные метрики в Ключ-АСТРОМ по защищенному и аутентифицированному каналу. Инструмент доступен только локальным клиентам и недоступен с удаленных хостов.

Включение интеграции скриптов

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

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

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

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

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

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

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

Двоичное местоположение

Расположение инструмента зависит от того, настраивали ли вы установку ЕдиногоАгента с помощью параметра <INSTALL_PATH>:

  • Linux : <INSTALL_PATH>/agent/tools по умолчанию /opt/astromkey/oneagent/agent/tools
  • Развертывание на основе Docker (<INSTALL_PATH>/agent/tools по умолчанию). /opt/astromkey/oneagent/agent/tools
    Обратите внимание, что этот путь будет отличаться для развертывания на основе томов.
  • Windows : <INSTALL_PATH>\agent\tools по умолчанию %PROGRAMFILES%\astromkey\oneagent\agent\tools

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

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

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

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

Использование

Основное применение:

astromkey_ingest [Options] [Metrics]

Оба параметра [Options] и [Metrics] являются необязательными. Синтаксис метрик, передаваемых в качестве аргументов [Metrics], должен соответствовать протоколу приема метрик.

Существует два основных способа передачи метрик astromkey_ingest: (1) путем перенаправления выходных данных другого процесса в astromkey_ingest, или (2) с использованием аргументов вызова.

Перенаправление вывода процесса

Если метрики не указаны, astromkey_ingest предполагается, что они будут переданы через стандартный ввод. Каждая строка рассматривается как одна метрика. Это позволяет передавать метрики astromkey_ingest из выходных данных других процессов. Например:

echo host.process_count `ps aux | wc -l` | astromkey_ingest

Вызов аргументов

При использовании аргументов вызова вместо стандартного ввода для передачи метрик, передавайте каждую метрику в качестве отдельного аргумента. Например, чтобы передать две метрики с помощью одной команды:

astromkey_ingest 'cpu.temperature,cpu=1 55'  'cpu.temperature,cpu=2 45'

Параметры командной строки

-v [ --verbose ] - выводит логи в стандартный поток вывода.

-p [ --port ] arg (=14499) - задает пользовательский порт для связи с модулем OneAgent Extensions Execution Controller (EEC). Если вы измените порт EEC по умолчанию ( 14499), необходимо указать astromkey_ingestиспользовать новый порт.

-h [ --help ] - выводит справочное сообщение и завершает работу.

Порт коммуникаций

Начиная с версии ЕдиногоАгента 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

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

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

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