API для приема логов ЕдиногоАгента

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

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

Конечная точка приема логов ЕдиногоАгента имитирует поведение общедоступного API мониторинг логов - POST прием логов.

Включите API для приема логов.

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


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

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

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

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

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

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

Формат событий логов

Запрос application/json принимает полезную нагрузку с указанной кодировкой символов charset=utf-8. Для получения дополнительной информации о формате см. API мониторинг логов - POST прием логов.

Ограничения

На события логов, передаваемые в Ключ-АСТРОМ с помощью API приема логов ЕдиногоАгента, распространяются те же ограничения, что и на общедоступный API мониторинг логов - POST прием логов.

Пример

С помощью этой команды curl вы получите событие Exception: Custom error log sent via OneAgent log ingest, установив уровень серьезности на error и пользовательский атрибут на attribute value. Поскольку метка времени не указана, событие автоматически получает метку времени чтения события. Вы сможете получить доступ к событию в средстве просмотра логов.

curl -i -X POST "http://127.0.0.1:14499/v2/logs/ingest" -H "Content-Type: application/json; charset=utf-8" -d "{\"content\":\"Exception: Custom error log sent via Generic Log Ingest\",\"custom.attribute\":\"attribute value\",\"severity\": \"error\"}"

В случае успешного ответа возвращается код 204.

HTTP/1.1 204 No Content

Content-Type: application/json

Server: EEC

Content-Length: 116

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

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

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

Источник — https://doc.ruscomtech.ru/index.php?title=API_для_приема_логов_ЕдиногоАгента&oldid=6102