Инструкция по использованию плагина в коллекторах#

Расположение плагина#

Данный плагин входит в состав дистрибутива: ./EM-{version}-distrib/EDMN-app-{version}-distrib/package/bh/edmn/console-1-0.6.jar.

Автоматическое получение файла конфигурации с набором метрик#

java -jar <path_to_jar/>console-01.000.00-fatJar.jar -s <host:port> -u <username> -p <password> -g <fileName>

Пример для сервера Artemis: java -jar /Users/21453177/Desktop/SBT/metric-plugin/console/build/libs/console-1.0.0-fatJar.jar -s host:port -u myuser -p *** -g generator-artemis-metrics

Результат: В домашней директории пользователя создался каталог /config/conf. В нем находится файл generator-artemis-metrics.conf

Добавление полученного файла конфигурации в inventory#

  • cклонировать проект из репозитория git clone https://works.ru/bitbucket-ci/scm/synse/ansible-inventories-edm.git

  • в своем каталоге inventory добавить полученный ранее файл конфигурации по пути …/collectors/config/generator-artemis-metrics.conf;

  • в файле vars.yml изменить наименование коллектора и имя файла конфигурации: generator-artemis-metrics: config: generator-artemis-metrics.conf

  • проверить, что хост Prometheus соответствует стенду развертывания, в файле vars.yml блок настроек time_series_connects

  • сделать Commit и Push

Развернуть коллектор и Мониторинг с требуемым inventory#

  • если отсутствует требуемый коллектор, установить его на стенд использовать Jenkins Job monitoring_custom с параметром: install

  • использовать Jenkins Job monitoring_custom с параметрами: run_only, custom_config

  • переразвернуть Мониторинг с измененным inventory Jenkins Job monitoring_custom

Получение метрик#

  • перейти в UI Мониторинга.

  • на вкладке Настройки выбрать пункт Добавить корневой узел. Переименовать корневой узел на GeneratedRoot. Запросить вложенные узлы.

Аргументы командной строки#

Аргумент

Тип даных

Описание

Пример

-s/-server

List

Список адресов хостов для подключения

«-s», «127.0.0.1:8080,www.ya.ru»

-u/-user

String

Логин авторизации на MBean - сервере

«-u», «testuser»

-p/-password

String

Пароль авторизации на MBean - сервере

«-p», «testpass»

-i/-included

List

Фильтр - список доменов для поиска атрибутов по входящим в список именам доменов (IN)

«-i», «java.lang,java.nio»

-ex/-excluded

List

Фильтр - список доменов для поиска атрибутов по НЕ входящим в список именам доменов (NOT IN)

«-e», «java.lang,java.nio»

-f/-filter

List

Фильтр - список ключей ObjectName’s

«-f», «broker,address»

-e/-edit

String

Путь до JSON файла для редактирования метрик

-dir/-directory

String

Наименование директории для сохранения файлов конфигурации

«-dir», «./mydirectory/conf/»

-g/-generate

String

Команда для генерации файла конфигурации .conf

«-g», «generator-artemis-metrics»

-d/-discover

String

Команда для генерации JSON - представления для редактирования

«-d», «generator-artemis-metrics»

-t/-template

String

Наименование .ftl шаблона для формирования файла конфигурации

«-t», «my-config-template.ftl»

-ft/-ftl

String

Путь до .ftl шаблона для загрузки и формирования файла конфигурации

-ssl/-ssl

Boolean

Признак SSL соединения с MBean сервером

«-ssl»

-c/-clear

Boolean

Признак необходимости очистки директории с файлами конфигурации

«-c»