XMonitor-Client

Открытый серверный мониторинг Linux, сбор данных и мощный помощник в эксплуатации Linux-серверов. Поддерживает: мониторинг HTTP, процессов, MySQL, TCP, PING и мониторинг результатов команд. Гибкое использование может привести к незапланированным эффектам. Для использования достаточно скачать архив xmonitor-client_x.x.x.tar.gz.

Руководство по XMonitor-Client версия 1.0.2

0. Важные замечания

• Требования к среде: система Linux, JDK 1.7 или выше
• Конфигурационный файл: config/client.xml
• Файл конфигурации логов: config/logback-log.xml, основан на logback. При использовании в продакт-шн можно закомментировать appender-ref ref="STDOUT"
• Запуск, остановка, проверка состояния:
  • Перейти в директорию xmonitor-client: cd {xmonitor-client каталог}
  • Запустить: /bin/bash bin/xmointor.sh start
  • Остановить: /bin/bash bin/xmointor.sh stop
  • Проверить состояние: /bin/bash bin/xmointor.sh status
  • Отладка: /bin/bash bin/xmointor.sh debug

1. XMonitor-Client имеет модульную структуру конфигурации. Каждый модуль состоит из одного или нескольких задач.### 2. Каждая задача может выполняться регулярно, как cron-задача в Linux, синтаксис полностью совпадает с cron.

• Выполнение периодических задач можно определить через свойство cron каждой задачи.

3. Описание "вывода задачи". Поскольку существует множество различных задач, большинство из которых имеют выходные данные, например, для HTTP-задачи выводом является HTML. Для задач мониторинга выполнения команд — это результат выполнения самой команды. Любое такое выходное значение задачи в XMonitor-Client называется "выводом задачи".4. Статус свойства status может использоваться для включения или отключения модулей и задач. Когда status установлен как close, модуль или задача больше не действуют; по умолчанию status установлен как open.

5. Каждая задача имеет три состояния: успех (success), сбой (error) и восстановление (recovery).

6. После изменения состояния задачи можно отправить данные её вывода и другую информацию на пользовательский сервер с помощью email или http. Также можно выполнять системные команды.

7. Единицей измерения всех значков времени являются миллисекунды, то есть 1 секунда = 1000 миллисекунд.

8. Описание модуля success
Модуль success активируется при успешной проверке выходных данных задачи. Успешная проверка может быть либо совпадением с указанным флагом, либо выполнением других правил, определённых внутри модуля. При активации модуля success можно использовать mailto, request и cmd модули для отправки электронной почты, выполнения HTTP запросов и выполнения системных команд соответственно.9. Описание модуля error
Модуль error активируется при неудачной проверке выходных данных задачи. Несоответствие может быть либо отсутствием совпадения с указанным флагом, либо несоответствием другим правилам, определённым внутри модуля. При активации модуля error можно использовать mailto, request и cmd модули для отправки электронной почты, выполнения HTTP-запросов и выполнения системных команд соответственно. Модуль error имеет два свойства:warn_count: количество ошибок, после которого будет активирован модуль error; skip_count: количество пропущенных попыток активации модуля error перед следующей попыткой активации; max_warn_count: максимальное количество активаций модуля error за определенный период времени, после которого дальнейшие активации будут прекращены до полного восстановления системы.

Это позволяет избежать частого повторного уведомления о том же самом сбое.

10. Описание модуля recovery
Модуль recovery активируется один раз при переходе задачи из состояния сбоя в состояние успеха. В этом случае можно определить действия, выполняемые при восстановлении службы. Успешность может быть определена либо совпадением с указанным флагом, либо выполнением других правил, определённых внутри модуля. Модуль recovery запускается после активации и может использовать модули mailto, request и cmd для отправки электронной почты, HTTP-запросов и выполнения системных команд соответственно. 11. Описание модуля flag

Модуль flag используется для проверки выходных данных задач на корректность. Если данные корректны, то срабатывает успешный модуль success.

Предположим, что значение в flag — это value, а выходные данные задачи — output.

Атрибут type модуля flag имеет следующие значения:

empty : успех, если output пустое

include : успех, если output содержит value

exclude : успех, если output не содержит value

any : успех при любом содержании output

reg : успех, если output соответствует регулярному выражению value

http : успех, если запрос внутри flag успешно выполнен

number : успех, если output является целым или вещественным числом

= : успех, если output >= value

= : успех, если output == value

<= : успех, если output <= value 12. Описание модуля mailto

Модуль mailto используется для отправки электронной почты. Он позволяет отправлять выходные данные задач одному или нескольким получателям.

Для отправки электронной почты:

В глобальном конфигурационном файле global присутствуют настройки для отправки электронной почты, где можно указать одного или нескольких глобальных получателей.

В клиентском конфигурационном файле client присутствуют настройки аккаунтов email для отправки электронной почты, где можно указать одного или нескольких аккаунтов. Каждый аккаунт имеет уникальный id, который соответствует параметру account_id в модуле mailto, чтобы указать, какой аккаунт следует использовать.

13. Описание модуля request

Модуль request используется для отправки HTTP-запросов, поддерживающих протоколы http и https. Он позволяет отправлять выходные данные задач на указанный URL.

Это возможно благодаря следующим свойствам:

method: определяет метод запроса (GET или POST)

code: определяет HTTP-статус ответа для проверки успешности запроса

flag: определяет флаг для проверки соответствия выходных данных URL

form: определяет данные формы для отправки, где каждый элемент item представляет собой параметр GET или POST

14. Описание модуля cmdМодуль cmd используется для выполнения системных команд. Время ожидания выполнения команды можно установить через параметр timeout. Значение 0 указывает на отсутствие ограничения времени. Внутри модуля cmd указаны команды для выполнения, которые могут быть цепочками команд, например: service mysql status || service mysql start

15. Описание переменных

Переменные, используемые в форме запроса item и title/content в модуле mailto, включают:

{output} : выходные данные задачи

{code}: Код ошибки:
        1: Несоответствие правилу
        2: Ошибка выполнения команды
        3: Несоответствие коду состояния
        4: Отсутствие адреса хоста
        5: Превышение времени ожидания операции
        6: Ошибка соединения

{time}: Временная метка начала задачи в секундах

{time_str}: Временная метка начала задачи в формате: ГГГГ-ММ-ДД ЧЧ:ММ:СС

{err_time}: Время продолжительности ошибки при восстановлении в секундах

{err_time_str}: Временная метка продолжительности ошибки при восстановлении в формате: x дней x часов x минут x секунд

16. config/client.xml конфигурационный файл структура