46.1. Предварительная настройка оповещений #

Для работы с оповещениями их необходимо предварительно настроить в файле конфигурации менеджера ppem-manager.yml.

Вы можете указать следующие параметры:

alerts:
  metrics:
    request_chunk_size: количество_идентификаторов_экземпляров
  cleanup_grace_period: интервал_удаления_оповещений_если_данные_не_получены
  scheduler:
    interval: интервал_проверки_новых_оповещений
    initial_delay: задержка_запуска_планировщика_оповещений
    timeout: тайм-аут_обновления_правил_триггеров_оповещений
  delayed_data:
    is_enabled: true или false
    data_delay: задержка_получения_данных_из_любых_источников_установленная_по_умолчанию
    datasource_delays:
      metrics: задержка_получения_метрик
      logs: задержка_получения_данных_журналов
    max_delay: максимально_допустимая_задержка_получения_данных
    is_adaptive_delay: true или false
  notifier:
    num_workers: количество_параллельных_рабочих_процессов
    worker_batch_size: количество_оповещений_в_одном_пакете
    worker_interval: интервал_проверки_новых_оповещений
    backoff_base: длительность_расчёта_экспоненциальной_задержки
    max_retries: максимальное_количество_попыток_оповещения
    notification_timeout: тайм-аут_оповещения
    janitor_interval: интервал_опроса_рабочего_процесса_очистки
    stale_processing_timeout: тайм-аут_обработки_устаревших_оповещений
  email:
    is_enabled: true или false
    smtp:
      host: имя_хоста_или_IP_SMTP-сервера
      port: порт_SMTP-сервера
      username: имя_пользователя_для_аутентификации_в_SMTP-сервере
      password: пароль_для_аутентификации_в_SMTP-сервере
      from: электронная_почта_отправителя_оповещений
      timeout: тайм-аут_подключения_к_SMTP-серверу
      use_starttls: true или false
      use_ssl: true или false
      tls:
        insecure_skip_verify: true или false
        root_ca_path: путь_к_корневому_сертификату

Где:

  • metrics: параметры отправки запросов плагину метрик.

    • request_chunk_size: максимальное количество идентификаторов экземпляров в одном запросе.

      Значение по умолчанию: 100.

  • cleanup_grace_period: интервал, после которого оповещения удаляются, если данные не получены.

    Значение по умолчанию: 6h.

  • scheduler: параметры планировщика, который обновляет оповещения в памяти менеджера.

    • interval: интервал для проверки планировщиком новых оповещений, которые необходимо обработать.

      Значение по умолчанию: 50s.

    • initial_delay: задержка перед первым запуском планировщика после запуска PPEM.

      Значение по умолчанию: 10s.

    • timeout: тайм-аут для обновления планировщиком правил триггеров оповещений.

      Значение по умолчанию: 10m.

  • delayed_data: параметры для управления обработкой метрик и данных журналов, если они приходят с задержкой и точное время задержки неизвестно.

    • is_enabled: указывает, включены ли параметры управления обработкой данных, получаемых с задержкой.

      Возможные значения:

      • true

      • false

      Если для параметра задано значение true, в PPEM учитываются задержки при получении метрик и данных журналов.

      Значение по умолчанию: false.

    • data_delay: установленная по умолчанию задержка получения данных из любых источников, если не настроены конкретные параметры управления обработкой данных, получаемых с задержкой.

      Значение по умолчанию: 180s.

    • datasource_delays: задержка при получении данных из определённых источников. Этот параметр позволяет настроить разное время задержки для метрик и данных журналов, поскольку они могут поступать с разной скоростью.

      Возможные значения:

      • metrics: задержка при получении метрик, в секундах. Как правило, интервалы сбора метрик более прогнозируемые, но задержки могут возникнуть из-за проблем с сетью или обработкой.

      • logs: задержка при получении данных журналов, в секундах. Данные журналов могут поступать чаще, но с меньшей предсказуемостью по времени из-за ротации и обработки журналов.

    • max_delay: максимально допустимая задержка, чтобы избежать обработки устаревших данных. Данные, полученные ранее установленного значения, игнорируются, чтобы не выводились неверные оповещения об устаревших данных.

      Значение по умолчанию: 600s.

    • is_adaptive_delay: включает или отключает адаптивный механизм обучения на задержках получения данных, основанный на анализе истории получения данных.

      Возможные значения:

      • true

      • false

      Если механизм включён, фактические задержки при получении данных анализируются в PPEM на основе меток времени, и временное окно настраивается динамически.

      Значение по умолчанию: true.

  • notifier: параметры системы уведомлений, которая отправляет оповещения.

    • num_workers: количество параллельных рабочих процессов, которые отправляют оповещения.

      Значение по умолчанию: 5.

    • worker_batch_size: количество оповещений, обрабатываемых рабочими процессами в одном пакете.

      Значение по умолчанию: 20.

    • worker_interval: интервал опроса, с которым рабочие процессы проверяют, не появились ли новые оповещения в базе данных репозитория.

      Значение по умолчанию: 30s.

    • backoff_base: базовая длительность расчёта экспоненциальной задержки при повторной отправке неудавшегося оповещения.

      Задержка повторной отправки оповещения рассчитывается как:

      базовая_задержка X (2^количество_попыток_повторной_отправки).

      Значение по умолчанию: 10s.

    • max_retries: максимальное количество попыток повторно отправить неудавшееся оповещение.

      Значение по умолчанию: 3.

    • notification_timeout: максимальное время, в течение которого система уведомлений должна ожидать отправки оповещения. Если по прошествии этого времени оповещение не было отправлено, оно считается неудавшимся.

      Значение по умолчанию: 20s.

    • janitor_interval: интервал опроса рабочего процесса очистки (janitor worker), который очищает оповещения, застрявшие в состоянии обработки.

      Значение по умолчанию: 1m.

    • stale_processing_timeout: время, по прошествии которого оповещения, застрявшие в состоянии обработки, считаются устаревшими и должны быть сброшены рабочим процессом очистки.

      Значение по умолчанию: 10m.

  • email: параметры отправки оповещений по электронной почте.

    • is_enabled: указывает, отправляются ли оповещения по электронной почте.

      Возможные значения:

      • true

      • false

      Если указано значение false, вместо отправки по электронной почте оповещения попадают в журнал.

      Значение по умолчанию: false.

    • smtp: параметры SMTP-сервера, используемого для отправки оповещений.

      • host: имя хоста или IP-адрес SMTP-сервера.

        Значение по умолчанию: localhost.

      • port: номер порта SMTP-сервера.

        Значение по умолчанию: 25.

      • username: имя пользователя для аутентификации в SMTP-сервере.

        Значение по умолчанию: "".

      • password: пароль для аутентификации в SMTP-сервере.

        Значение по умолчанию: "".

      • from: адрес электронной почты отправителя оповещений.

        Значение по умолчанию: admin@localdomain.local.

      • timeout: тайм-аут подключения к SMTP-серверу.

        Значение по умолчанию: 10s.

      • use_starttls: указывает, используется ли расширение STARTTLS для обеспечения безопасности подключения к SMTP-серверу.

        Возможные значения:

        • true

        • false

        Значение по умолчанию: false.

      • use_ssl: указывает, используется ли протокол SSL/TLS для подключения к SMTP-серверу.

        Возможные значения:

        • true

        • false

        Значение по умолчанию: false.

      • tls: параметры TLS-протокола.

        • insecure_skip_verify: указывает, пропускает ли клиент проверку цепочки сертификатов и имени хоста SMTP-сервера.

          Возможные значения:

          • true

          • false

          Значение по умолчанию: false.

          Важно

          Задавать true для этого параметра небезопасно. Делайте это только для тестирования или при работе с доверенными сетями.

        • root_ca_path: путь к корневому сертификату, который используется для проверки сертификата SMTP-сервера.

          Значение по умолчанию: "".