Доступно в редакциях:  Open/CE, Core, BE, SE, SE+, Ultimate/EE, Certified Pro/CSE Pro (1.73)

Стадия жизненного цикла модуля: Общедоступная версия

У модуля есть требования для установки

Как явно включить или отключить модуль…

Явно включить или выключить модуль можно одним из следующих способов:

  • С помощью веб-интерфейса Deckhouse. В разделе «Система» → «Управление системой» → «Deckhouse» → «Модули» откройте модуль observability и включите (или выключите) переключатель «Модуль включен». Сохраните изменения.

    Пример:

    Интерфейс включения и выключения модуля
  • С помощью Deckhouse CLI (d8).

    Используйте команду d8 system module enable для включения модуля или d8 system module disable для выключения модуля (требуется Deckhouse CLI (d8), настроенный на работу с кластером).

    Пример включения модуля observability:

    d8 system module enable observability
  • С помощью ModuleConfig observability.

    Установите spec.enabled в true или false в ModuleConfig observability (при необходимости создайте его).

    Пример манифеста для включения модуля observability:

    apiVersion: deckhouse.io/v1alpha1
    kind: ModuleConfig
    metadata:
      name: observability
    spec:
      enabled: true

Как настроить модуль…

Настроить модуль можно одним из следующих способов:

  • С помощью веб-интерфейса Deckhouse.

    В разделе «Система» → «Управление системой» → «Deckhouse» → «Модули» откройте модуль observability и включите переключатель «Дополнительные настройки». Заполните необходимые поля формы на вкладке «Конфигурация» или укажите настройки модуля в формате YAML на вкладке «YAML» без ключа верхнего уровня settings. Сохраните изменения.

    Пример:

    Интерфейс настройки модуля

    Вы также можете отредактировать объект ModuleConfig observability на вкладке «YAML» в окне настроек модуля («Система» → «Управление системой» → «Deckhouse» → «Модули», откройте модуль observability), указав версию схемы в параметре spec.version и необходимые параметры модуля в секции spec.settings.

  • С помощью Deckhouse CLI (d8) (требуется Deckhouse CLI (d8), настроенный на работу с кластером).

    Отредактируйте существующий ModuleConfig observability (подробнее о настройке Deckhouse Platform читайте в документации), выполнив следующую команду:

    d8 k edit mc observability

    Внесите необходимые изменения в секцию spec.settings. При необходимости укажите версию схемы в параметре spec.version. Сохраните изменения.

    Вы также можете создать файл манифеста ModuleConfig observability, используя пример ниже. Заполните секцию spec.settings необходимыми параметрами модуля. При необходимости укажите версию схемы в параметре spec.version.

    Примените манифест с помощью следующей команды (укажите имя файла манифеста):

    d8 k apply -f <FILENAME>

    Пример файла манифеста ModuleConfig observability:

    apiVersion: deckhouse.io/v1alpha1
    kind: ModuleConfig
    metadata:
      name: observability
    spec:
      version: 2
      enabled: true
      settings: # Параметры модуля из раздела «Параметры» ниже.

Как сменить канал обновлений модуля…

Чтобы сменить канал обновлений модуля, выполните действия из раздела Как сменить канал обновлений для модуля?.

Требования

К версии Deckhouse Platform: 1.74 и выше.

К версиям других модулей:

  • console: 1.41.1 и выше.
  • operator-prometheus: любая версия.
  • prometheus: любая версия.

Конверсии

Модуль настраивается с помощью ресурса ModuleConfig, схема которого содержит номер версии. При применении в кластере старой версии схемы ModuleConfig выполняются автоматические преобразования. Чтобы обновить версию схемы ModuleConfig вручную, необходимо последовательно для каждой версии выполнить следующие действия:

  • Обновление из версии 1 в 2:

    Удалите поле .dop.nodeAffinity: агент собирает метрики узла вместо node-exporter и работает на всех узлах кластера, ограничение набора узлов больше не поддерживается.

Параметры

Версия схемы: 2

  • settings
    объект
    • settings.deadMansSwitch
      объект
      Настройки алерта DeadMansSwitch.

      По умолчанию: {}

      • settings.deadMansSwitch.enabled
        булевый

        Включить обработку алерта DeadMansSwitch.

        Если включено (по умолчанию), ожидается heartbeat-алерт DeadMansSwitch от Prometheus, и при его отсутствии генерируется алерт PrometheusUnavailable. Если выключено, ни DeadMansSwitch, ни PrometheusUnavailable не создаются.

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

    • settings.dop
      объект
      Настройки интеграции с DOP (Deckhouse Observability Platform).

      По умолчанию: {}

      • settings.dop.destinations
        массив объектов
        Список назначений DOP для доставки метрик. Необходимо указать хотя бы одно назначение.

        Пример:

        destinations:
        - host: dop.flant.com
          token: your-api-token-here
        
        • settings.dop.destinations.host
          строка
          Адрес хоста платформы DOP (должен быть валидным FQDN, например, dop.flant.com).

          Длина: 1..253

          Шаблон: ^[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$

        • settings.dop.destinations.token
          строка
          API-токен для платформы DOP (формат UUID).

          Шаблон: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$

      • settings.dop.hostMetrics
        булевый
        Включить сбор метрик узлов с помощью okagent.

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

    • settings.externalMetricsAccess
      объект
      Настройки доступа к метрикам извне кластера.

      По умолчанию: {}

      • settings.externalMetricsAccess.enabled
        булевый

        Разрешить доступ к метрикам извне кластера.

        Если параметр включен, модуль observability будет предоставлять метрики через Ingress для чтения. Метрики можно читать с помощью Prometheus-совместимого API. Обязательно предоставление действительного токена ServiceAccount через заголовок Authorization: Bearer. Подробнее — в подразделе «Доступ к метрикам вне кластера».

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

      • settings.externalMetricsAccess.whitelistSourceRanges
        массив строк
        Список адресов в формате CIDR, которым разрешено проходить аутентификацию. Если параметр не указан, аутентификацию разрешено проходить без ограничения по IP-адресу.

        По умолчанию: []

        Пример:

        whitelistSourceRanges:
        - 1.1.1.1/32
        
        • settings.externalMetricsAccess.whitelistSourceRanges.Элемент массива
          строка

          Шаблон: ^(((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])(/([0-9]|[12][0-9]|3[0-2]))?|([0-9A-Fa-f]{0,4}:){2,7}[0-9A-Fa-f]{0,4}(/([0-9]|[1-9][0-9]|1[01][0-9]|12[0-8]))?)$

    • settings.grafana
      объект
      Настройки для Grafana.

      По умолчанию: {}

      • settings.grafana.customPlugins
        массив строк

        Список дополнительных plug-in’ов для Grafana.

        Необходимо указать в качестве значения список имен плагинов из официального репозитория.

        Пример добавления plug-in’ов для возможности указания clickhouse в качестве datasource и панели flow-chart:

        grafana:
          customPlugins:
          - agenty-flowcharting-panel
          - vertamedia-clickhouse-datasource

        Вы также можете устанавливать плагины из других источников передав ссылку на zip-архив плагина в формате <url to plugin zip>;<plugin name>:

        grafana:
          customPlugins:
          - http://10.241.32.16:3000/netsage-bumpchart-panel-1.1.1.zip;netsage-bumpchart-panel

        Пример:

        customPlugins:
        - agenty-flowcharting-panel
        - vertamedia-clickhouse-datasource
        
    • settings.highAvailability
      булевый

      Ручное управление режимом отказоустойчивости.

      По умолчанию режим берётся из глобального параметра highAvailability, а если он не задан — включается, когда control plane кластера работает в режиме отказоустойчивости.

      alert-kube-api и observability-webhook всегда работают в двух репликах, независимо от этого параметра.

      Примеры:

      highAvailability: true
      
      highAvailability: false
      
    • settings.https
      объект

      Тип сертификата, используемого для модуля observability.

      При использовании этого параметра полностью переопределяются глобальные настройки global.modules.https.

      Примеры:

      customCertificate:
        secretName: foobar
      mode: CustomCertificate
      
      certManager:
        clusterIssuerName: letsencrypt
      mode: CertManager
      
      • settings.https.certManager
        объект
        • settings.https.certManager.clusterIssuerName
          строка

          ClusterIssuer, используемый для модуля observability.

          Доступны letsencrypt, letsencrypt-staging, selfsigned, но вы можете определить свои.

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

      • settings.https.customCertificate
        объект

        По умолчанию: {}

        • settings.https.customCertificate.secretName
          строка

          Имя Secret’а в пространстве имен d8-system, который будет использоваться для модуля observability.

          Secret должен быть в формате TLS.

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

      • settings.https.mode
        строка

        Режим работы HTTPS:

        • Disabled — Модуль observability будет работать только по HTTP;
        • CertManager — Модуль observability будет работать по HTTPS и заказывать сертификат с помощью ClusterIssuer, заданного в параметре certManager.clusterIssuerName;
        • CustomCertificate — Модуль observability будет работать по HTTPS, используя сертификат из namespace d8-system;
        • OnlyInURI — Модуль observability будет работать по HTTP (подразумевая, что перед ними стоит внешний балансировщик, который терминирует HTTPS) и все ссылки в user-authn будут генерироваться с HTTPS-схемой. Балансировщик должен обеспечивать перенаправление с HTTP на HTTPS.

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

        Допустимые значения: Disabled, CertManager, CustomCertificate, OnlyInURI

    • settings.ingressClass
      строка

      The ingress class to use for all ingress resources created by the observability module.

      This parameter completely overrides the global.modules.ingressClass settings. If not specified, the global ingress class configuration will be used.

      The value must be a valid Kubernetes resource name (lowercase alphanumeric characters or hyphens, must start and end with alphanumeric character).

      Шаблон: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

      Примеры:

      ingressClass: nginx
      
      ingressClass: nginx-external
      
    • settings.lightweightLogs
      объект
      Настройки сбора логов контейнеров напрямую с kubelet.

      По умолчанию: { "enabled": true }

      • settings.lightweightLogs.enabled
        булевый
        Включить сбор логов контейнеров напрямую с kubelet.

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

    • settings.loki
      объект
      Настройки встроенного хранилища логов Loki.

      По умолчанию: {}

      • settings.loki.allowDeleteLogs
        булевый
        Разрешить удаление логов через эндпоинты /loki/api/v1/delete.

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

      • settings.loki.distributed
        объект
        Настройки режима Distributed (Loki Simple Scalable). Требует storage.type: S3.

        По умолчанию: {}

        • settings.loki.distributed.backend
          объект
          Настройки компонента backend, в котором работают compactor, index gateway, query scheduler и ruler.

          По умолчанию: {}

          • settings.loki.distributed.backend.replicas
            целое число
            Количество реплик backend.

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

            Допустимые значения: 2 <= X

          • settings.loki.distributed.backend.resourcesManagement
            Настройки запросов и лимитов CPU и памяти для подов backend.

            По умолчанию: {}

            • settings.loki.distributed.backend.resourcesManagement.mode
              строка

              Режим управления ресурсами:

              • Static — классический, вы указываете requests/limits.
              • VPA — используется VPA.

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

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

            • settings.loki.distributed.backend.resourcesManagement.static
              объект
              Настройки управления ресурсами для режима Static.
              • settings.loki.distributed.backend.resourcesManagement.static.limits
                объект
                • settings.loki.distributed.backend.resourcesManagement.static.limits.cpu
                • settings.loki.distributed.backend.resourcesManagement.static.limits.memory
              • settings.loki.distributed.backend.resourcesManagement.static.requests
                объект
                • settings.loki.distributed.backend.resourcesManagement.static.requests.cpu
                • settings.loki.distributed.backend.resourcesManagement.static.requests.memory
            • settings.loki.distributed.backend.resourcesManagement.vpa
              объект
              Настройки управления ресурсами для режима VPA.

              По умолчанию: {}

              • settings.loki.distributed.backend.resourcesManagement.vpa.cpu
                объект

                По умолчанию: {}

                • settings.loki.distributed.backend.resourcesManagement.vpa.cpu.limitRatio
                  число
                • settings.loki.distributed.backend.resourcesManagement.vpa.cpu.max

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

                • settings.loki.distributed.backend.resourcesManagement.vpa.cpu.min

                  По умолчанию: 50m

              • settings.loki.distributed.backend.resourcesManagement.vpa.memory
                объект

                По умолчанию: {}

                • settings.loki.distributed.backend.resourcesManagement.vpa.memory.limitRatio
                  число
                • settings.loki.distributed.backend.resourcesManagement.vpa.memory.max

                  По умолчанию: 2Gi

                • settings.loki.distributed.backend.resourcesManagement.vpa.memory.min

                  По умолчанию: 256Mi

              • settings.loki.distributed.backend.resourcesManagement.vpa.mode
                строка

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

                Допустимые значения: Initial, InPlaceOrRecreate, Auto

        • settings.loki.distributed.read
          объект
          Настройки компонента read, который обслуживает запросы.

          По умолчанию: {}

          • settings.loki.distributed.read.replicas
            целое число
            Количество реплик read.

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

            Допустимые значения: 1 <= X

          • settings.loki.distributed.read.resourcesManagement
            Настройки запросов и лимитов CPU и памяти для подов read.

            По умолчанию: {}

            • settings.loki.distributed.read.resourcesManagement.mode
              строка

              Режим управления ресурсами:

              • Static — классический, вы указываете requests/limits.
              • VPA — используется VPA.

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

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

            • settings.loki.distributed.read.resourcesManagement.static
              объект
              Настройки управления ресурсами для режима Static.
              • settings.loki.distributed.read.resourcesManagement.static.limits
                объект
                • settings.loki.distributed.read.resourcesManagement.static.limits.cpu
                • settings.loki.distributed.read.resourcesManagement.static.limits.memory
              • settings.loki.distributed.read.resourcesManagement.static.requests
                объект
                • settings.loki.distributed.read.resourcesManagement.static.requests.cpu
                • settings.loki.distributed.read.resourcesManagement.static.requests.memory
            • settings.loki.distributed.read.resourcesManagement.vpa
              объект
              Настройки управления ресурсами для режима VPA.

              По умолчанию: {}

              • settings.loki.distributed.read.resourcesManagement.vpa.cpu
                объект

                По умолчанию: {}

                • settings.loki.distributed.read.resourcesManagement.vpa.cpu.limitRatio
                  число
                • settings.loki.distributed.read.resourcesManagement.vpa.cpu.max

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

                • settings.loki.distributed.read.resourcesManagement.vpa.cpu.min

                  По умолчанию: 50m

              • settings.loki.distributed.read.resourcesManagement.vpa.memory
                объект

                По умолчанию: {}

                • settings.loki.distributed.read.resourcesManagement.vpa.memory.limitRatio
                  число
                • settings.loki.distributed.read.resourcesManagement.vpa.memory.max

                  По умолчанию: 2Gi

                • settings.loki.distributed.read.resourcesManagement.vpa.memory.min

                  По умолчанию: 256Mi

              • settings.loki.distributed.read.resourcesManagement.vpa.mode
                строка

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

                Допустимые значения: Initial, InPlaceOrRecreate, Auto

        • settings.loki.distributed.write
          объект
          Настройки компонента write, который принимает запись и сбрасывает чанки в хранилище.

          По умолчанию: {}

          • settings.loki.distributed.write.replicas
            целое число

            Количество реплик write.

            Не может быть меньше 3: кольцо настроено с фактором репликации 3.

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

            Допустимые значения: 3 <= X

          • settings.loki.distributed.write.resourcesManagement
            Настройки запросов и лимитов CPU и памяти для подов write.

            По умолчанию: {}

            • settings.loki.distributed.write.resourcesManagement.mode
              строка

              Режим управления ресурсами:

              • Static — классический, вы указываете requests/limits.
              • VPA — используется VPA.

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

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

            • settings.loki.distributed.write.resourcesManagement.static
              объект
              Настройки управления ресурсами для режима Static.
              • settings.loki.distributed.write.resourcesManagement.static.limits
                объект
                • settings.loki.distributed.write.resourcesManagement.static.limits.cpu
                • settings.loki.distributed.write.resourcesManagement.static.limits.memory
              • settings.loki.distributed.write.resourcesManagement.static.requests
                объект
                • settings.loki.distributed.write.resourcesManagement.static.requests.cpu
                • settings.loki.distributed.write.resourcesManagement.static.requests.memory
            • settings.loki.distributed.write.resourcesManagement.vpa
              объект
              Настройки управления ресурсами для режима VPA.

              По умолчанию: {}

              • settings.loki.distributed.write.resourcesManagement.vpa.cpu
                объект

                По умолчанию: {}

                • settings.loki.distributed.write.resourcesManagement.vpa.cpu.limitRatio
                  число
                • settings.loki.distributed.write.resourcesManagement.vpa.cpu.max

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

                • settings.loki.distributed.write.resourcesManagement.vpa.cpu.min

                  По умолчанию: 50m

              • settings.loki.distributed.write.resourcesManagement.vpa.memory
                объект

                По умолчанию: {}

                • settings.loki.distributed.write.resourcesManagement.vpa.memory.limitRatio
                  число
                • settings.loki.distributed.write.resourcesManagement.vpa.memory.max

                  По умолчанию: 2Gi

                • settings.loki.distributed.write.resourcesManagement.vpa.memory.min

                  По умолчанию: 256Mi

              • settings.loki.distributed.write.resourcesManagement.vpa.mode
                строка

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

                Допустимые значения: Initial, InPlaceOrRecreate, Auto

      • settings.loki.enabled
        булевый
        Включить встроенное хранилище логов Loki.

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

      • settings.loki.lokiConfig
        объект

        Параметры конфигурации Loki, доступные для тонкой настройки.

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

        Внимание! Некорректные настройки могут привести к неработоспособности Loki.

        По умолчанию: {}

        • settings.loki.lokiConfig.grpcServerMaxConcurrentStreams
          целое число
          Ограничение на количество одновременных потоков для вызовов gRPC.

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

        • settings.loki.lokiConfig.grpcServerMaxRecvMsgSize
          целое число
          Ограничение на размер gRPC-сообщения, которое сервер может принять, в байтах.

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

        • settings.loki.lokiConfig.grpcServerMaxSendMsgSize
          целое число
          Ограничение на размер gRPC-сообщения, которое сервер может отправить, в байтах.

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

        • settings.loki.lokiConfig.ingestionBurstSizeMB
          число
          Общий размер всплеска при приёме данных в мегабайтах. Например, максимальный размер запроса на запись.

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

        • settings.loki.lokiConfig.ingestionRateMB
          число
          Общее ограничение скорости приёма данных в мегабайтах в секунду.

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

        • settings.loki.lokiConfig.maxChunksPerQuery
          целое число
          Максимальное количество чанков, которое может быть извлечено за один запрос.

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

        • settings.loki.lokiConfig.maxEntriesLimitPerQuery
          целое число
          Максимальное количество записей, возвращаемых на запрос.

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

        • settings.loki.lokiConfig.maxLabelNamesPerSeries
          целое число
          Максимальное количество уникальных имён меток на серию (поток логов).

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

        • settings.loki.lokiConfig.maxStreamsPerUser
          целое число

          Максимальное общее количество потоков для экземпляра Loki.

          У каждого потока уникальный набор меток. Количество потоков — это количество уникальных наборов меток.

          0 — без ограничений.

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

        • settings.loki.lokiConfig.perStreamRateLimit
          Максимальная скорость записи в байтах в секунду на один поток. Можно указать числом или строкой с единицей измерения (KB, MB, GB).

          По умолчанию: 3MB

        • settings.loki.lokiConfig.perStreamRateLimitBurst
          Максимальный размер всплеска на один поток. Можно указать числом или строкой с единицей измерения (KB, MB, GB).

          По умолчанию: 15MB

      • settings.loki.mode
        строка

        Режим развёртывания.

        • Single — одиночный монолитный экземпляр Loki. Настраивается параметрами single.
        • Distributed — Loki в топологии Simple Scalable, с раздельными компонентами write, read и backend. Требует storage.type: S3, настраивается параметрами distributed.

        Внимание. Смена режима не переносит данные: новый экземпляр стартует пустым. Диск, оставшийся от прежнего режима, автоматически не удаляется.

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

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

      • settings.loki.nodeSelector
        объект

        Структура, аналогичная spec.nodeSelector пода Kubernetes. Применяется ко всем подам Loki: loki в режиме Single, write, read и backend в режиме Distributed.

        Если значение не указано или пустое, будет использоваться автоматика.

        Пример:

        node-role.deckhouse.io/loki: ''
        
      • settings.loki.retentionPeriodHours
        целое число

        Желаемая минимальная глубина хранения логов в часах.

        При storage.type: Disk параметр не ограничивает глубину хранения напрямую: старые данные удаляются только по мере заполнения диска. Если Loki удаляет данные, не достигшие заданной глубины хранения, вы получите алерт LokiInsufficientDiskForRetention. В этом случае нужно либо увеличить размер диска, либо уменьшить значение параметра.

        При storage.type: S3 (в любом режиме) compactor соблюдает этот срок напрямую, и данные старше него удаляются независимо от свободного места.

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

      • settings.loki.single
        объект
        Настройки режима Single.

        По умолчанию: {}

        • settings.loki.single.resourcesManagement
          Настройки запросов и лимитов CPU и памяти для пода Loki.

          По умолчанию: {}

          • settings.loki.single.resourcesManagement.mode
            строка

            Режим управления ресурсами:

            • Static — классический, вы указываете requests/limits.
            • VPA — используется VPA.

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

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

          • settings.loki.single.resourcesManagement.static
            объект
            Настройки управления ресурсами для режима Static.
            • settings.loki.single.resourcesManagement.static.limits
              объект
              • settings.loki.single.resourcesManagement.static.limits.cpu
              • settings.loki.single.resourcesManagement.static.limits.memory
            • settings.loki.single.resourcesManagement.static.requests
              объект
              • settings.loki.single.resourcesManagement.static.requests.cpu
              • settings.loki.single.resourcesManagement.static.requests.memory
          • settings.loki.single.resourcesManagement.vpa
            объект
            Настройки управления ресурсами для режима VPA.

            По умолчанию: {}

            • settings.loki.single.resourcesManagement.vpa.cpu
              объект

              По умолчанию: {}

              • settings.loki.single.resourcesManagement.vpa.cpu.limitRatio
                число
              • settings.loki.single.resourcesManagement.vpa.cpu.max

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

              • settings.loki.single.resourcesManagement.vpa.cpu.min

                По умолчанию: 50m

            • settings.loki.single.resourcesManagement.vpa.memory
              объект

              По умолчанию: {}

              • settings.loki.single.resourcesManagement.vpa.memory.limitRatio
                число
              • settings.loki.single.resourcesManagement.vpa.memory.max

                По умолчанию: 2Gi

              • settings.loki.single.resourcesManagement.vpa.memory.min

                По умолчанию: 256Mi

            • settings.loki.single.resourcesManagement.vpa.mode
              строка

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

              Допустимые значения: Initial, InPlaceOrRecreate, Auto

      • settings.loki.storage
        объект
        Где Loki хранит данные. Хранилище — свойство инсталляции и от режима не зависит.

        По умолчанию: {}

        • settings.loki.storage.disk
          объект

          PersistentVolume каждого stateful-пода Loki: loki в режиме Single, write и backend в режиме Distributed. Диск есть всегда; storage.type определяет, что на нём лежит.

          • Disk — чанки, индекс и write-ahead log. Размер подбирается под глубину хранения retentionPeriodHours: когда диск заполняется, самые старые логи вытесняются.
          • S3 — только write-ahead log, кэш индекса и рабочие файлы compactor. Достаточно небольшого диска, размер по умолчанию подходит. Глубина хранения соблюдается по возрасту силами compactor.

          По умолчанию: {}

          • settings.loki.storage.disk.sizeGigabytes
            целое число

            Размер диска в гигабайтах.

            При storage.type: Disk размер нужно указать вручную, исходя из глубины хранения, заданной параметром retentionPeriodHours.

            Примечание. При перехвате диска у отдельного модуля loki используется размер существующего тома, а этот параметр игнорируется. Если нужен диск большего размера, расширьте PersistentVolumeClaim после миграции.

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

          • settings.loki.storage.disk.storageClass

            Имя StorageClass, который будет использован для диска.

            Если не указан, используется StorageClass существующего PersistentVolumeClaim Loki. Если claim ещё нет, StorageClass будет выбран согласно глобальному параметру storageClass. false — вместо PersistentVolume используется emptyDir, и данные на нём не переживают перезапуск пода.

            Внимание. Указание значения, отличного от текущего (в существующем claim), приведёт к перевыделению диска и удалению всех данных.

            Примеры:

            storageClass: false
            
            storageClass: default
            
        • settings.loki.storage.s3
          объект
          Параметры, используемые при storage.type: S3.

          По умолчанию: {}

          • settings.loki.storage.s3.accessKeyID
            строка
            Access key ID для доступа к S3.
          • settings.loki.storage.s3.bucket
            строка
            Имя бакета для чанков и индексов Loki.
          • settings.loki.storage.s3.endpoint
            строка
            URL эндпоинта S3-совместимого хранилища.
          • settings.loki.storage.s3.insecure
            булевый
            Отключить проверку TLS-сертификата эндпоинта S3.

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

          • settings.loki.storage.s3.region
            строка
            Регион AWS или его аналог для API S3.
          • settings.loki.storage.s3.s3ForcePathStyle
            булевый
            Принудительно использовать path-style URL для S3. Требуется для MinIO и некоторых других провайдеров.

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

          • settings.loki.storage.s3.secretAccessKey
            строка
            Secret access key для доступа к S3.
        • settings.loki.storage.type
          строка

          Где лежат чанки и индекс.

          • Disk — на PersistentVolume, описанном параметрами storage.disk. Единственный вариант с вытеснением логов по заполнению диска. Доступен только в режиме Single: компоненты Distributed используют общее хранилище.
          • S3 — в S3-совместимом объектном хранилище, настраивается параметрами storage.s3. На диске при этом остаются только write-ahead log, кэш индекса и рабочие файлы compactor.

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

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

      • settings.loki.storeSystemLogs
        булевый

        Сохранять в Loki логи из пространств имён d8-*.

        Требуется включённый модуль log-shipper.

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

      • settings.loki.tolerations
        массив объектов

        Структура, аналогичная spec.tolerations пода Kubernetes. Применяется ко всем подам Loki: loki в режиме Single, write, read и backend в режиме Distributed.

        Если значение не указано или пустое, будет использоваться автоматика.

        Пример:

        tolerations:
        - effect: NoExecute
          key: dedicated.deckhouse.io
          operator: Equal
          value: loki
        
        • settings.loki.tolerations.effect
          строка
        • settings.loki.tolerations.key
          строка
        • settings.loki.tolerations.operator
          строка
        • settings.loki.tolerations.tolerationSeconds
          целое число
        • settings.loki.tolerations.value
          строка
    • settings.opagent
      объект
      Настройки сборщика метрик узлов opagent.

      По умолчанию: {}

      • settings.opagent.pingExternalTargets
        массив объектов

        Список дополнительных хостов вне кластера, которые агент пингует с каждого узла.

        Узлы кластера пингуются и без этого параметра, список добавляет внешние хосты. Формат хоста не проверяется: имя, которое не разрешается в IPv4-адрес, всё равно попадает в метрики, но счётчики пакетов для него не растут.

        По умолчанию: []

        Пример:

        pingExternalTargets:
        - host: 8.8.8.8
          name: google-dns
        - host: ya.ru
        
        • settings.opagent.pingExternalTargets.host
          строка
          IP-адрес или host для мониторинга.

          Длина: 1..253

          Шаблон: (?s).*\S.*

        • settings.opagent.pingExternalTargets.name
          строка
          Название записи мониторинга. Если не задано, в качестве названия используется хост.

          Максимальная длина: 253

      • settings.opagent.scrapeInterval
        целое число

        Интервал (в секундах), с которым opagent собирает метрики узла.

        Обычно должен совпадать со scrape_interval кластерного Prometheus, чтобы избежать несоответствия плотности данных в дашбордах Grafana, использующих тот же datasource.

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

        Допустимые значения: 10 <= X

    • settings.polkAnnotations
      объект
      Настройки обработки Polk-специфичных аннотаций в алертах.

      По умолчанию: {}

      • settings.polkAnnotations.enabled
        булевый

        Сохранять Polk-специфичные аннотации (с префиксом plk_) во входящих алертах.

        Если включено (по умолчанию), аннотации plk_* сохраняются в алертах для всех каналов уведомлений. Если выключено, все аннотации plk_* удаляются из алертов при отправке в любые каналы уведомлений.

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