Настройка Grafana Enterprise

Эта страница описывает специфичные для Grafana Enterprise параметры конфигурации, которые вы можете указать в .ini-файле конфигурации или с помощью переменных среды. Дополнительную информацию о доступных параметрах конфигурации см. в разделе Конфигурация.

[enterprise]

license_path

Путь в локальной файловой системе к файлу лицензии Grafana Enterprise. По умолчанию <paths.data>/license.jwt.

license_text

Когда установлено в текстовое представление (то есть содержимое файла лицензии) лицензии, Grafana вычислит и применит данную лицензию к экземпляру.

auto_refresh_license

Когда включено, Grafana будет отправлять лицензию и статистику использования эмитенту лицензии. Если лицензия была обновлена на стороне эмитента, чтобы быть действительной для другого количества пользователей или нового срока, ваш экземпляр Grafana будет автоматически обновлён новыми условиями. По умолчанию true.

license_validation_type

Когда установлено aws, Grafana будет проверять статус своей лицензии через Amazon Web Services (AWS) вместо Grafana Labs. Используйте эту настройку только если вы приобрели лицензию Enterprise в AWS Marketplace. По умолчанию пусто, что означает, что по умолчанию Grafana Enterprise будет проверять с помощью лицензии, выданной Grafana Labs. Подробности о лицензиях, выданных AWS, см. в разделе Активация лицензии Grafana Enterprise, приобретённой через AWS Marketplace.

[white_labeling]

app_title

Установите в название вашей компании, чтобы переопределить заголовок приложения.

login_logo

Установите полный URL, чтобы переопределить логотип входа.

login_background

Установите полное CSS-выражение background, чтобы переопределить фон входа. Пример:

menu_logo

Установите полный URL, чтобы переопределить логотип меню.

fav_icon

Установите полный URL, чтобы переопределить fav icon (значок, отображаемый на вкладке браузера).

apple_touch_icon

Установите полный URL, чтобы переопределить значок Apple/iOS.

hide_edition

Установите true, чтобы убрать отображение редакции Grafana в подвале.

footer_links

Перечислите здесь ID ссылок для использования. Grafana будет искать соответствующие конфигурации ссылок, ID ссылок должны быть разделены пробелами и не содержать пробельных символов.

[usage_insights.export]

Экспортируя логи использования, вы можете напрямую запрашивать их и создавать дашборды по информации, которая важна для вас больше всего, например ошибки дашбордов, наиболее активные организации или ваши топ-10 наиболее используемых запросов.

enabled

Включить функцию экспорта аналитики использования.

storage

Укажите тип хранилища. По умолчанию loki.

[usage_insights.export.storage.loki]

type

Задайте протокол связи для использования с Loki, который является либо grpc, либо http. По умолчанию grpc.

url

Задайте адрес для записи логов в Loki (формат должен быть host:port).

tls

Решите, включать ли протокол TLS (Transport Layer Security) при установлении соединения с Loki. По умолчанию true.

tenant_id

Задайте ID тенанта для связи с Loki, который отключён по умолчанию. ID тенанта требуется для взаимодействия с Loki, работающим в режиме с несколькими тенантами.

batch_wait_duration

Как долго ждать перед отправкой запроса в Loki с партией событий. Использует формат длительности: например 5s, 1m. По умолчанию 5s.

То, что произойдёт первым между batch_wait_duration и batch_size_bytes, запустит отправку партии в Loki.

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

batch_size_bytes

Сколько событий (в байтах) накапливать в одной партии перед отправкой её в Loki. По умолчанию 100 KiB.

То, что произойдёт первым между batch_wait_duration и batch_size_bytes, запустит отправку партии в Loki.

Если вы хотите всегда ждать batch_wait_duration, установите это в очень большое число.

[analytics.summaries]

buffer_write_interval

Интервал для записи буфера статистики использования дашбордов в базу данных.

buffer_write_timeout

Тайм-аут для записи буфера статистики использования дашбордов в базу данных.

rollup_interval

Интервал для попытки сводки статистики использования по дашбордам. Сводится не более одного раза в день.

rollup_timeout

Тайм-аут для попытки сводки статистики использования по дашбордам.

[analytics.views]

recent_users_age

Возраст для недавних активных пользователей.

[reporting]

enabled

Включить или отключить функцию отчётности. Когда отключено, отчёты не создаются, а интерфейс скрыт. По умолчанию отчётность включена (true).

rendering_timeout

Тайм-аут для следующих запросов рендеринга отчётности: создание PDF-файлов, создание встроенных изображений дашбордов для писем с отчётами и создание прикреплённых CSV-файлов. По умолчанию 10 секунд (10s).

concurrent_render_limit

Максимальное количество одновременных вызовов службы рендеринга. По умолчанию 4.

image_scale_factor

Коэффициент масштаба для рендеринга изображений. Значение 2 достаточно для разрешений мониторов, 4 будет лучше для печатного материала. Установка более высокого значения влияет на производительность и память. По умолчанию 2.

max_attachment_size_mb

Задаёт максимальный размер файла в мегабайтах для вложений писем с отчётами. По умолчанию 10.

fonts_path

Путь к каталогу, содержащему файлы шрифтов.

font_regular

Имя файла шрифта TrueType с обычным стилем. По умолчанию DejaVuSansCondensed.ttf.

font_bold

Имя файла шрифта TrueType с полужирным стилем.

font_italic

Имя файла шрифта TrueType с курсивным стилем. По умолчанию DejaVuSansCondensed-Oblique.ttf.

font_min_text_size

Минимальный размер в пикселях, который Grafana использует при рендеринге шрифтов. По умолчанию 4.

max_request_retries

Максимальное количество раз, которое следующие запросы рендеринга отчётности повторяются перед возвратом ошибки: создание PDF-файлов, создание встроенных изображений дашбордов для писем с отчётами и создание прикреплённых CSV-файлов. По умолчанию 0, что означает, что это отключено.

allowed_domains

Разрешённые домены для получения отчётов. Используйте звёздочку (*), чтобы разрешить все домены. Используйте список, разделённый запятыми, чтобы разрешить несколько доменов. Пример: allowed_domains = grafana.com, example.org. По умолчанию *.

[auditing]

Аудит позволяет вам отслеживать важные изменения в вашем экземпляре Grafana. По умолчанию логи аудита записываются в файл, но функция аудита также поддерживает отправку логов непосредственно в Loki.

enabled

Включить функцию аудита. По умолчанию false.

loggers

Список включённых логгеров.

log_dashboard_content

Хранить содержимое дашборда в логах (поля запроса или ответа). Это может значительно увеличить размер ваших логов.

log_datasource_query_request_body

Записывать ли тело запроса запросов к источникам данных. Это может значительно увеличить размер ваших логов. Отключено по умолчанию.

log_datasource_query_response_body

Записывать ли тело ответа запросов к источникам данных. Это может значительно увеличить размер ваших логов. Отключено по умолчанию.

verbose

Логировать все запросы и хранить тело запросов и ответов. Это может значительно увеличить размер ваших логов.

log_all_status_codes

Установите false, чтобы логировать только запросы с ответами 2xx, 3xx, 401, 403, 500.

max_response_size_bytes

Максимальный размер тела ответа (в байтах) для записи. Может помочь снизить потребление памяти, вызванное аудитом.

snapshot_timeout

Grafana использует snapshot_timeout как кооперативный крайний срок при разрешении имён ресурсов перед обслуживанием запроса, который может удалить ресурсы. В настоящее время Grafana использует эту настройку для DELETE /api/admin/users/{id}. Поскольку хранилище должно учитывать отмену контекста, значение не является строгим верхним пределом задержки запроса. Используйте длительность, например 500ms или 2s. Если вы настроите нулевую или отрицательную длительность, Grafana записывает предупреждение и использует значение по умолчанию 500ms.

[auditing.logs.file]

path

Путь к папке логов.

max_files

Максимальное количество файлов логов для хранения.

max_file_size_mb

Максимальный размер в мегабайтах на файл лога.

[auditing.logs.loki]

url

Задайте URL для записи логов в Loki.

tls

Если true, устанавливает защищённое соединение с Loki. По умолчанию true.

tenant_id

Задайте ID тенанта для связи с Loki, который отключён по умолчанию. ID тенанта требуется для взаимодействия с Loki, работающим в режиме с несколькими тенантами.

retries

Количество раз, которое клиент HTTP или gRPC повторит неудачный запрос к Loki. По умолчанию 10.

timeout

Длительность тайм-аута HTTP-запроса или вызова gRPC к Loki. По умолчанию 3s.

batch_wait_duration

Доступно только для клиента HTTP. Отключено по умолчанию. Как долго ждать перед отправкой запроса в Loki с партией событий. Использует формат длительности: например 5s, 1m Порог, который будет достигнут первым между batch_wait_duration и batch_size_bytes, запустит отправку партии в Loki. Если длительность ожидания очень большая и batch_size_bytes очень высокий, события могут отправляться очень долго. Чтобы включить пакетную обработку, вы также должны задать параметр конфигурации batch_size_bytes.

batch_size_bytes

Доступно только для клиента HTTP. Отключено по умолчанию. Сколько событий, в байтах, накапливать в одной партии перед отправкой её в Loki. Порог, который будет достигнут первым между batch_wait_duration и batch_size_bytes, запустит отправку партии в Loki. Если вы хотите всегда ждать batch_wait_duration, установите batch_size_bytes в очень большое число. Чтобы включить пакетную обработку, вы также должны задать параметр конфигурации batch_wait_duration.

[auth.saml]

enabled

Если true, функция включена. По умолчанию false.

allow_sign_up

Если true, позволяет создавать новых пользователей Grafana через входы SAML. По умолчанию true.

certificate

Публичный сертификат X.509 в кодировке Base64. Используется для подписи запросов к IdP.

certificate_path

Путь к публичному сертификату X.509. Используется для подписи запросов к IdP.

private_key

Приватный ключ в кодировке Base64. Используется для расшифровки утверждений от IdP.

private_key_path

Путь к приватному ключу. Используется для расшифровки утверждений от IdP.

idp_metadata

XML-метаданные IdP SAML в кодировке Base64. Используются для проверки и получения мест привязки от IdP.

idp_metadata_path

Путь к XML-метаданным SAML. Используется для проверки и получения мест привязки от IdP.

idp_metadata_url

URL для получения метаданных SAML IdP. Используется для проверки и получения мест привязки от IdP.

max_issue_delay

Время с момента, когда IdP выдал ответ, и до того, как SP разрешено его обработать. По умолчанию 90 секунд.

metadata_valid_duration

Как долго метаданные SP действительны. По умолчанию 48 часов.

assertion_attribute_name

Понятное имя (friendly name) или имя атрибута внутри утверждения SAML, используемого как имя пользователя. В качестве альтернативы это может быть шаблон с переменными, соответствующими именам атрибутов внутри утверждения SAML.

assertion_attribute_login

Понятное имя или имя атрибута внутри утверждения SAML, используемого как логин пользователя. По умолчанию login.

assertion_attribute_email

Понятное имя или имя атрибута внутри утверждения SAML, используемого как адрес электронной почты пользователя. По умолчанию email.

assertion_attribute_groups

Понятное имя или имя атрибута внутри утверждения SAML, используемого как группы пользователя.

assertion_attribute_role

Понятное имя или имя атрибута внутри утверждения SAML, используемого как роли пользователя.

assertion_attribute_org

Понятное имя или имя атрибута внутри утверждения SAML, используемого как организация пользователя.

assertion_attribute_external_uid

Понятное имя или имя атрибута внутри утверждения SAML, используемого как внешний UID пользователя. По умолчанию userUID.

allowed_organizations

Список организаций, разделённых запятыми или пробелами. Каждый пользователь должен быть членом как минимум одной организации, чтобы войти.

org_mapping

Список сопоставлений Organization:OrgId:Role, разделённых запятыми или пробелами. Organization может быть *, что означает “Все пользователи”. Роль необязательна и может иметь следующие значения: Admin, Editor ,Viewer или None.

role_values_none

Список ролей, разделённых запятыми или пробелами, которые будут сопоставлены с ролью None.

role_values_viewer

Список ролей, разделённых запятыми или пробелами, которые будут сопоставлены с ролью Viewer.

role_values_editor

Список ролей, разделённых запятыми или пробелами, которые будут сопоставлены с ролью Editor.

role_values_admin

Список ролей, разделённых запятыми или пробелами, которые будут сопоставлены с ролью Admin.

role_values_grafana_admin

Список ролей, разделённых запятыми или пробелами, которые будут сопоставлены с ролью Grafana Admin (Super Admin).

[keystore.vault]

url

Расположение сервера Vault.

namespace

Пространство имён Vault, если используется Vault с мультитенантностью.

auth_method

Метод аутентификации в Vault. Vault неактивен, если этот параметр не задан. Текущие возможные значения: token.

token

Секретный токен для подключения к Vault, когда auth_method — token.

lease_renewal_interval

Время между проверками, есть ли секреты, которые нужно продлить.

lease_renewal_expires_within

Время до истечения для токенов, которые продлеваются. Должно иметь значение выше, чем lease_renewal_interval.

lease_renewal_increment

Новая длительность для продлённых токенов. Vault может быть настроен на игнорирование этого значения и наложение более строгого лимита.

[security.egress]

Безопасность исходящего трафика (security egress) позволяет контролировать исходящий трафик от сервера Grafana.

host_deny_list

Список имён хостов или IP-адресов, разделённых пробелами, для которых запросы блокируются.

host_allow_list

Список имён хостов или IP-адресов, разделённых пробелами, для которых запросы разрешены. Все остальные запросы блокируются.

header_drop_list

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

cookie_drop_list

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

[security.encryption]

algorithm

Алгоритм шифрования, используемый для шифрования секретов, хранящихся в базе данных и cookie. Возможные значения: aes-cfb (по умолчанию) и aes-gcm. AES-CFB означает Advanced Encryption Standard в режиме cipher feedback, а AES-GCM означает Advanced Encryption Standard в режиме Galois/Counter Mode.

[caching]

Когда кэширование запросов включено, Grafana может временно хранить результаты запросов к источникам данных и отдавать кэшированные ответы на похожие запросы.

backend

Серверная часть кэширования, используемая при хранении кэшированных запросов. Варианты: memory, redis и memcached.

По умолчанию memory.

enabled

Установка ’enabled’ в true позволяет пользователям настраивать кэширование запросов для источников данных.

Это значение true по умолчанию.

ttl

Time to live (TTL) — это время, в течение которого результат запроса хранится в системе кэширования до его удаления или обновления. Эта настройка определяет время жизни для кэширования запросов, когда TTL не настроен в параметрах источника данных. Значение по умолчанию — 1m (1 минута).

max_ttl

Максимальная длительность, в течение которой результат запроса хранится в системе кэширования до его удаления или обновления. Это значение переопределит параметр конфигурации ttl или настройку источника данных, если значение ttl больше max_ttl. Чтобы отключить это ограничение, установите это значение в 0s.

По умолчанию 0s (отключено).

max_value_mb

Это значение ограничивает размер одного значения кэша. Если значение кэша (или результат запроса) превышает этот размер, то оно не кэшируется. Чтобы отключить этот лимит, установите это значение в 0.

По умолчанию 1.

connection_timeout

Эта настройка определяет длительность ожидания соединения с серверной частью кэширования.

По умолчанию 5s.

read_timeout

Эта настройка определяет длительность ожидания возврата кэшированного результата серверной частью кэширования. Чтобы отключить этот тайм-аут, установите это значение в 0s.

По умолчанию 0s (отключено).

write_timeout

Эта настройка определяет количество секунд ожидания сохранения результата серверной частью кэширования. Чтобы отключить этот тайм-аут, установите это значение в 0s.

По умолчанию 0s (отключено).

[caching.encryption]

enabled

Когда ’enabled’ — true, значения запросов в кэше шифруются.

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

encryption_key

Строка, используемая для генерации ключа для шифрования кэша. Чтобы зашифрованные данные кэша сохранялись между перезапусками Grafana, вы должны указать этот ключ. Если он пуст, когда шифрование включено, то ключ автоматически генерируется при запуске, и кэш очищается при перезапусках.

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

[caching.memory]

gc_interval

При хранении данных кэша в памяти эта настройка определяет, как часто фоновый процесс очищает устаревшие данные из кэша в памяти. Более частое “сборка мусора” может предотвратить рост потребления памяти, но увеличит использование ЦП.

По умолчанию 1m.

max_size_mb

Максимальный размер кэша в памяти в мегабайтах. Как только этот размер достигнут, новые элементы кэша отклоняются. Для более гибкого контроля политик вытеснения и размера кэша используйте серверную часть Redis или Memcached.

Чтобы отключить максимум, установите это значение в 0.

По умолчанию 25.

[caching.redis]

url

Полный URL Redis вашего сервера Redis. Например: redis://username:password@localhost:6379. Чтобы включить TLS, используйте схему rediss.

По умолчанию "redis://localhost:6379".

cluster

Список узлов кластера Redis, разделённых запятыми, либо в формате host:port, либо с использованием полных URL Redis (redis://username:password@localhost:6379). Например, localhost:7000, localhost: 7001, localhost:7002. Если вы используете полные URL Redis, то можете указать схему, имя пользователя и пароль только один раз. Например, redis://username:password@localhost:0000,localhost:1111,localhost:2222. Вы не можете указать разные имя пользователя и пароль для каждого URL.

prefix

Строка, которая ставится префиксом ко всем ключам Redis. Это значение должно быть задано при использовании общей базы данных в Redis. Если prefix пуст, то он не будет использоваться.

По умолчанию "grafana".

[caching.memcached]

servers

Список серверов memcached, разделённых пробелами. Пример: memcached-server-1:11211 memcached-server-2:11212 memcached-server-3:11211. Или если есть только один сервер: memcached-server:11211.

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

tls_enabled

Включает аутентификацию TLS для memcached. По умолчанию false.

tls_cert_path

Путь к клиентскому сертификату, который будет использоваться для аутентификации на сервере. Также требует настройки пути к ключу.

tls_key_path

Путь к ключу для клиентского сертификата. Также требует настройки клиентского сертификата.

tls_ca_path

Путь к сертификатам CA для проверки сертификата сервера. Если не задан, используются корневые сертификаты CA хоста.

tls_server_name

Переопределить ожидаемое имя в сертификате сервера.

connection_timeout

Тайм-аут для клиента memcached на подключение к memcached. По умолчанию 0, что использует тайм-аут клиента memcached по умолчанию для схемы соединения.

[recorded_queries]

enabled

Включена ли функция записанных запросов

min_interval

Задаёт минимальный интервал, применяемый между вычислениями запросов. Значение по умолчанию — 10s. Вычисление запроса будет скорректировано, если они меньше этого значения. Более высокие значения могут помочь с управлением ресурсами.

Строка интервала — это, возможно, знаковая последовательность десятичных чисел, за которой следует суффикс единицы (ms, s, m, h, d), например 30s или 1m.

max_queries

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

default_remote_write_datasource_uid

UID источника данных, куда будут записаны данные запроса.

Если заданы все свойства default_remote_write_*, эта информация будет заполнена при запуске. Если цель удалённой записи уже была настроена, ничего не произойдёт.

default_remote_write_path

Путь API, куда будут записаны метрики

Если заданы все свойства default_remote_write_*, эта информация будет заполнена при запуске. Если цель удалённой записи уже была настроена, ничего не произойдёт.

default_remote_write_datasource_org_id

ID организации источника данных, куда будут записаны данные запроса.

Если заданы все свойства default_remote_write_*, эта информация будет заполнена при запуске. Если цель удалённой записи уже была настроена, ничего не произойдёт.