MetricPlugin#

Плагин предназначен для формирования метрик по количеству подключений (connection), сессий(session), связанных с определенным пользователем. Подключение плагина возможно несколькими способами.

Ручное подключение плагина#

Для подключения плагина к Artemis необходимо:

• в broker_instance_dir/etc/broker.xml необходимо подключить плагин в разделе broker-plugins с необходимыми настройки

• в classpath Artemis( e.g.:broker_instance_dir/lib) положить logger-plugin-*.jar-файл

Настройки плагина#

Пример настройки плагина в broker.xml#

<broker-plugins>
    <broker-plugin class-name="ru.sbt.ss.artemis.plugin.metric.MetricPlugin">
        <property key="CONNECTION_METRIC_TASK_DELAY_MS" value="3000"/> <!-- необязательная настройка -->
        <property key="CONNECTION_METRIC_TASK_INIT_DELAY_MS" value="5000"/> <!-- необязательная настройка -->
    </broker-plugin>
</broker-plugins>

Подключение plugin через Jenkins Job artemis_custom#

Для подключения plugin с помощью Jenkins, необходимо в файле inventories/<новая директория>/group_vars/all/vars.yml внести настройки (пример приведен ниже), далее запустить Jenkins Job artemis_custom с параметрами:

• inventory — выбрать инвентори, для которого запускается plugin;

• playbook — artemis.yml;

• tags — metric_plugin.

Пример настройки plugin в vars.yml#

metric_plugin: # плагин для формирования метрик по количеству сессий и подключений
  CONNECTION_METRIC_TASK_DELAY_MS: 3000 # Интервал запуска задачи по измерению количества подключений, связанных с пользователем
  CONNECTION_METRIC_TASK_INIT_DELAY_MS: 5000 # Время инициализации задачи подсчета значений количества подключений, связанных с пользователем

Метрики#

Плагин формирует следующие метрики:

1. Метрика числа подключений (connection), связанных с определенным пользователем

MBean name для метрики для адреса test_address и юзеров с именами user_1, user_2

org.apache.activemq.artemis:broker="brokerName",component=connectionCounters,user="user_1",name="connectionCounter"
org.apache.activemq.artemis:broker="brokerName",component=connectionCounters,user="user_2",name="connectionCounter"

2. Метрика числа сессий(session), связанных с определенным пользователем

MBean name для метрики для адреса test_address и пользователей с именами user_1, user_2

org.apache.activemq.artemis:broker="brokerName",component=sessionCounters,user="user_1",name="sessionCounter"
org.apache.activemq.artemis:broker="brokerName",component=sessionCounters,user="user_2",name="sessionCounter"

Формирование метрик (числа подключений и числа сессий) для конкретного пользователя происходит на этапе создания сессии.
До момента формирования сессии для пользователя данные метрики отсутствуют.