Просмотр кода страницы Linux command extension

= Расширение linux_command для Ключ-АСТРОМ =
Расширение '''linux_command''' предназначено для выполнения произвольных '''bash'''-команд на удалённых хостах по '''SSH''' и преобразования вывода в метрики Ключ-АСТРОМ. Метрики имеют префикс <code>custom.linux_command</code>.

== Возможности расширения ==

* Выполнение произвольной '''bash'''-команды на удалённом хосте.
* Подключение по '''SSH''' с паролем или по приватному ключу.
* Запуск команды от имени другого пользователя через <code>su &#x3C;user&#x3E; -c &#x3C;command&#x3E;</code>.
* Разбор вывода в двух режимах:
** <code>SINGLE_VALUE</code> — первое числовое значение из вывода.
** <code>MULTI_VALUE</code> — набор пар <code>key=value</code>.
* Отправка метрик с измерением <code>endpoint</code>, соответствующим имени endpoint.

== Требования ==
На хосте, где запускается расширение (АктивныйШлюз или среда выполнения), должны быть установлены:

* <code>ssh</code>
* <code>sshpass</code>

== Конфигурация ==
Конфигурация задаётся через '''activation.json'''.

=== Пример activation.json ===
<pre>
{
  "enabled": true,
  "description": "linux_command activation",
  "version": "0.0.6",
  "activationContext": "REMOTE",
  "pythonRemote": {
    "endpoints": [
      {
        "endpoint_name": "test-endpoint",
        "execution_frequency": 1,
        "hostname": "172.18.38.131",
        "ssh_port": 22,
        "username": "test-user",
        "password": "{{sshPassword}}",
        "second_username": "",
        "second_password": "",
        "private_key_file": "",
        "private_key_passphrase": "",
        "command": "id -u",
        "metric_extraction_mode": "SINGLE_VALUE",
        "metric_pair_delimiter": "",
        "key_value_delimiter": ""
      }
    ]
  }
}
</pre>

== Параметры endpoint ==
{| class="wikitable"
!Параметр
!Описание
|-
|<code>endpoint_name</code>
|Имя endpoint (попадает в измерение <code>endpoint</code>).
|-
|<code>execution_frequency</code>
|Частота запуска в минутах (минимум 1).
|-
|<code>hostname</code>
|Хост для '''SSH'''-подключения.
|-
|<code>ssh_port</code>
|'''SSH'''-порт (по умолчанию 22).
|-
|<code>username</code>
|'''SSH'''-пользователь.
|-
|<code>password</code>
|'''SSH'''-пароль.
|-
|<code>second_username</code>
|Второй пользователь для <code>su</code> (опционально).
|-
|<code>second_password</code>
|Пароль второго пользователя (опционально).
|-
|<code>private_key_file</code>
|Путь к приватному ключу на АктивномШлюзе/среде выполнения (опционально).
|-
|<code>private_key_passphrase</code>
|Парольная фраза ключа (опционально).
|-
|<code>command</code>
|Команда для запуска.
|-
|<code>metric_extraction_mode</code>
|Режим извлечения метрик: <code>SINGLE_VALUE</code> или <code>MULTI_VALUE</code>.
|-
|<code>metric_pair_delimiter</code>
|Разделитель пар в <code>MULTI_VALUE</code> (по умолчанию <code>\n</code>).
|-
|<code>key_value_delimiter</code>
|Разделитель ключ/значение в <code>MULTI_VALUE</code> (по умолчанию <code>=</code>).
|}

== Режимы извлечения метрик ==

=== SINGLE_VALUE ===
Берётся первая строка, которую можно преобразовать в число с плавающей точкой.

'''Пример:'''

Команда: <code>id -u</code>

Вывод: <code>1001</code>

Метрика: <code>custom.linux_command.value = 1001</code>

=== MULTI_VALUE ===
Ожидается вывод в формате <code>key=value</code> (или с заданными разделителями).

'''Пример:'''

Команда: <code>printf 'cpu=12\nmem=45.5\nerrors=0\n'</code>

<code>metric_pair_delimiter</code>: <code>\n</code>

<code>key_value_delimiter</code>: <code>=</code>

Метрики:

* <code>custom.linux_command.cpu = 12</code>
* <code>custom.linux_command.mem = 45.5</code>
* <code>custom.linux_command.errors = 0</code>

== Примеры сценариев ==

=== Команда от второго пользователя ===

* <code>username</code>: пользователь для '''SSH'''.
* <code>second_username</code>: пользователь, от которого выполнить команду.
* <code>command</code>: например, <code>id -u</code>.

Фактически выполняется:<pre>
su &lt;second_username&gt; -c '&lt;command&gt;'
</pre>

=== Подключение по приватному ключу ===

* <code>private_key_file</code>: путь к приватному ключу (например, <code>/root/.ssh/id_rsa</code>).
* Если ключ защищён парольной фразой:
** Заполните <code>private_key_passphrase</code>.
** Поле <code>password</code> остаётся обязательным по схеме, но при наличии <code>private_key_file</code> + <code>private_key_passphrase</code> используется парольная фраза ключа.

== История версий ==

{| class="wikitable"
! Версия
! Изменения
|-
|0.1.0
|Начало поддержки расширения в Ключ-АСТРОМ <code>1.285+</code>. Расширение выполняет команды на удалённых Linux-хостах по SSH и преобразует полученные значения в метрики.
|}