CustomAlertmanager

Scope: Cluster
Version: v1alpha1

Ресурс для подключения дополнительных Alertmanagers к Prometheus.

  • specобъект

    Обязательный параметр

    • externalобъект
      • addressстрока

        URL внешнего сервиса Alertmanager.

        Шаблон: ^https?://[^\s/$.?#].[^\s]*$

        Примеры:

        address: http://alerts.mycompany.com
        
        address: https://alerts.company.com
        
        address: http://192.168.1.1
        
      • authобъект

        Authorization properties.

        • basicобъект

          Basic authorization properties.

          • passwordстрока
          • usernameстрока
      • serviceобъект

        Сервис Alertmanager внутри kubernetes кластера.

        • nameстрока

          Обязательный параметр

          Name of an Alertmanager service.

        • namespaceстрока

          Обязательный параметр

          Namespace of an Alertmanager service.

        • pathстрока

          URL prefix in a service to send alerts for.

          По умолчанию: "/"

      • tlsобъект
        • caстрока
        • certстрока
        • insecureSkipVerifyбулевый

          По умолчанию: false

        • keyстрока
    • typeстрока

      Допустимые значения: External

CustomPrometheusRules

Scope: Cluster

Ресурс хранения PrometheusRule.

Подробнее….

  • specобъект

    Обязательный параметр

    • groupsмассив объектов

      Обязательный параметр

      Описание группы алертов.

      Структура групп полностью совпадает с аналогичной в prometheus-operator.

      • intervalстрока
      • nameстрока

        Обязательный параметр

      • rulesмассив объектов

        Обязательный параметр

        • alertстрока
        • annotationsобъект
        • exprстрока или число

          Обязательный параметр

        • forстрока
        • labelsобъект
        • recordстрока

Ресурс хранения PrometheusRule.

Подробнее….

  • specобъект

    Обязательный параметр

    • groupsмассив объектов

      Обязательный параметр

      Описание группы алертов.

      Структура групп полностью совпадает с аналогичной в prometheus-operator.

      • intervalстрока
      • nameстрока

        Обязательный параметр

      • rulesмассив объектов

        Обязательный параметр

        • alertстрока
        • annotationsобъект
        • exprстрока или число

          Обязательный параметр

        • forстрока
        • labelsобъект
        • recordстрока

GrafanaAdditionalDatasource

Scope: Cluster

Ресурс для подключения дополнительных datasource к Grafana.

Параметры ресурса подробно описаны в документации к Grafana.

  • specобъект

    Обязательный параметр

    • accessстрока

      Обязательный параметр

      Режим доступа.

      Допустимые значения: Proxy, Direct

    • basicAuthбулевый

      Включить/выключить basic auth.

    • basicAuthUserстрока

      Basic auth username.

    • databaseстрока

      Database name, если ипользуется.

    • jsonDataобъект

      Поля, которые будут конвертированы в JSON и сохранены в jsonData.

    • secureJsonDataобъект

      JSON-объект данных, который будет сохранен зашифрованным.

    • typeстрока

      Обязательный параметр

      Тип datasource.

    • urlстрока

      Datasource URL.

      Пример:

      url: http://localhost:8080
      
    • userстрока

      Database username.

    • withCredentialsбулевый

      Enable/disable with credentials headers

Ресурс для подключения дополнительных datasource к Grafana.

Параметры ресурса подробно описаны в документации к Grafana.

  • specобъект

    Обязательный параметр

    • accessстрока

      Обязательный параметр

      Режим доступа.

      Допустимые значения: proxy, direct

    • basicAuthбулевый

      Включить/выключить basic auth.

    • basicAuthUserстрока

      Basic auth username.

    • databaseстрока

      Database name, если ипользуется.

    • jsonDataобъект

      Поля, которые будут конвертированы в JSON и сохранены в jsonData.

    • secureJsonDataобъект

      JSON-объект данных, который будет сохранен зашифрованным.

    • typeстрока

      Обязательный параметр

      Тип datasource.

    • urlстрока

      Datasource URL.

      Пример:

      url: http://localhost:8080
      
    • userстрока

      Database username.

    • withCredentialsбулевый

      Enable/disable with credentials headers

GrafanaAlertsChannel

Scope: Cluster
Version: v1alpha1

Ресурс для добавления каналов оповещения в Grafana.

  • specобъект

    Обязательный параметр

    • alertManagerобъект

      Обязательный параметр

      Настройка канала внешнего Prometheus Alert Manager.

      • addressстрока

        Обязательный параметр

        URL внешнего Alertmanager.

        Шаблон: ^https?://[^\s/$.?#].[^\s]*$

        Примеры:

        address: http://alerts.mycompany.com
        
        address: https://alerts.company.com
        
        address: http://192.168.1.1
        
      • authобъект

        Параметры авторизации.

        • basicобъект

          Обязательный параметр

          Basic authorization параметры.

          • passwordстрока

            Обязательный параметр

            Пароль.

          • usernameстрока

            Обязательный параметр

            Пользователь.

    • descriptionстрока

      Небольшое необязательное описание для этого канала предупреждений.

      По умолчанию: ""

    • disableResolveMessageбулевый

      Отключает отправку алерта о разрешении [OK] когда состояние алерт возвращается в неактивное состояние.

      По умолчанию: false

    • isDefaultбулевый

      Использовать этот канал для всех алертов.

      По умолчанию: false

    • typeстрока

      Обязательный параметр

      Допустимые значения: PrometheusAlertManager

GrafanaDashboardDefinition

Scope: Cluster

Ресурс хранения и управления Dashboard в Grafana.

  • specобъект

    Обязательный параметр

    • definitionстрока

      Обязательный параметр

      JSON-манифест dashboard.

      Важно! Следите, чтобы помимо uid в манифесте не было “местного” id по адресу .id.

    • folderстрока

      Обязательный параметр

      В какую папку попадёт данный dashboard. Если такой папки нет, она будет создана.

      Пример:

      folder: My Folder
      

Ресурс хранения и управления Dashboard в Grafana.

  • specобъект

    Обязательный параметр

    • definitionстрока

      Обязательный параметр

      JSON-манифест dashboard.

      Важно! Следите, чтобы помимо uid в манифесте не было “местного” id по адресу .id.

    • folderстрока

      Обязательный параметр

      В какую папку попадёт данный dashboard. Если такой папки нет, она будет создана.

      Пример:

      folder: My Folder
      

PrometheusRemoteWrite

Scope: Cluster

Ресурс для включения remote_write данных из локального Prometheus в отдельный longterm storage (например: VictoriaMetrics).

Таких ресурсов в кластере может быть любое количество.

  • specобъект

    Обязательный параметр

    • basicAuthобъект

      Параметры базовой авторизации для отправки данных.

      • passwordстрока

        Обязательный параметр

        Пароль для аутентификации.

      • usernameстрока

        Обязательный параметр

        Имя пользователя для аутентификации.

    • tlsConfigобъект

      Параметры TLS.

      • insecureSkipVerifyбулевый

        Отключить проверку сертификата.

        По умолчанию: false

    • urlстрока

      Обязательный параметр

      Адрес, по которому Prometheus будет отправлять данные.

      Пример:

      url: https://victoriametrics-test.domain.com/api/v1/write
      
    • writeRelabelConfigsмассив объектов

      Параметры для relabel’инга данных для отправки.

      Например, если необходимо удалить лишние метрики или произвести релейбл данных.

      • actionстрока

        Действие, выполняемое при соответствии регулярному выражению.

        По умолчанию: "replace"

      • modulusцелочисленный

        Модуль для хеширования значений исходного лейбла.

      • regexстрока

        Регулярное выражение для применения к извлеченному значению.

        По умолчанию: "(.*)"

      • replacementстрока

        На что заменять, в случае соответствия шаблону регулярного выражения.

        Доступны regexp-группы.

        По умолчанию: "$1"

      • separatorстрока

        Символ, разделяющий исходные метки.

        По умолчанию: ";"

      • sourceLabelsмассив строк

        Исходные метки для выбора значений.

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

      • targetLabelстрока

        Метка, в которую записывается результирующее значение при замене.

        Поле является обезательным при action: replace.

Ресурс для включения remote_write данных из локального Prometheus в отдельный longterm storage (например: VictoriaMetrics).

Таких ресурсов в кластере может быть любое количество.

  • specобъект

    Обязательный параметр

    • basicAuthобъект

      Параметры базовой авторизации для отправки данных.

      • passwordстрока

        Обязательный параметр

        Пароль для аутентификации.

      • usernameстрока

        Обязательный параметр

        Имя пользователя для аутентификации.

    • tlsConfigобъект

      Параметры TLS.

      • insecureSkipVerifyбулевый

        Отключить проверку сертификата.

        По умолчанию: false

    • urlстрока

      Обязательный параметр

      Адрес, по которому Prometheus будет отправлять данные.

      Пример:

      url: https://victoriametrics-test.domain.com/api/v1/write
      
    • writeRelabelConfigsмассив объектов

      Параметры для relabel’инга данных для отправки.

      Например, если необходимо удалить лишние метрики или произвести релейбл данных.

      • actionстрока

        Действие, выполняемое при соответствии регулярному выражению.

        По умолчанию: "replace"

      • modulusцелочисленный

        Модуль для хеширования значений исходного лейбла.

      • regexстрока

        Регулярное выражение для применения к извлеченному значению.

        По умолчанию: "(.*)"

      • replacementстрока

        На что заменять, в случае соответствия шаблону регулярного выражения.

        Доступны regexp-группы.

        По умолчанию: "$1"

      • separatorстрока

        Символ, разделяющий исходные метки.

        По умолчанию: ";"

      • sourceLabelsмассив строк

        Исходные метки для выбора значений.

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

      • targetLabelстрока

        Метка, в которую записывается результирующее значение при замене.

        Поле является обезательным при action: replace.