RuBackup

Экспортер для получения метрик из API RuBackup, работает с версииями API 1 и 2.

Cсылки на документацию к API

  1. API v1 - будет УДАЛЕНА в версии 3 системы RuBackup

  2. API v2 - рекомендуется к использованию

Описание конфигурационного файла

# Базовые настройки
base:
  address: 127.0.0.1:9444       # Адрес экспортера
  metrics_path: /metrics        # Эндпоинт метрик
  interval: 60s                 # Интервал сбора
  go_metrics: false             # Включение стандартных метрик Go (default: false)
  proc_metrics: false           # Включение стандартных метрик процессов (default: false)

  # Настройки логирования
  logger:
    level: info                   # Уровень детализации (trace, info, debug, error)
    file: /var/log/astra-monitoring/rubackup-exporter.log  # Путь к логу
    disable_console_log: true     # Отключение вывода в консоль (default: false)

# Настройки API RuBackup
api_path: "https://localhost:5656/api/v1/"  # URL API RuBackup (default: "")
api_user: "user"                            # Имя пользователя API (default: "")
api_pass: "password"                        # Пароль пользователя (default: "")
api_type: "database"                        # Тип аутентификации (database/ldap) (default: "database")
api_insecure: false                         # разрешать самоподписанный сертификат для  API
api_version: v1                             # какую версию API RuBackup использовать (v1 или v2) - будет возвращаться разный набор метрик (default v1)
prefix: "rubackup_v1_"                      # prefix - префикс, который добавляется в имени метрики - по умолчанию - пусто

Метрики экспортера для версии API v1

№

Название метрики

Описание

Ярлыки

Выходные параметры

1

local_hostname

Получение hostname сервера, на котором работает RuBackup

hostname

Имя хоста (или _unknown)

2

tasks_with_status

Запрос задач с их текущими статусами

client_name,created,hostname,name,task_id,task_type

Список задач со статусами выполнения

Примечание: если в конфигурации задать ключ prefix, то его значение будет добавлено к имени метрики. Допустим, prefix: rubackup_v1_ то имена метрик - rubackup_v1_local_hostname, rubackup_v1_task_list и т.д.

Метрики экспортера для версии API v2

№

Название метрики

Описание

Ярлыки

Выходные параметры

1

rubackup_v2_status_all_tasks

Запрос количества задач в требуемом статусе

cluster_name,status

Количество задач в требуемом статусе

2

rubackup_v2_notification_data

Количество оповещений

hostname,status

Количество оповещений в требуемом статусе

3

rubackup_v2_repository_status

Статус хранилища

id,status

Состояние хранилища - 1

5

rubackup_v2_clients_info

Информация о клиентах

client_hostname,cluster_name,group_id,hwid,id,ipv4,version

Состояние клиентов - 1

6

rubackup_v2_client_used_storage_capacity

Использованный объём хранилища для клиента

hwid,id

Емкость в байтах

7

rubackup_v2_client_storage_capacity_gb

Доступный объём хранилища для клиента

hwid,id

Емкость в ГБайтах

8

rubackup_v2_client_side_restore

Доступность восстановления резервной копии на клиенте

hwid,id

Состояние клиента - 1

9

rubackup_v2_client_side_backup

Доступность создания резервной копии на клиенте

hwid,id

Состояние клиента - 1

10

rubackup_v2_client_is_online

Сетевая доступность клиента

hwid,id

Состояние клиента - 1

11

rubackup_v2_client_centralized_restore

Доступность централизованного восстановления

hwid,id

Состояние клиента - 1

12

rubackup_v2_local_hostname

Получение hostname сервера, на котором работает RuBackup

hostname

Состояние клиента - 0

Примечание1: если в конфигурации задать ключ prefix, то его значение будет добавлено к имени метрики. Допустим, prefix: rubackup_v2_ то имена метрик - rubackup_v2_status_all_tasks, rubackup_v2_local_hostname и т.д.

Примечание2: в api_path надо указать правильный префикс API - то есть, вместо https://localhost:5656/api/v1/ задать https://localhost:5656/api/v2/ - заменить v1 на v2.

Описание файла systemd сервис файла экспортера

Для запуска экспортёра без агента можно использовать следующий unit файл для сервиса:

# /etc/systemd/system/rubackup_exporter.service
[Unit]
Description=Astra Monitoring Rubackup exporter
Wants=basic.target
After=basic.target network.target

[Service]
ExecStart=/usr/local/bin/rubackup-exporter -c /etc/rubackup-exporter.conf -l "0.0.0.0:9444"
ExecReload=/bin/kill -HUP $MAINPID
KillMode=process
Restart=always

[Install]
WantedBy=multi-user.target