Настройки | loki

Стадия жизненного цикла модуля: Preview
У модуля есть требования для установки

Пример конфигурации

apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: loki
spec:
  settings:
    storageClass: ceph-csi-rbd
    diskSizeGigabytes: 10
    retentionPeriodHours: 48
  enabled: true
  version: 1

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

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

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

Пример:
С помощью Deckhouse CLI (d8).

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

Пример включения модуля loki:
```
d8 system module enable loki
```
С помощью ModuleConfig loki.

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

Пример манифеста для включения модуля loki:
```
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: loki
spec:
  enabled: true
```

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

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

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

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

Пример:

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

Отредактируйте существующий ModuleConfig loki (подробнее о настройке Deckhouse читайте в документации), выполнив следующую команду:
```
d8 k edit mc loki
```
Внесите необходимые изменения в секцию spec.settings. При необходимости укажите версию схемы в параметре spec.version. Сохраните изменения.

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

Примените манифест с помощью следующей команды (укажите имя файла манифеста):
```
d8 k apply -f <FILENAME>
```
Пример файла манифеста ModuleConfig loki:
```
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
  name: loki
spec:
  version: 1
  enabled: true
  settings: # Параметры модуля из раздела "Параметры" ниже.
```

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

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

Требования

К версии Deckhouse: 1.73.0 и выше.

Параметры

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

settings
объект
- settings.allowDeleteLogs
  
  булевый
  Включение / выключение эндпоинтов API для удаления логов.
  
  По умолчанию: false
- settings.diskSizeGigabytes
  
  целочисленный
  Начальный размер диска для хранения логов или размер PVC при указании параметра storageClass.
  
  Вы должны самостоятельно указать необходимый размер диска для хранения логов за период, указанный в параметре retentionPeriodHours.
  
  Занятый объем автоматически мониторится с помощью модуля extended-monitoring
  
  По умолчанию: 2
- settings.lokiConfig
  
  объект
  Опции Loki, доступные для изменения.
  
  Подробнее о настройки Loki читайте в документации Loki.
  
  Внимание! Ошибочные настройки могут привести к неработоспособности Loki.
  
  По умолчанию: {}
  - settings.lokiConfig.grpcServerMaxConcurrentStreams
    
    целочисленный
    Ограничение на количество одновременных потоков для вызовов gRPC.
    
    По умолчанию: 100
  - settings.lokiConfig.grpcServerMaxRecvMsgSize
    
    целочисленный
    Ограничение на размер сообщения gRPC, которое может получить сервер, в байтах.
    
    По умолчанию: 104857600
  - settings.lokiConfig.grpcServerMaxSendMsgSize
    
    целочисленный
    Ограничение на размер сообщения gRPC, которое может отправить сервер, в байтах.
    
    По умолчанию: 4194304
  - settings.lokiConfig.ingestionBurstSizeMB
    
    число
    Общий лимит всплеска объема принимаемых логов. Например, максимальный размер запроса на запись.
    
    По умолчанию: 6
  - settings.lokiConfig.ingestionRateMB
    
    число
    Общий лимит скорости приема логов в мегабайтах в секунду.
    
    По умолчанию: 4
  - settings.lokiConfig.maxChunksPerQuery
    
    целочисленный
    Максимальное количество файлов, которые могут быть скачаны в рамках одного запроса.
    
    По умолчанию: 2000000
  - settings.lokiConfig.maxEntriesLimitPerQuery
    
    целочисленный
    Максимальное количество записей, возвращаемых для одного запроса.
    
    По умолчанию: 5000
  - settings.lokiConfig.maxLabelNamesPerSeries
    
    целочисленный
    Максимальное количество лейблов, которые могут быть использованы в одном потоке логов.
    
    По умолчанию: 32
  - settings.lokiConfig.maxStreamsPerUser
    
    целочисленный
    Максимальное общее количество потоков логов для экземпляра Loki.
    
    Каждый поток логов имеет уникальный набор лейблов. Количество потоков равно количеству уникальных наборов лейблов. Например: {job="my-app", instance="kube-node-1", namespace="production", pod_name="backend-79dbf6fcb7-v5gs7", app="backend"}.
    
    Значение 0 отключает ограничение.
    
    По умолчанию: 0
  - settings.lokiConfig.perStreamRateLimit
    
    Максимальная скорость в байтах в секунду для одного потока. Может быть как числом, так и строкой с единицей измерения (KB, MB, GB).
    
    По умолчанию: 3MB
  - settings.lokiConfig.perStreamRateLimitBurst
    
    Максимальный размер всплеска объема логов для одного потока. Может быть как числом, так и строкой с единицей измерения (KB, MB, GB).
    
    По умолчанию: 15MB
- settings.nodeSelector
  
  объект
  Структура, аналогичная spec.nodeSelector пода Kubernetes.
  
  Если значение не указано или указано false, будет использоваться автоматика.
- settings.resourcesManagement
  
  Настройки запросов (requests) и ограничений (limits) использования CPU и памяти подами Loki.
  
  По умолчанию: {}
  
  Примеры:
  mode: VPA vpa: cpu: limitRatio: 1.5 max: 2 min: 50m memory: limitRatio: 1.5 max: 2Gi min: 256Mi mode: InPlaceOrRecreate
  mode: Static static: limits: cpu: 2 memory: 2Gi requests: cpu: 55m memory: 256Mi
  mode: VPA vpa: cpu: limitRatio: 1.5 max: 2 min: 50m memory: limitRatio: 1.5 max: 2Gi min: 256Mi mode: Auto
  - settings.resourcesManagement.mode
    
    строка
    Режим управления ресурсами:
    
    Static — классический, с помощью указания запросов/ограничений (requests/limits). Настраивается в секции параметров static;
    
    VPA — с помощью VPA. Настраивается в секции параметров vpa.
    По умолчанию: VPA
    
    Допустимые значения: VPA, Static
  - settings.resourcesManagement.static
    
    объект
    Настройка управления ресурсами в режиме Static.
    - settings.resourcesManagement.static.limits
      
      объект
      Настройка ограничений (limits) использования CPU и памяти.
      - settings.resourcesManagement.static.limits.cpu
        
        Настройка ограничений использования CPU (CPU limits).
      - settings.resourcesManagement.static.limits.memory
        
        Настройка ограничений использования памяти (memory limits).
    - settings.resourcesManagement.static.requests
      
      объект
      Настройки запросов ресурсов (requests) подов.
      - settings.resourcesManagement.static.requests.cpu
        
        Настройка запроса CPU (CPU requests).
      - settings.resourcesManagement.static.requests.memory
        
        Настройка запроса памяти (memory requests).
  - settings.resourcesManagement.vpa
    
    объект
    Настройка управления ресурсами в режиме VPA.
    
    По умолчанию: {}
    - settings.resourcesManagement.vpa.cpu
      
      объект
      Настройки VPA при работе с CPU.
      
      По умолчанию: {}
      - settings.resourcesManagement.vpa.cpu.limitRatio
        
        число
        Коэффициент расчета ограничений использования CPU относительно запросов (limits/requests).
        
        Применяется для расчета начальных ограничений использования CPU для пода (CPU limits).
        
        Если параметр указан, то VPA, при пересчете запросов CPU (CPU requests) будет пересчитывать ограничения использования CPU (CPU limits) сохраняя указанное соотношение ограничений к запросам (limits/requests).
      - settings.resourcesManagement.vpa.cpu.max
        
        Максимальное значение, которое может выставить VPA для запроса CPU (CPU requests).
        
        По умолчанию: 2
      - settings.resourcesManagement.vpa.cpu.min
        
        Минимальное значение, которое может выставить VPA для запроса CPU (CPU requests).
        
        По умолчанию: 50m
    - settings.resourcesManagement.vpa.memory
      
      объект
      Настройки VPA при работе с памятью.
      
      По умолчанию: {}
      - settings.resourcesManagement.vpa.memory.limitRatio
        
        число
        Коэффициент расчета ограничений использования памяти относительно запросов (limits/requests).
        
        Применяется для расчета начальных ограничений использования памяти для пода (memory limits).
        
        Если параметр указан, то VPA, при пересчете запросов памяти (memory requests) будет пересчитывать ограничения использования памяти (memory limits) сохраняя указанное соотношение ограничений к запросам (limits/requests).
      - settings.resourcesManagement.vpa.memory.max
        
        Максимальное значение, которое может выставить VPA для запроса к памяти (memory requests).
        
        По умолчанию: 2Gi
      - settings.resourcesManagement.vpa.memory.min
        
        Минимальное значение, которое может выставить VPA для запроса к памяти (memory requests).
        
        По умолчанию: 256Mi
    - settings.resourcesManagement.vpa.mode
      
      строка
      Режим работы VPA.
      
      Initial — VPA устанавливает начальные значения requests/limits при создании пода. В дальнейшем значения ресурсов не изменяются автоматически.
      
      InPlaceOrRecreate — VPA пытается изменить ресурсы пода «на месте» (in-place), если это поддерживается кластером. Если in-place обновление невозможно, под будет пересоздан.
      
      Auto — VPA автоматически пересоздаёт поды для применения новых значений ресурсов. Начиная с версии Deckhouse 1.75 данный режим считается устаревшим. Рекомендуется использовать InPlaceOrRecreate.
      
      По умолчанию: InPlaceOrRecreate
      
      Допустимые значения: Initial, InPlaceOrRecreate, Auto
- settings.retentionPeriodHours
  
  целочисленный
  Желаемый минимальный период хранения логов в часах.
  
  Данный параметр не участвует в управлении глубиной хранения логов, так как Loki удаляет старые данные только при заполнении диска.
  
  В случае, если Loki удалит данные, возраст которых еще не достиг указанного периода хранения, вы получите алерт LokiInsufficientDiskForRetention. В этой ситуации необходимо увеличить размер диска или уменьшить значение данного параметра.
  
  По умолчанию: 168
- settings.storageClass
  
  Имя StorageClass, который будет использоваться по умолчанию в кластере.
  
  Если значение не указано, используется StorageClass существующей PVC Loki. Если PVC нет, будет использоваться StorageClass, согласно настройке глобального параметра storageClass.
  
  Настройка глобального параметра storageClass учитывается только при включении модуля. Изменение глобального параметра storageClass при включенном модуле не приведет к перезаказу диска.
  
  Внимание. Если указать значение, отличное от текущего (используемого в существующей PVC), диск будет перезаказан, и все данные удалятся.
  
  Если указать false, будет принудительно использоваться emptyDir.
  
  Примеры:
  storageClass: false
  storageClass: default
- settings.storeSystemLogs
  
  булевый
  Сохранять логи из пространства имен d8-* в loki.
  
  Для работы необходим включенный модуль log-shipper.
  
  По умолчанию: true
- settings.tolerations
  
  массив объектов
  Структура, аналогичная spec.tolerations пода Kubernetes.
  
  Если значение не указано или указано false, будет использоваться автоматика.
  - settings.tolerations.effect
    
    строка
  - settings.tolerations.key
    
    строка
  - settings.tolerations.operator
    
    строка
  - settings.tolerations.tolerationSeconds
    
    целочисленный
  - settings.tolerations.value
    
    строка

Модуль loki: настройки

Пример конфигурации

Требования

Параметры

Произошла ошибка

Расскажите, что не понравилось

Модуль loki: настройки

Пример конфигурации

Требования

Параметры

Произошла ошибка

Расскажите, что не понравилось

Запросить пробный доступ

Запрос получен

Ошибка

Связаться со специалистом Deckhouse

Заявка отправлена

Возникла ошибка отправки формы

Запросить обучение

Запрос получен

Ошибка

Запросить демо

Запрос получен

Ошибка

Получите отчет о соответствии рекомендациям PCI SSC

Спасибо

Ошибка

Запросить подробности партнёрской программы

Запрос получен

Ошибка