Документацияbreadcrumb arrow Grafanabreadcrumb arrow Документация GlaberGraphbreadcrumb arrow Настройкаbreadcrumb arrow Настройка Grafana

Настройка Grafana

Grafana имеет файлы конфигурации по умолчанию и пользовательские файлы конфигурации.

Настройка вашего экземпляра Grafana

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

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

Note

Базовый провижининг конфигурации см. в разделе Провижининг Grafana.

Расположение файла конфигурации

Настройки по умолчанию для экземпляра Grafana хранятся в файле <WORKING DIRECTORY>/conf/defaults.ini. Не изменяйте этот файл.

В зависимости от вашей ОС ваш пользовательский файл конфигурации — это либо файл <WORKING DIRECTORY>/conf/custom.ini, либо файл /usr/local/etc/grafana/grafana.ini. Вы можете использовать пользовательский путь конфигурации с параметром --config.

Linux

Если вы установили Grafana с помощью пакетов deb или RPM, то ваш файл конфигурации расположен по пути /etc/grafana/grafana.ini и отдельный custom.ini не используется. Этот путь задаётся в скрипте init.d Grafana с помощью параметра --config.

Docker

См. Настройка Docker-образа Grafana для получения информации о переменных среды, постоянном хранилище и сборке пользовательских Docker-образов.

Windows

В Windows файл sample.ini расположен в том же каталоге, что и файл defaults.ini. Он содержит все настройки закомментированными. Скопируйте sample.ini и назовите его custom.ini.

macOS

По умолчанию файл конфигурации расположен по пути /opt/homebrew/etc/grafana/grafana.ini или /usr/local/etc/grafana/grafana.ini. Для экземпляра Grafana, установленного с помощью Homebrew, редактируйте файл grafana.ini напрямую. В противном случае добавьте файл конфигурации с именем custom.ini в каталог conf, чтобы переопределить настройки, определённые в conf/defaults.ini.

Grafana Cloud

Для стеков Grafana Cloud нет локального файла конфигурации, но многие из этих настроек всё ещё можно настроить. Чтобы изменить настраиваемые настройки, откройте обращение в службу поддержки.

Удаление комментариев в .ini-файлах

Grafana использует точки с запятой (;) для комментирования строк в INI-файле. Чтобы раскомментировать строку, удалите точку с запятой (;) из начала этой строки.

Grafana игнорирует все строки конфигурации, которые начинаются с точки с запятой.

Например:

ini 
;http_port = 3000

Переопределение конфигурации с помощью переменных среды

Не используйте переменные среды для добавления новых настроек конфигурации. Вместо этого используйте переменные среды для переопределения существующих параметров.

Чтобы переопределить параметр:

Bash 
GF_<SECTION NAME>_<KEY>

Где <SECTION NAME> — это текст в квадратных скобках ([ и ]) в файле конфигурации. Все буквы должны быть заглавными, точки (.) и дефисы (-) должны быть заменены на подчёркивания (_). Например, если у вас есть следующие настройки конфигурации:

ini 
# default section
instance_name = ${HOSTNAME}

[security]
admin_user = admin

[auth.google]
client_secret = 0ldS3cretKey

[plugin.grafana-image-renderer]
rendering_ignore_https_errors = true

[feature_toggles]
newNavigation = true

Вы можете переопределить переменные на машинах Linux с помощью:

Bash 
export GF_DEFAULT_INSTANCE_NAME=my-instance
export GF_SECURITY_ADMIN_USER=owner
export GF_AUTH_GOOGLE_CLIENT_SECRET=newS3cretKey
export GF_PLUGIN_GRAFANA_IMAGE_RENDERER_RENDERING_IGNORE_HTTPS_ERRORS=true
export GF_FEATURE_TOGGLES_newNavigation=true

Расширение переменных

Если любой из ваших параметров содержит выражение $__<PROVIDER>{<ARGUMENT>}или ${<ENVIRONMENT VARIABLE>}, то Grafana вычисляет их. Вычисление запускает провайдера с предоставленным аргументом, чтобы получить итоговое значение параметра.

Есть три провайдера: env, file и vault.

Провайдер env

Провайдер env разворачивает переменные среды. Если вы установите параметр в $__env{PORT}, его заменит значение переменной среды PORT. Для переменных среды вы также можете использовать сокращённый синтаксис ${PORT}.

Следующий пример устанавливает каталог логов в путь из переменной среды LOGDIR:

ini 
[paths]
logs = $__env{LOGDIR}/grafana

Провайдер file

Провайдер file читает файл из файловой системы. Он обрезает пробелы в начале и в конце файлов.

Следующий пример устанавливает пароль базы данных в содержимое файла /etc/secrets/gf_sql_password:

ini 
[database]
password = $__file{/etc/secrets/gf_sql_password}

Провайдер vault

Провайдер vault позволяет управлять вашими секретами с помощью Hashicorp Vault.

Note

Провайдер vault доступен только в Grafana Enterprise.

Дополнительную информацию см. в разделе Интеграция Grafana с Hashicorp Vault.

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

Следующие заголовки описывают разделы и параметры конфигурации файла конфигурации Grafana.

app_mode

Варианты: production и development. По умолчанию production. Не изменяйте этот параметр, если вы не работаете над разработкой Grafana.

instance_name

Задаёт имя экземпляра сервера Grafana. Используется в логировании, внутренних метриках и информации о кластеризации. По умолчанию: ${HOSTNAME}, что использует значение переменной среды HOSTNAME; если она пуста или не существует, Grafana пытается использовать системные вызовы для получения имени машины.

[paths]

data

Путь, где Grafana хранит базу данных sqlite3 (если используется), сессии на основе файлов (если используются) и другие данные. Этот путь обычно задаётся через командную строку в скрипте init.d или в файле службы systemd.

macOS: База данных SQLite по умолчанию расположена по пути /usr/local/var/lib/grafana

temp_data_lifetime

Как долго должны храниться временные изображения в каталоге data. По умолчанию: 24h. Поддерживаемые модификаторы: h (часы), m (минуты), например: 168h, 30m, 10h30m. Используйте 0, чтобы никогда не очищать временные файлы.

logs

Путь, где Grafana хранит логи. Этот путь обычно задаётся через командную строку в скрипте init.d или в файле службы systemd. Вы можете переопределить его в файле конфигурации или в файле переменных среды по умолчанию.

Note

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

Переопределите путь логов с помощью аргумента командной строки cfg:default.paths.logs:

Bash 
./grafana-server --config /custom/config.ini --homepath /custom/homepath cfg:default.paths.logs=/custom/path

macOS: По умолчанию файл лога должен располагаться по пути /usr/local/var/log/grafana/grafana.log.

plugins

Каталог, где Grafana автоматически сканирует и ищет плагины. Информацию о ручной или автоматической установке плагинов см. в разделе Установка плагинов Grafana.

macOS: По умолчанию расположение плагинов Mac: /usr/local/var/lib/grafana/plugins.

provisioning

Каталог, который содержит файлы конфигурации провижининга, применяемые Grafana при запуске. Дашборды перезагружаются при изменении JSON-файлов.

[server]

protocol

http,https,h2,socket или socket_h2

min_tls_version

Рукопожатие TLS требует минимальной версии TLS. Доступные варианты: TLS1.2 и TLS1.3. Если вы не указали версию, система использует TLS1.2.

http_addr

Хост, на котором сервер будет слушать. Если у вашей машины более одного сетевого интерфейса, вы можете использовать эту настройку, чтобы предоставлять службу Grafana только на одном сетевом интерфейсе, а не делать её доступной на других, например на интерфейсе обратной петли. Пустое значение эквивалентно установке значения 0.0.0.0, что означает привязку службы Grafana ко всем интерфейсам.

В средах, где используется преобразование сетевых адресов (NAT), убедитесь, что вы используете адрес сетевого интерфейса, а не конечный публичный адрес; в противном случае вы можете увидеть в логах ошибки вида bind: cannot assign requested address.

http_port

Порт для привязки, по умолчанию 3000. Чтобы использовать порт 80, вам нужно либо дать бинарному файлу Grafana разрешение, например:

Bash 
sudo setcap 'cap_net_bind_service=+ep' /usr/sbin/grafana-server

Либо перенаправить порт 80 на порт Grafana с помощью:

Bash 
sudo iptables -t nat -A PREROUTING -p tcp --dport 80 -j REDIRECT --to-port 3000

Другой способ — поставить перед Grafana веб-сервер, такой как Nginx или Apache, и проксировать запросы к Grafana через них.

domain

Эта настройка используется только как часть настройки root_url (см. ниже). Важна, если вы используете OAuth GitHub или Google.

enforce_domain

Перенаправлять на правильный домен, если заголовок host не совпадает с доменом. Предотвращает атаки DNS rebinding. По умолчанию false.

root_url

Это полный URL, используемый для доступа к Grafana из веб-браузера. Это важно, если вы используете аутентификацию Google или GitHub OAuth (чтобы callback URL был корректным).

Note

Эта настройка также важна, если у вас есть обратный прокси перед Grafana, который предоставляет её через подпуть.

В этом случае добавьте подпуть в конец этой настройки URL.

serve_from_sub_path

Обслуживать Grafana из подпути, указанного в настройке root_url. По умолчанию установлено false по причинам совместимости.

Включив эту настройку и используя подпуть в root_url, например root_url = http://localhost:3000/grafana, Grafana становится доступной по адресу http://localhost:3000/grafana. Если к ней обратиться без подпути, Grafana перенаправляет запрос на подпуть.

router_logging

Установите true, чтобы Grafana логировала все HTTP-запросы (не только ошибки). Они логируются как события уровня Info в логе Grafana.

static_root_path

Путь к каталогу, где находятся файлы фронтенда (HTML, JS и CSS файлы). По умолчанию public, поэтому бинарный файл Grafana нужно запускать с рабочим каталогом, установленным в путь установки.

enable_gzip

Установите этот параметр в true, чтобы включить сжатие HTTP, это может улучшить скорость передачи и использование пропускной способности. Большинству пользователей рекомендуется оставить его в значении по умолчанию true, однако сжатие может увеличить использование ЦП в ограниченных средах или вызвать проблемы с плохо настроенными обратными прокси.

cert_file

Путь к файлу сертификата (если protocol установлен в https или h2).

cert_key

Путь к файлу ключа сертификата (если protocol установлен в https или h2).

cert_pass

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

certs_watch_interval

Управляет тем, отслеживаются ли cert_key и cert_file периодически на предмет изменений. Отключено по умолчанию. Когда включено, cert_key и cert_file отслеживаются на предмет изменений. Если есть изменение, новые сертификаты загружаются автоматически.

Warning

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

socket_gid

GID сокета, когда protocol=socket. Убедитесь, что пользователь, запускающий процесс Grafana, является участником целевой группы и является владельцем файла, прежде чем изменять эту настройку. Рекомендуется установить GID как GID пользователя HTTP-сервера. Не задано, когда значение -1.

socket_mode

Режим, в котором должен быть установлен сокет, когда protocol=socket. Убедитесь, что процесс Grafana является владельцем файла, прежде чем изменять эту настройку.

socket

Путь, где должен быть создан сокет, когда protocol=socket. Убедитесь, что у Grafana есть соответствующие разрешения для этого пути, прежде чем изменять эту настройку.

serve_on_socket

Если установлено true и основной protocol — http, https или h2, Grafana дополнительно будет обслуживать на Unix domain socket, настроенном через socket. По умолчанию false.

cdn_url

Укажите полный HTTP-адрес URL к корню ваших CDN-ресурсов Grafana. Grafana добавляет пути редакции и версии.

Например, при CDN URL вида https://cdn.myserver.com Grafana пытается загрузить JavaScript-файл из http://cdn.myserver.com/grafana-oss/7.4.0/public/build/app.<HASH>.js.

read_timeout

Задаёт максимальное время с использованием формата длительности (5s/5m/5ms) до истечения тайм-аута чтения входящего запроса и закрытия неактивных соединений. 0 означает отсутствие тайм-аута для чтения запроса.

[server.custom_response_headers]

Эта настройка позволяет указать дополнительные заголовки, которые сервер добавляет к ответам HTTP(S).

exampleHeader1 = exampleValue1
exampleHeader2 = exampleValue2

[database]

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

Caution

SQLite не рекомендуется для производственных сред; используйте MySQL или PostgreSQL для производственных развёртываний.

type

Либо mysql, либо postgres, либо sqlite3, на ваш выбор.

host

Применимо только к MySQL или Postgres. Включает IP или имя хоста и порт, а в случае Unix-сокетов — путь к нему. Например, для MySQL, работающего на том же хосте, что и Grafana: host = 127.0.0.1:3306 или с Unix-сокетами: host = /var/run/mysqld/mysqld.sock

name

Имя базы данных Grafana. Оставьте его установленным в grafana или какое-либо другое имя.

user

Пользователь базы данных (неприменимо для sqlite3).

password

Пароль пользователя базы данных (неприменимо для sqlite3). Если пароль содержит # или ;, вы должны обернуть его в тройные кавычки. Например """#password;"""

url

Используйте либо URL, либо предыдущие поля для настройки базы данных Пример: type://user:password@host:port/name

max_idle_conn

Максимальное количество соединений в пуле неактивных соединений.

max_open_conn

Максимальное количество открытых соединений с базой данных. Для MYSQL настройте эту настройку как в Grafana, так и в базе данных. Дополнительную информацию см. в разделе sysvar_max_connections.

conn_max_lifetime

Задаёт максимальное время, в течение которого соединение может быть переиспользовано. По умолчанию 14400 (что означает 14400 секунд или 4 часа). Для MySQL эта настройка должна быть меньше переменной wait_timeout.

migration_locking

Установите false, чтобы отключить блокировку базы данных во время миграций. По умолчанию true.

locking_attempt_timeout_sec

Только для mysql и postgres. Укажите время в секундах для ожидания перед неудачей блокировки базы данных для миграций. По умолчанию 0.

log_queries

Установите true, чтобы логировать вызовы SQL и время их выполнения.

ssl_mode

Для Postgres используйте любой допустимый sslmode libpq, например disable, require, verify-full и т. д. Для MySQL используйте либо true, либо false, либо skip-verify.

ssl_sni

Для Postgres установите 0, чтобы отключить Server Name Indication. По умолчанию это включено для соединений с включённым SSL.

isolation_level

Только драйвер MySQL поддерживает уровни изоляции в Grafana. Если значение пусто, применяется уровень изоляции драйвера по умолчанию. Доступные варианты: “READ-UNCOMMITTED”, “READ-COMMITTED”, “REPEATABLE-READ” или “SERIALIZABLE”.

ca_cert_path

Путь к используемому сертификату CA. Во многих системах Linux сертификаты можно найти в /etc/ssl/certs.

client_key_path

Путь к клиентскому ключу. Только если сервер требует аутентификации клиента.

client_cert_path

Путь к клиентскому сертификату. Только если сервер требует аутентификации клиента.

server_cert_name

Поле common name сертификата, используемого сервером mysql или postgres. Не требуется, если ssl_mode установлен в skip-verify.

path

Применимо только для базы данных sqlite3. Путь к файлу базы данных.

cache_mode

Только для “sqlite3”. Настройка общего кэша, используемая для подключения к базе данных. (private, shared) По умолчанию private.

wal

Только для “sqlite3”. Настройка для включения/отключения Write-Ahead Logging. Значение по умолчанию — false (отключено).

SQLite хранит режим журнала в файле базы данных, поэтому база данных, открытая с WAL, продолжает его использовать. Установка wal обратно в false переводит базу данных в режим журнала DELETE при следующем запуске.

query_retries

Эта настройка применяется только к sqlite и управляет числом повторных попыток выполнения запроса, когда база данных заблокирована. Значение по умолчанию — 0 (отключено).

transaction_retries

Эта настройка применяется только к sqlite и управляет числом повторных попыток выполнения транзакции, когда база данных заблокирована. Значение по умолчанию — 5.

instrument_queries

Установите true, чтобы добавить метрики и трассировку для запросов к базе данных. Значение по умолчанию — false.

[remote_cache]

Кэширует токены аутентификации и другие временные данные, связанные с аутентификацией, в настроенной базе данных, Redis или Memcached. Эта настройка не настраивает кэширование запросов в Grafana Enterprise.

Note

Эта настройка не управляет хранением сессий пользователей. Сессии пользователей всегда хранятся в основной базе данных, настроенной в [database], независимо от ваших настроек [remote_cache].

type

Либо redis, либо memcached, либо database. По умолчанию database

connstr

Строка подключения удалённого кэша. Формат зависит от type удалённого кэша. Варианты: database, redis и memcache.

database

Оставьте пустым при использовании database, и Grafana использует основную базу данных.

redis

Пример строки подключения: network=tcp,addr=127.0.0.1:6379,pool_size=100,db=0,username=grafana,password=grafanaRocks,ssl=false

  • network (необязательно) может быть tcp или unix.
  • addr — это хост : порт сервера Redis.
  • pool_size (необязательно) — это число базовых соединений, которые могут быть установлены с Redis.
  • db (необязательно) — это числовой идентификатор базы данных Redis, которую вы хотите использовать.
  • username (необязательно) — это идентификатор соединения для аутентификации текущего соединения.
  • password (необязательно) — это секрет соединения для аутентификации текущего соединения.
  • ssl (необязательно) — использовать ли SSL для подключения к серверу Redis. Значением может быть true, false или insecure. Установка значения insecure пропускает проверку цепочки сертификатов и имени хоста при установлении соединения.
memcache

Пример строки подключения: 127.0.0.1:11211

[dataproxy]

logging

Это включает логирование прокси данных, по умолчанию false.

timeout

Как долго прокси данных должен ждать до истечения тайм-аута. По умолчанию 30 секунд.

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

keep_alive_seconds

Интервал между проверками keep-alive. По умолчанию 30 секунд. Дополнительные сведения см. в документации Dialer.KeepAlive.

tls_handshake_timeout_seconds

Продолжительность времени, в течение которого Grafana ожидает успешного рукопожатия TLS с источником данных. По умолчанию 10 секунд. Дополнительную информацию см. в документации Transport.TLSHandshakeTimeout.

expect_continue_timeout_seconds

Продолжительность времени, в течение которого Grafana ожидает первые заголовки ответа от источника данных после полной записи заголовков запроса, если запрос имеет заголовок Expect: 100-continue. Значение 0 приводит к немедленной отправке тела. По умолчанию 1 секунда. Дополнительную информацию см. в документации Transport.ExpectContinueTimeout.

max_conns_per_host

Ограничивает общее количество соединений на хост, включая соединения в состояниях дозвона, активном и неактивном. При нарушении лимита дозвоны блокируются. Значение 0 означает отсутствие ограничений. По умолчанию 0. Дополнительную информацию см. в документации Transport.MaxConnsPerHost.

max_idle_connections

Максимальное количество неактивных соединений, которые поддерживает Grafana. По умолчанию 100. Дополнительную информацию см. в документации Transport.MaxIdleConns.

idle_conn_timeout_seconds

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

send_user_header

Если включено и пользователь не анонимный, прокси данных добавляет в запрос заголовок X-Grafana-User с именем пользователя. По умолчанию false.

response_limit

Ограничивает количество байтов, которые Grafana читает из ответов на исходящие HTTP-запросы. По умолчанию 0, что означает отключено.

row_limit

Ограничивает количество строк, которые Grafana обрабатывает из источников данных SQL. По умолчанию 1000000.

user_agent

Задаёт пользовательское значение для заголовка User-Agent для исходящих запросов прокси данных. Если пусто, значение по умолчанию — Grafana/<BuildVersion> (например Grafana/13.0.0).

forward_user_agent

Если включено, прокси данных сохраняет исходный заголовок User-Agent клиента, добавляя его к User-Agent прокси. Полезно для отслеживания исходного клиента (браузер, CLI, AI-агент и т. д.) в вышестоящих источниках данных. По умолчанию false.

Например, с включённой этой настройкой запрос от клиента с User-Agent: my-client/1.4 пересылается с User-Agent: Grafana/13.0.0 my-client/1.4.

[analytics]

enabled

Этот параметр также известен как аналитика использования. Когда false, этот параметр отключает средства записи, которые пишут в базу данных Grafana, и связанные функции, такие как аналитика дашбордов и источников данных, индикаторы присутствия и расширенный поиск по дашбордам. Значение по умолчанию — true.

reporting_enabled

Когда включено, Grafana отправляет анонимную статистику использования на stats.grafana.org. Grafana не отслеживает IP-адреса, только счётчики работающих экземпляров, версий, дашбордов и ошибок.

Анонимная статистика использования помогает информировать будущую разработку Grafana. Счётчики отправляются каждые 24 часа. Значение по умолчанию — true.

check_for_updates

Установите false, чтобы отключить проверку новых версий Grafana в GitHub. Когда включено, проверка новой версии выполняется каждые десять минут. Она уведомляет через интерфейс, когда доступна новая версия. Сама проверка не вызывает автоматических обновлений программного обеспечения Grafana и не отправляет никакой конфиденциальной информации.

check_for_plugin_updates

Установите false, чтобы отключить проверку новых версий установленных плагинов с https://grafana.com. Когда включено, проверка нового плагина выполняется каждые десять минут. Она уведомляет через интерфейс, когда существует обновление плагина. Сама проверка не вызывает автоматических обновлений каких-либо плагинов и не отправляет никакой конфиденциальной информации.

google_analytics_ua_id

Если вы хотите отслеживать использование Grafana с помощью Google Analytics, укажите здесь ваш Universal Analytics ID. По умолчанию эта функция отключена.

google_analytics_4_id

Если вы хотите отслеживать использование Grafana с помощью Google Analytics 4, укажите здесь ваш GA4 ID. По умолчанию эта функция отключена.

google_tag_manager_id

Google Tag Manager ID, включается только если вы введёте здесь ID.

rudderstack_write_key

Если вы хотите отслеживать использование Grafana через RudderStack, укажите здесь ваш RudderStack Write Key. Также должен быть предоставлен rudderstack_data_plane_url, чтобы эта функция была включена. По умолчанию эта функция отключена.

rudderstack_data_plane_url

URL плоскости данных RudderStack для приёма событий RudderStack. Вы также должны предоставить rudderstack_write_key, чтобы включить эту функцию.

rudderstack_sdk_url

Необязательно. Если отслеживание с помощью RudderStack включено, вы можете предоставить пользовательский URL для загрузки SDK RudderStack.

rudderstack_v3_sdk_url

Необязательно. Это зеркалирует старый параметр конфигурации, который будет устаревшим. Если заданы и rudderstack_sdk_url, и rudderstack_v3_sdk_url, загружается SDK v3.

rudderstack_config_url

Необязательно. Если отслеживание с помощью RudderStack включено, вы можете предоставить пользовательский URL для загрузки конфигурации RudderStack.

rudderstack_integrations_url

Необязательно. Если отслеживание с помощью RudderStack включено, вы можете предоставить пользовательский URL для загрузки SDK для назначений, работающих в режиме устройства (device mode). Эта настройка действительна только для RudderStack версии 1.1 и выше.

application_insights_connection_string

Если вы хотите отслеживать использование Grafana через Azure Application Insights, укажите вашу строку подключения Application Insights. Поскольку строка подключения содержит точки с запятой, вам нужно обернуть её в обратные кавычки (`). По умолчанию отслеживание использования отключено.

application_insights_endpoint_url

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

application_insights_auto_route_tracking

При желании используйте это, чтобы настроить enableAutoRouteTracking в Azure Application Insights. По умолчанию true. Дополнительные сведения см. в документации Azure

posthog_token

Если вы хотите отслеживать использование Grafana через PostHog, укажите здесь ваш ключ API проекта PostHog. По умолчанию эта функция отключена.

posthog_host

Необязательный URL хоста экземпляра PostHog. По умолчанию https://us.i.posthog.com (PostHog US Cloud). Задайте это, если вы используете PostHog EU Cloud (https://eu.i.posthog.com) или самостоятельно размещённый экземпляр.

Установите false, чтобы удалить все ссылки обратной связи из интерфейса. По умолчанию true.

[security]

disable_initial_admin_creation

Отключить создание пользователя-администратора Grafana при первом запуске Grafana. По умолчанию false.

admin_user

Имя пользователя-администратора Grafana по умолчанию, который имеет полные разрешения. По умолчанию admin.

admin_password

Пароль администратора Grafana по умолчанию. Задаётся один раз при первом запуске. По умолчанию admin.

admin_email

Электронная почта администратора Grafana по умолчанию, создаваемого при запуске. По умолчанию admin@localhost.

secret_key

Используется для подписи некоторых настроек источников данных, таких как секреты и пароли, используемый формат шифрования — AES-256 в режиме CFB. Его нельзя изменить без необходимости обновления настроек источников данных для их перекодирования.

disable_gravatar

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

gravatar_url

Базовый URL, используемый для получения изображений профиля Gravatar. По умолчанию https://secure.gravatar.com/avatar.

data_source_proxy_whitelist

Определите список разрешённых IP-адресов или доменов с портами, которые могут использоваться в URL источников данных с прокси источников данных Grafana.

Формат — <IP> или <DOMAIN>:<PORT>, разделённые пробелами. Источники данных PostgreSQL, MySQL и MSSQL не используют прокси и не затрагиваются этой настройкой.

disable_brute_force_login_protection

Установите true, чтобы отключить защиту от подбора паролей. По умолчанию false. Вход блокируется на пять минут, если все попытки входа израсходованы в течение 5-минутного окна.

brute_force_login_protection_max_attempts

Настройте, сколько попыток входа можно сделать в течение пятиминутного окна до блокировки. По умолчанию 5.

disable_username_login_protection

Установите true, чтобы отключить защиту от подбора паролей по имени пользователя. По умолчанию false. Пользователь не сможет войти в течение 5 минут, если все попытки входа израсходованы в течение 5-минутного окна.

disable_ip_address_login_protection

Установите true, чтобы отключить защиту от подбора паролей по IP-адресу. По умолчанию true. Любой с этого IP-адреса не сможет войти в течение 5 минут, если все попытки входа израсходованы в течение 5-минутного окна.

Установите true, если вы размещаете Grafana за HTTPS. По умолчанию false.

Задаёт атрибут cookie SameSite и предотвращает отправку этого cookie браузером вместе с межсайтовыми запросами. Основная цель — снизить риск межсайтовой утечки информации. Эта настройка также обеспечивает некоторую защиту от атак межсайтовой подделки запросов (CSRF), подробнее о SameSite здесь. Допустимые значения: lax, strict, none и disabled. По умолчанию lax. Использование значения disabled не добавляет никакого атрибута SameSite к cookie.

Если вы хотите использовать OAuth/SAML для входа, необходимо настроить этот атрибут как lax.

allow_embedding

Когда false, в ответах HTTP Grafana устанавливается заголовок X-Frame-Options: deny, который указывает браузерам не разрешать отображение Grafana в <frame>, <iframe>, <embed> или <object>. Основная цель — снизить риск Clickjacking. По умолчанию false.

strict_transport_security

Установите true, если вы хотите включить заголовок ответа HTTP Strict-Transport-Security (HSTS). Используйте это только когда в вашей конфигурации включён HTTPS или когда есть другая вышестоящая система, обеспечивающая HTTPS для вашего приложения (например, фронтенд-балансировщик нагрузки). HSTS сообщает браузерам, что к сайту следует обращаться только через HTTPS.

strict_transport_security_max_age_seconds

Задаёт, как долго браузер должен кэшировать HSTS в секундах. Применяется только если включён strict_transport_security. Значение по умолчанию — 86400.

strict_transport_security_preload

Установите true, чтобы включить опцию HSTS preloading. Применяется только если включён strict_transport_security. Значение по умолчанию — false.

strict_transport_security_subdomains

Установите true, чтобы включить опцию HSTS includeSubDomains. Применяется только если включён strict_transport_security. Значение по умолчанию — false.

x_content_type_options

Установите false, чтобы отключить заголовок ответа X-Content-Type-Options. Заголовок ответа HTTP X-Content-Type-Options — это маркер, используемый сервером, чтобы указать, что MIME-типы, объявленные в заголовках Content-Type, не должны изменяться и должны соблюдаться. Значение по умолчанию — true.

x_xss_protection

Установите false, чтобы отключить заголовок X-XSS-Protection, который сообщает браузерам прекратить загрузку страниц при обнаружении отражённых атак межсайтового скриптинга (XSS). Значение по умолчанию — true.

content_security_policy

Установите true, чтобы добавить заголовок Content-Security-Policy к вашим запросам. Content Security Policy (CSP) управляет тем, какие ресурсы может загружать пользовательский агент, и помогает предотвратить атаки XSS.

content_security_policy_template

Задайте шаблон политики, который используется для добавления заголовка Content-Security-Policy к вашим запросам. $NONCE в шаблоне включает случайный nonce.

content_security_policy_report_only

Установите true, чтобы добавить заголовок Content-Security-Policy-Report-Only к вашим запросам. CSP в режиме “Report Only” позволяет вам экспериментировать с политиками, отслеживая их эффекты без их принудительного применения. Вы можете включить обе политики одновременно.

content_security_policy_template

Задайте шаблон политики, который используется для добавления заголовка Content-Security-Policy-Report-Only к вашим запросам. $NONCE в шаблоне включает случайный nonce.

actions_allow_post_url

Задаёт пути API, доступные между плагинами с использованием глагола POST. Если значение пусто, вы можете передавать через прокси только удалённые запросы. Если значение задано, вы также можете отправлять аутентифицированные POST-запросы на локальный сервер. Обычно это используется для включения серверного взаимодействия между плагинами.

Это список, разделённый запятыми, который использует сопоставление с шаблонами (glob matching).

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

actions_allow_post_url=/api/plugins/*

Следующий пример ограничивает доступ серверной частью одного плагина:

actions_allow_post_url=/api/plugins/grafana-special-app

csrf_trusted_origins

Список дополнительных разрешённых URL для прохождения проверки CSRF. Рекомендуется, когда аутентификация приходит от IdP.

csrf_additional_headers

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

csrf_always_check

Установите true, чтобы выполнять проверку CSRF даже если login cookie отсутствует в запросе (по умолчанию false).

enable_frontend_sandbox_for_plugins

Список ID плагинов, разделённых запятыми, для загрузки внутри фронтенд-песочницы.

[snapshots]

enabled

Установите false, чтобы отключить функцию снимков (по умолчанию true).

external_enabled

Установите false, чтобы отключить конечную точку публикации внешних снимков (по умолчанию true).

external_snapshot_url

Задайте корневой URL экземпляра Grafana, куда вы хотите публиковать внешние снимки (по умолчанию https://snapshots.raintank.io).

external_snapshot_name

Задайте имя для кнопки внешнего снимка. По умолчанию Publish to snapshots.raintank.io.

public_mode

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

[dashboards]

versions_to_keep

Число версий дашборда, которые нужно хранить (на дашборд). По умолчанию: 20, минимум: 1.

min_refresh_interval

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

Это также ограничивает варианты интервала обновления в Explore.

default_home_dashboard_path

Путь к домашнему дашборду по умолчанию. Если это значение пусто, то Grafana использует StaticRootPath + “dashboards/home.json”.

Файл может содержать либо классический JSON дашборда, либо ресурс дашборда в формате Kubernetes, экспортированный из API dashboard.grafana.app (с полями верхнего уровня apiVersion, kind, metadata и spec). Формат Kubernetes требуется для схем дашбордов v2.

Note

В Linux Grafana использует /usr/share/grafana/public/dashboards/home.json в качестве расположения домашнего дашборда по умолчанию.

default_preload

Значение по умолчанию на уровне всего экземпляра для предварительной загрузки панелей, применяется только к дашбордам, которые явно не задают свойство preload в своём JSON. Когда true, все панели начинают загружаться сразу при загрузке дашборда, вместо ленивой загрузки по мере прокрутки. Явное значение preload в JSON дашборда всегда имеет приоритет над этим значением по умолчанию. По умолчанию false.

[dashboard_cleanup]

Настройки, связанные с очисткой информации о связанных дашбордах, если дашборд был удалён через /apis.

interval

Как часто запускать задание для очистки связанных ресурсов. Интервал по умолчанию — 30s. Минимальное допустимое значение — 10s, чтобы гарантировать, что система не перегружена.

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

batch_size

Количество удалённых дашбордов для обработки в каждой партии во время процесса очистки. По умолчанию: 10, минимум: 5, максимум: 200.

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

[datasources]

default_manage_alerts_ui_toggle

Поведение по умолчанию для переключателя “Manage alerts via Alerting UI” при настройке источника данных. Он работает только если свойство jsonData.manageAlerts источника данных не содержит ранее настроенного значения.

default_allow_recording_rules_target_alerts_ui_toggle

Поведение по умолчанию для переключателя “Allow as recording rules target” при настройке источника данных. Он работает только если свойство jsonData.allowAsRecordingRulesTarget источника данных не содержит ранее настроенного значения.

[sql_datasources]

max_open_conns_default

Для источников данных SQL (MySql, Postgres, MSSQL) вы можете переопределить максимальное количество открытых соединений по умолчанию (по умолчанию: 100). Значение, настроенное в параметрах источника данных, имеет приоритет над значением по умолчанию.

max_idle_conns_default

Для источников данных SQL (MySql, Postgres, MSSQL) вы можете переопределить допустимое количество неактивных соединений по умолчанию (по умолчанию: 100). Значение, настроенное в параметрах источника данных, имеет приоритет над значением по умолчанию.

max_conn_lifetime_default

Для источников данных SQL (MySql, Postgres, MSSQL) вы можете переопределить максимальное время жизни соединения по умолчанию, указанное в секундах (по умолчанию: 14400). Значение, настроенное в параметрах источника данных, имеет приоритет над значением по умолчанию.

[users]

allow_sign_up

Установите false, чтобы запретить пользователям регистрироваться или создавать пользовательские учётные записи. По умолчанию false. Администратор Grafana всё ещё может создавать пользователей. Дополнительную информацию о создании пользователя см. в разделе Добавление пользователя.

allow_org_create

Установите false, чтобы запретить пользователям создавать новые организации. По умолчанию false.

auto_assign_org

Установите true, чтобы автоматически добавлять новых пользователей в основную организацию (ID 1). Когда установлено false, новые пользователи автоматически вызывают создание новой организации для этого нового пользователя. Организация создаётся даже если настройка allow_org_create установлена в false. По умолчанию true.

auto_assign_org_id

Установите это значение, чтобы автоматически добавлять новых пользователей в указанную организацию. Это требует, чтобы auto_assign_org был установлен в true. Организация должна уже существовать. По умолчанию 1.

auto_assign_org_role

Настройка auto_assign_org_role определяет роль по умолчанию, назначаемую новым пользователям в основной организации, если настройка auto_assign_org установлена в true. Вы можете установить её в одну из следующих ролей: (Viewer (по умолчанию), Admin, Editor и None). Например:

auto_assign_org_role = Viewer

verify_email_enabled

Требовать проверку электронной почты перед завершением регистрации или при обновлении адреса электронной почты пользователя. По умолчанию false.

login_default_org_id

Задаёт организацию по умолчанию для пользователей при входе. По умолчанию -1.

login_hint

Текст, используемый как текст-заполнитель на странице входа для поля ввода логина/имени пользователя.

password_hint

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

default_theme

Задаёт тему интерфейса по умолчанию: dark, light или system. Тема по умолчанию — dark.

system соответствует системной теме пользователя.

default_language

Этот параметр задаёт язык интерфейса по умолчанию, если доступен поддерживаемый тег языка IETF, например en-US. Если установлено detect, язык интерфейса по умолчанию определяется предпочтениями браузера. По умолчанию en-US.

home_page

Путь к пользовательской домашней странице. Пользователи перенаправляются на неё только если используется домашний дашборд по умолчанию. Он должен соответствовать маршруту фронтенда и содержать ведущую косую черту.

External user management

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

viewers_can_edit

Note

Этот параметр устарел — назначьте ваших наблюдателей редакторами, если вы используете RBAC, назначьте пользователям роль data sources explorer.

Наблюдатели могут получать доступ и использовать Explore и выполнять временные правки на панелях в дашбордах, к которым у них есть доступ. Они не могут сохранять свои изменения. По умолчанию false.

user_invite_max_lifetime_duration

Продолжительность времени, в течение которого приглашение пользователя остаётся действительным до истечения. Эта настройка должна быть выражена как длительность. Примеры: 6h (часы), 2d (дни), 1w (неделя). По умолчанию 24h (24 часа). Минимальная поддерживаемая длительность — 15m (15 минут).

verification_email_max_lifetime_duration

Продолжительность времени, в течение которого письмо для верификации, используемое для обновления адреса электронной почты пользователя, остаётся действительным до истечения. Эта настройка должна быть выражена как длительность. Примеры: 6h (часы), 2d (дни), 1w (неделя). По умолчанию 1h (1 час).

last_seen_update_interval

Частота обновления времени последнего появления пользователя. Эта настройка должна быть выражена как длительность. Примеры: 1h (час), 15m (минуты) По умолчанию 15m (15 минут). Минимальная поддерживаемая длительность — 5m (5 минут). Максимальная поддерживаемая длительность — 1h (1 час).

hidden_users

Это список имён пользователей, разделённых запятыми. Указанные здесь пользователи скрыты в интерфейсе Grafana. Они всё ещё видны администраторам Grafana и самим себе.

[auth]

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

Имя cookie для хранения токена аутентификации. По умолчанию grafana_session.

login_maximum_inactive_lifetime_duration

Максимальное время жизни (длительность), в течение которого аутентифицированный пользователь может быть неактивен, прежде чем ему потребуется войти при следующем посещении. По умолчанию 7 дней (7d). Эта настройка должна быть выражена как длительность, например 5m (минуты), 6h (часы), 10d (дни), 2w (недели) или 1M (месяц). Время жизни сбрасывается при каждой успешной ротации токена (token_rotation_interval_minutes).

login_maximum_lifetime_duration

Максимальное время жизни (длительность), в течение которого аутентифицированный пользователь может быть в системе с момента входа, прежде чем ему потребуется войти. По умолчанию 30 дней (30d). Эта настройка должна быть выражена как длительность, например 5m (минуты), 6h (часы), 10d (дни), 2w (недели) или 1M (месяц).

token_rotation_interval_minutes

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

disable_login_form

Установите true, чтобы отключить (скрыть) форму входа, полезно, если вы используете OAuth 2.0. По умолчанию false.

disable_signout_menu

Установите true, чтобы отключить ссылку выхода в боковом меню. Это полезно, если вы используете auth.proxy. По умолчанию false.

signout_redirect_url

URL, на который пользователь перенаправляется после выхода. Чтобы поддерживать OpenID Connect RP-Initiated Logout, пользователь должен добавить post_logout_redirect_uri к signout_redirect_url.

Пример:

ini 
signout_redirect_url = http://localhost:8087/realms/grafana/protocol/openid-connect/logout?post_logout_redirect_uri=http%3A%2F%2Flocalhost%3A3000%2Flogin

oauth_auto_login

Note

Этот параметр устарел — вместо него используйте параметр auto_login для конкретного провайдера OAuth.

Установите true, чтобы пытаться войти с OAuth автоматически, пропуская экран входа. Эта настройка игнорируется, если настроено несколько провайдеров OAuth. По умолчанию false.

Сколько секунд cookie состояния OAuth существует до удаления. По умолчанию 600 (секунд) Администраторы могут увеличить это значение, если они сталкиваются с ошибками несоответствия состояния входа OAuth.

oauth_login_error_message

Пользовательское сообщение об ошибке для случая, когда пользователи не авторизованы. По умолчанию — ключ для интернационализированной фразы во фронтенде, Login provider denied login request.

oauth_refresh_token_server_lock_min_wait_ms

Минимальное время ожидания в миллисекундах для механизма повторных попыток серверной блокировки. По умолчанию 1000 (миллисекунд). Механизм повторных попыток серверной блокировки используется для предотвращения одновременного обновления токенов OAuth несколькими экземплярами Grafana. Этот механизм ожидает как минимум это количество времени перед повторной попыткой получения серверной блокировки.

Всего пять повторных попыток, поэтому при значении по умолчанию общее время ожидания (для получения блокировки) составляет не менее 5 секунд (время ожидания между попытками вычисляется как random(n, n + 500)), что означает, что максимальная продолжительность обновления токена должна быть меньше 5-6 секунд.

Если вы сталкиваетесь с проблемами в механизме обновления токенов OAuth, вы можете увеличить это значение, чтобы дать больше времени для завершения обновления токена.

oauth_skip_org_role_update_sync

Note

Этот параметр удалён из G11 в пользу специфичных для провайдера OAuth настроек skip_org_role_sync. Следующие разделы объясняют настройки для каждого провайдера.

Если вы хотите изменить настройку oauth_skip_org_role_update_sync с true на false, то для каждого настроенного вами провайдера используйте настройку skip_org_role_sync, чтобы указать, хотите ли вы пропустить синхронизацию.

Warning

В настоящее время, если для пользователя не найдено сопоставление роли организации, Grafana не обновляет роль организации пользователя.

Если параметр oauth_skip_org_role_update_sync установлен в false, пользователи без сопоставления сбрасываются на роль организации по умолчанию при каждом входе.

Дополнительную информацию см. в разделе параметр auto_assign_org_role.

skip_org_role_sync

skip_org_role_sync предотвращает синхронизацию ролей организации для конкретной интеграции OAuth, тогда как устаревшая настройка oauth_skip_org_role_update_sync влияет на всех настроенных провайдеров OAuth.

Значение по умолчанию для skip_org_role_sync — false.

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

Когда skip_org_role_sync установлен в true, при первом входе пользователя Grafana устанавливает роль организации на основе значения, указанного в auto_assign_org_role, и принудительно устанавливает организацию в auto_assign_org_id, когда он указан, в противном случае возвращается к OrgID 1.

Note

Включение skip_org_role_sync также отключает синхронизацию администраторов Grafana от внешнего провайдера, поэтому allow_assign_grafana_admin игнорируется.

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

Поведение oauth_skip_org_role_update_sync и skip_org_role_sync можно увидеть в таблицах ниже:

[auth.grafana_com]

oauth_skip_org_role_update_sync skip_org_role_sync Результирующая роль организации Изменяемая
false false Синхронизировать роль организации пользователя с ролью Grafana.com. Если роль не предоставлена, устанавливается auto_assign_org_role. false
true false Пропускает синхронизацию роли организации для пользователей всех провайдеров OAuth. Роль устанавливается в auto_assign_org_role. true
false true Пропускает синхронизацию роли организации для пользователей Grafana.com. Роль устанавливается в auto_assign_org_role. true
true true Пропускает синхронизацию роли организации для пользователей Grafana.com и всех других провайдеров OAuth. Роль устанавливается в auto_assign_org_role. true

[auth.azuread]

oauth_skip_org_role_update_sync skip_org_role_sync Результирующая роль организации Изменяемая
false false Синхронизировать роль организации пользователя с ролью AzureAD. Если роль не предоставлена, устанавливается auto_assign_org_role. false
true false Пропускает синхронизацию роли организации для пользователей всех провайдеров OAuth. Роль устанавливается в auto_assign_org_role. true
false true Пропускает синхронизацию роли организации для пользователей AzureAD. Роль устанавливается в auto_assign_org_role. true
true true Пропускает синхронизацию роли организации для пользователей AzureAD и всех других провайдеров OAuth. Роль устанавливается в auto_assign_org_role. true

[auth.google]

oauth_skip_org_role_update_sync skip_org_role_sync Результирующая роль организации Изменяемая
false false Роль организации пользователя устанавливается в auto_assign_org_role и не может быть изменена. false
true false Роль организации пользователя устанавливается в auto_assign_org_role и может быть изменена в Grafana. true
false true Роль организации пользователя устанавливается в auto_assign_org_role и может быть изменена в Grafana. true
true true Роль организации пользователя устанавливается в auto_assign_org_role и может быть изменена в Grafana. true

Note

Для GitLab, GitHub, Okta, провайдеров Generic OAuth Grafana синхронизирует роли организации и устанавливает администраторов Grafana. Настройка allow_assign_grafana_admin также учитывается, чтобы разрешить или не устанавливать роль администратора Grafana от внешнего провайдера.

[auth.github]

oauth_skip_org_role_update_sync skip_org_role_sync Результирующая роль организации Изменяемая
false false Синхронизировать роль организации пользователя с ролью GitHub. Если роль не предоставлена, устанавливается auto_assign_org_role. false
true false Пропускает синхронизацию роли организации для пользователей всех провайдеров OAuth. Роль устанавливается в auto_assign_org_role. true
false true Пропускает синхронизацию роли организации и администратора Grafana для пользователей GitHub. Роль устанавливается в auto_assign_org_role. true
true true Пропускает синхронизацию роли организации для всех провайдеров OAuth и пропускает синхронизацию администратора Grafana для пользователей GitHub. Роль устанавливается в auto_assign_org_role. true

[auth.gitlab]

oauth_skip_org_role_update_sync skip_org_role_sync Результирующая роль организации Изменяемая
false false Синхронизировать роль организации пользователя с ролью GitLab. Если роль не предоставлена, устанавливается auto_assign_org_role. false
true false Пропускает синхронизацию роли организации для пользователей всех провайдеров OAuth. Роль устанавливается в auto_assign_org_role. true
false true Пропускает синхронизацию роли организации и администратора Grafana для пользователей GitLab. Роль устанавливается в auto_assign_org_role. true
true true Пропускает синхронизацию роли организации для всех провайдеров OAuth и пропускает синхронизацию администратора Grafana для пользователей GitLab. Роль устанавливается в auto_assign_org_role. true

[auth.generic_oauth]

oauth_skip_org_role_update_sync skip_org_role_sync Результирующая роль организации Изменяемая
false false Синхронизировать роль организации пользователя с ролью провайдера. Если роль не предоставлена, устанавливается auto_assign_org_role. false
true false Пропускает синхронизацию роли организации для пользователей всех провайдеров OAuth. Роль устанавливается в auto_assign_org_role. true
false true Пропускает синхронизацию роли организации и администратора Grafana для пользователей провайдера. Роль устанавливается в auto_assign_org_role. true
true true Пропускает синхронизацию роли организации для всех провайдеров OAuth и пропускает синхронизацию администратора Grafana для пользователей провайдера. Роль устанавливается в auto_assign_org_role. true

[auth.okta]

oauth_skip_org_role_update_sync skip_org_role_sync Результирующая роль организации Изменяемая
false false Синхронизировать роль организации пользователя с ролью Okta. Если роль не предоставлена, устанавливается auto_assign_org_role. false
true false Пропускает синхронизацию роли организации для пользователей всех провайдеров OAuth. Роль устанавливается в auto_assign_org_role. true
false true Пропускает синхронизацию роли организации и администратора Grafana для пользователей Okta. Роль устанавливается в auto_assign_org_role. true
true true Пропускает синхронизацию роли организации для всех провайдеров OAuth и пропускает синхронизацию администратора Grafana для пользователей Okta. Роль устанавливается в auto_assign_org_role. true
Пример skip_org_role_sync

[auth.google]

oauth_skip_org_role_update_sync skip_org_role_sync Результирующая роль организации Пример сценария
false false Синхронизирована с ролями организации Google Auth Пользователь входит в Grafana с помощью своей учётной записи Google, и его роль организации автоматически устанавливается на основе его роли в Google.
true false Пропущена синхронизация ролей организации от всех провайдеров OAuth Пользователь входит в Grafana с помощью своей учётной записи Google, и его роль организации не устанавливается на основе его роли. Но администраторы Grafana могут изменить роль через интерфейс.
false true Пропущена синхронизация ролей организации Google Пользователь входит в Grafana с помощью своей учётной записи Google, и его роль организации не устанавливается на основе его роли в Google. Но администраторы Grafana могут изменить роль через интерфейс.
true true Пропущена синхронизация ролей организации от всех провайдеров OAuth, включая Google Пользователь входит в Grafana с помощью своей учётной записи Google, и его роль организации не устанавливается на основе его роли в Google. Но администраторы Grafana могут изменить роль через интерфейс.

api_key_max_seconds_to_live

Ограничение времени жизни ключа API в секундах до истечения. По умолчанию -1 (без ограничений).

sigv4_auth_enabled

Установите true, чтобы включить опцию аутентификации AWS Signature Version 4 для источников данных на основе HTTP. По умолчанию false.

sigv4_verbose_logging

Установите true, чтобы включить подробное логирование подписи запросов, когда включена аутентификация AWS Signature Version 4. По умолчанию false.

managed_service_accounts_enabled

Доступно только в Grafana 11.3+.

Установите true, чтобы включить использование управляемых сервисных учётных записей для аутентификации плагинов. По умолчанию false.

Note

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

[auth.anonymous]

Подробные инструкции см. в разделе Анонимная аутентификация.

[auth.github]

Подробные инструкции см. в разделе Аутентификация GitHub OAuth2.

[auth.gitlab]

Подробные инструкции см. в разделе Аутентификация GitLab OAuth 2.0.

[auth.google]

Подробные инструкции см. в разделе Аутентификация Google OAuth2.

[auth.grafananet]

Устаревшие имена ключей, всё ещё находятся в файле конфигурации, чтобы они работали в переменных среды.

[auth.grafana_com]

Устаревшие имена ключей, всё ещё находятся в файле конфигурации, чтобы они работали в переменных среды.

[auth.azuread]

Подробные инструкции см. в разделе Аутентификация Entra ID OAuth2.

[auth.okta]

Подробные инструкции см. в разделе Аутентификация Okta OAuth2.

[auth.generic_oauth]

Подробные инструкции см. в разделе Аутентификация Generic OAuth.

[auth.basic]

Подробные инструкции см. в разделе Базовая аутентификация.

[auth.proxy]

Подробные инструкции см. в разделе Аутентификация через auth proxy.

[auth.ldap]

Подробные инструкции см. в разделе Аутентификация LDAP.

[aws]

Вы можете настроить основные и внешние плагины AWS.

allowed_auth_providers

Укажите, каких провайдеров аутентификации разрешают плагины AWS. Список разрешённых провайдеров см. на странице настройки источника данных для данного плагина. Если вы настраиваете плагин через провижининг, разрешены только провайдеры, указанные в allowed_auth_providers.

Варианты: default (по умолчанию AWS SDK), keys (ключ доступа и секретный ключ), credentials (файл учётных данных), ec2_iam_role (роль IAM EC2)

assume_role_enabled

Установите false, чтобы отключить использование аутентификацией AWS предполагаемой роли с временными учётными данными безопасности. Подробности о предполагаемых ролях см. в справочной документации API AWS об операции AssumeRole.

Если этот параметр отключён, поля Assume Role и External Id удаляются со страницы настройки источника данных AWS. Если плагин настроен с помощью провижининга, можно использовать предполагаемую роль, если assume_role_enabled установлен в true.

list_metrics_page_limit

Используйте параметр List Metrics API для загрузки метрик для пользовательских пространств имён в источнике данных Amazon CloudWatch. По умолчанию лимит страницы равен 500.

[azure]

Grafana поддерживает дополнительную интеграцию со службами Azure при размещении в облаке Azure.

cloud

Среда облака Azure, где размещена Grafana:

Облако Azure Значение
Публичное облако Microsoft Azure AzureCloud (по умолчанию)
Национальное облако Китая Microsoft AzureChinaCloud
Облако правительства США AzureUSGovernment
Национальное облако Германии Microsoft (“Black Forest”) AzureGermanCloud

clouds_config

Конфигурация JSON определяет список облаков Azure и связанные с ними свойства при размещении в пользовательских средах Azure.

Например:

ini 
clouds_config = `[
		{
			"name":"CustomCloud1",
			"displayName":"Custom Cloud 1",
			"aadAuthority":"https://login.cloud1.contoso.com/",
			"properties":{
				"azureDataExplorerSuffix": ".kusto.windows.cloud1.contoso.com",
				"logAnalytics":            "https://api.loganalytics.cloud1.contoso.com",
				"portal":                  "https://portal.azure.cloud1.contoso.com",
				"prometheusResourceId":    "https://prometheus.monitor.azure.cloud1.contoso.com",
				"resourceManager":         "https://management.azure.cloud1.contoso.com"
			}
		}]`

managed_identity_enabled

Указывает, работает ли Grafana в Azure с настроенной управляемой идентичностью (например, работа в экземпляре виртуальных машин Azure). Отключено по умолчанию, требуется явно включить.

Когда включено, Grafana автоматически пересылает переменные среды обнаружения управляемой идентичности платформы Azure (IDENTITY_ENDPOINT, IDENTITY_HEADER, IDENTITY_SERVER_THUMBPRINT, IMDS_ENDPOINT, MSI_ENDPOINT, MSI_SECRET) в принадлежащие Grafana плагины Azure, перечисленные в forward_settings_to_plugins. Это необходимо, чтобы Azure SDK внутри процесса плагина могла получать токены в Azure App Service, Azure Container Apps, Azure Arc и Service Fabric, где конечные точки управляемой идентичности недоступны через IMDS.

managed_identity_client_id

Client ID, используемый для управляемой идентичности, назначенной пользователем.

Должен быть задан для идентичности, назначенной пользователем, и должен быть пустым для идентичности, назначенной системой.

workload_identity_enabled

Указывает, должна ли аутентификация Entra ID Workload Identity быть включена в источниках данных, которые её поддерживают.

Дополнительную документацию по Entra ID Workload Identity см. в документации Entra ID Workload Identity.

Отключено по умолчанию, требуется явно включить.

Когда включено, Grafana автоматически пересылает переменные среды рабочей нагрузки идентичности, внедряемые вебхуком AKS azure-workload-identity (AZURE_TENANT_ID, AZURE_CLIENT_ID, AZURE_FEDERATED_TOKEN_FILE, AZURE_AUTHORITY_HOST), в принадлежащие Grafana плагины Azure, перечисленные в forward_settings_to_plugins. Это необходимо, чтобы Azure SDK внутри процесса плагина могла выполнять федеративный обмен токенов.

workload_identity_tenant_id

ID тенанта Entra ID Workload Identity.

Позволяет переопределить ID тенанта по умолчанию для идентичности Entra ID, связанной с сервисной учётной записью Kubernetes.

workload_identity_client_id

Client ID Entra ID Workload Identity.

Позволяет переопределить client ID по умолчанию для идентичности Entra ID, связанной с сервисной учётной записью Kubernetes.

workload_identity_token_file

Пользовательский путь к файлу токена для Entra ID Workload Identity.

Позволяет задать пользовательский путь к файлу проецируемого токена сервисной учётной записи.

user_identity_enabled

Указывает, должна ли аутентификация идентичности пользователя (от имени текущего вошедшего пользователя) быть включена в источниках данных, которые её поддерживают (требуется аутентификация AAD).

Отключено по умолчанию, требуется явно включить.

user_identity_fallback_credentials_enabled

Указывает, должны ли быть включены резервные учётные данные аутентификации идентичности пользователя в источниках данных. Включение этого позволяет создателям источников данных предоставлять резервные учётные данные для инициированных серверной частью запросов, таких как оповещения, записанные запросы и так далее.

По умолчанию включено и требует явного отключения. Это не имеет никакого эффекта, если аутентификация идентичности пользователя отключена.

user_identity_token_url

Переопределить URL токена для Azure Active Directory.

По умолчанию совпадает с URL токена, настроенным для параметров аутентификации AAD.

user_identity_client_authentication

Переопределить метод аутентификации клиента для Azure Active Directory. В настоящее время поддерживаемые значения: client_secret_post и managed_identity.

По умолчанию совпадает с методом аутентификации клиента, настроенным для параметров аутентификации AAD.

user_identity_client_id

Переопределить ID приложения AAD, который будет использоваться для обмена токена пользователя на access-токен для источника данных.

По умолчанию совпадает с используемым в аутентификации AAD или может быть установлен в другое приложение (для потока OBO).

user_identity_client_secret

Переопределить client secret приложения AAD.

По умолчанию совпадает с используемым в аутентификации AAD или может быть установлен в другое приложение (для потока OBO).

user_identity_managed_identity_client_id

Переопределить client ID управляемой идентичности приложения AAD для федеративных учётных данных, настроенных как управляемая идентичность, назначенная пользователем.

По умолчанию совпадает с используемым в аутентификации AAD или может быть установлен в другую управляемую идентичность (для потока OBO).

user_identity_federated_credential_audience

Переопределить audience федеративных учётных данных AAD для федеративных учётных данных, настроенных как управляемая идентичность, назначенная пользователем.

По умолчанию совпадает с используемым в аутентификации AAD или может быть установлен в другое audience (для потока OBO).

forward_settings_to_plugins

Задайте плагины для получения настроек Azure через контекст плагина.

По умолчанию это включает все плагины Azure, принадлежащие Grafana Labs, или те, которые используют настройки Azure (Azure Monitor, Azure Data Explorer, Prometheus, MSSQL).

azure_entra_password_credentials_enabled

Указывает, можно ли использовать аутентификацию по паролю Entra для источника данных MSSQL. Эта аутентификация не рекомендуется, и перед её включением следует подумать.

Отключено по умолчанию, требуется явно включить.

[auth.jwt]

Дополнительную информацию см. в разделе Аутентификация JWT.

[smtp]

Настройки почтового сервера.

enabled

Включите это, чтобы позволить Grafana отправлять электронную почту. По умолчанию false.

host

По умолчанию localhost:25. Используйте порт 465 для неявного TLS.

user

В случае SMTP-аутентификации по умолчанию empty.

password

В случае SMTP-аутентификации по умолчанию empty. Если пароль содержит # или ;, вам нужно обернуть его в тройные кавычки. Пример: “”"#password;"""

cert_file

Путь к файлу сертификата, по умолчанию empty.

key_file

Путь к файлу ключа, по умолчанию empty.

skip_verify

Проверять SSL для SMTP-сервера, по умолчанию false.

from_address

Адрес, используемый при отправке писем, по умолчанию admin@grafana.localhost.

from_name

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

ehlo_identity

Имя, используемое как идентичность клиента для EHLO в SMTP-сеансе, по умолчанию <instance_name>.

startTLS_policy

Либо OpportunisticStartTLS, либо MandatoryStartTLS, либо NoStartTLS, либо empty. По умолчанию empty.

enable_tracing

Включить распространение трассировки в заголовках электронной почты, используя поля traceparent, tracestate и (необязательно) baggage. По умолчанию false. Чтобы включить, вы должны сначала настроить трассировку в одном из разделов tracing.opentelemetry.*.

[smtp.static_headers]

Введите пары ключ-значение на своих собственных строках, чтобы включить их как заголовки в исходящие письма. Все ключи должны быть в каноническом формате почтового заголовка. Примеры: Foo=bar, Foo-Header=bar.

[emails]

welcome_email_on_sign_up

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

templates_pattern

Введите список шаблонов шаблонов, разделённых запятыми. По умолчанию emails/*.html, emails/*.txt.

content_types

Введите список типов содержимого, разделённых запятыми, которые должны быть включены в отправляемые письма. Перечислите типы содержимого в порядке убывания предпочтения. Например, text/html, text/plain для HTML как наиболее предпочтительного. Порядок частей важен, так как почтовые клиенты используют медиа-тип, который поддерживается и наиболее предпочтителен для отправителя. Поддерживаемые типы содержимого: text/html и text/plain. По умолчанию text/html.

[log]

Параметры логирования Grafana.

mode

Варианты: console, file и syslog. По умолчанию console и file. Используйте пробелы для разделения нескольких режимов, например console file.

level

Варианты: debug, info, warn, error. critical — это псевдоним для error. По умолчанию info.

filters

Необязательные настройки для установки разных уровней для конкретных логгеров. Например: filters = sqlstore:debug

Вы можете использовать несколько фильтров со списком, разделённым запятыми: Например: filters = sqlstore:debug,plugins:info

Эквивалент для docker-compose.yaml выглядит так:

GF_LOG_FILTERS: sqlstore:debug,plugins:info
GF_LOG_LEVEL: error

user_facing_default_error

Используйте этот параметр конфигурации, чтобы задать сообщение об ошибке по умолчанию, показываемое пользователям. Это сообщение отображается вместо конфиденциальных серверных ошибок, которые следует обфусцировать. Сообщение по умолчанию — Please inspect the Grafana server log for details..

[log.console]

Применимо только когда в режиме [log] используется console.

level

Значения см. в [log] level. По умолчанию наследуется от уровня [log].

format

Формат строки лога, допустимые варианты: text, console и json. По умолчанию console.

[log.file]

Применимо только когда в режиме [log] используется file.

level

Значения см. в [log] level. По умолчанию наследуется от уровня [log].

format

Формат строки лога, допустимые варианты: text, console и json. По умолчанию text.

log_rotate

Включить автоматическую ротацию логов, допустимые варианты: false или true. По умолчанию true. Когда включено, используйте max_lines, max_size_shift, daily_rotate и max_days для настройки поведения ротации логов.

max_lines

Максимум строк на файл перед его ротацией. По умолчанию 1000000.

max_size_shift

Максимальный размер файла перед его ротацией. По умолчанию 28, что означает 1 << 28, 256MB.

daily_rotate

Включить ежедневную ротацию файлов, допустимые варианты: false или true. По умолчанию true.

max_days

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

[log.syslog]

Применимо только когда в режиме [log] используется syslog.

level

Значения см. в [log] level. По умолчанию наследуется от уровня [log].

format

Формат строки лога, допустимые варианты: text, console и json. По умолчанию text.

network and address

Тип сети и адрес Syslog. Это может быть UDP, TCP или UNIX. Если оставить пустым, используются конечные точки UNIX по умолчанию.

facility

Syslog facility. Допустимые варианты: user, daemon или local0…local7. По умолчанию пусто.

tag

Тег Syslog. По умолчанию используется argv[0] процесса.

[log.frontend]

enabled

Инструментация Grafana Faro инициализирована. По умолчанию false. Включает набор инструментаций по умолчанию из getWebInstrumentations. Смотрите параметры ниже, чтобы выборочно отключить некоторые из них.

custom_endpoint

Пользовательская конечная точка HTTP для отправки событий, захваченных агентом Grafana Faro. По умолчанию /log-grafana-javascript-agent логирует события в стандартный вывод.

api_key

Если custom_endpoint требует аутентификации, вы можете установить здесь ключ API. Имеет значение только для провайдера Grafana JavaScript Agent.

instrumentations_console_enabled

Включает инструментацию Console для Grafana Faro, по умолчанию true.

instrumentations_performance_enabled

Включает инструментацию Performance для Grafana Faro, по умолчанию true.

instrumentations_csp_enabled

Включает инструментацию нарушений Content Security Policy для Grafana Faro, по умолчанию true.

instrumentations_tracing_enabled

Включает инструментацию Tracing для Grafana Faro, по умолчанию true.

log_endpoint_requests_per_second_limit

Лимит запросов в секунду, применяемый за расширенный период, для конечной точки приёма логов серверной части Grafana, /log-grafana-javascript-agent. По умолчанию 3.

log_endpoint_burst_limit

Максимальное количество запросов, принимаемых за короткий интервал времени, для конечной точки приёма логов серверной части Grafana, /log-grafana-javascript-agent. По умолчанию 15.

bot_filter_enabled

Включает фильтр ботов для интеграции агента Grafana Faro JavaScript. По умолчанию false. Когда включено, он будет отфильтровывать запросы от известных ботов и поисковых роботов.

[quota]

Установите квоты в -1, чтобы сделать их неограниченными.

enabled

Включить квоты использования. По умолчанию false.

org_user

Ограничить количество пользователей, разрешённых на организацию. По умолчанию 10.

org_dashboard

Ограничить количество дашбордов, разрешённых на организацию. По умолчанию 100.

org_data_source

Ограничить количество источников данных, разрешённых на организацию. По умолчанию 10.

org_api_key

Ограничить количество ключей API, которые можно ввести на организацию. По умолчанию 10.

org_alert_rule

Ограничить количество правил оповещений, которые можно ввести на организацию. По умолчанию 100.

user_org

Ограничить количество организаций, которые может создать пользователь. По умолчанию 10.

global_user

Задаёт глобальный лимит пользователей. По умолчанию -1 (без ограничений).

global_org

Задаёт глобальный лимит количества организаций, которые могут быть созданы. По умолчанию -1 (без ограничений).

global_dashboard

Задаёт глобальный лимит количества дашбордов, которые могут быть созданы. По умолчанию -1 (без ограничений).

global_api_key

Задаёт глобальный лимит ключей API, которые можно ввести. По умолчанию -1 (без ограничений).

global_session

Задаёт глобальный лимит количества пользователей, которые могут быть в системе одновременно. По умолчанию -1 (без ограничений).

global_alert_rule

Задаёт глобальный лимит количества правил оповещений, которые могут быть созданы. По умолчанию -1 (без ограничений).

global_correlations

Задаёт глобальный лимит количества корреляций, которые могут быть созданы. По умолчанию -1 (без ограничений).

alerting_rule_evaluation_results

Ограничить количество результатов вычисления запросов на одно правило оповещения. Если условный запрос правила оповещения даёт больше результатов, чем этот лимит, вычисление завершается ошибкой. По умолчанию -1 (без ограничений).

[unified_alerting]

Дополнительную информацию об оповещениях Grafana см. в разделе Grafana Alerting.

enabled

Включить или отключить Grafana Alerting. Значение по умолчанию — true.

Правила оповещений, перенесённые из дашбордов и панелей, включают обратную ссылку через annotations.

allowed_integrations

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

Допустимые типы:

prometheus-alertmanager, dingding, discord, email, googlechat, jira, kafka,
mqtt, oncall, opsgenie, pagerduty, pushover, sensugo, slack, sns, teams,
telegram, threema, victorops, webex, webhook, wecom

Изменение этой настройки не влияет на существующие интеграции теперь недопустимого типа. Они остаются в конфигурации Alertmanager и продолжают доставлять уведомления. Однако любая попытка создать или изменить такую точку контакта через интерфейс или API возвращает ошибку валидации, поэтому они становятся фактически доступными только для чтения, пока тип не будет снова разрешён или точка контакта не будет удалена. Поскольку файлы провижининга проверяются при запуске, недопустимый тип там предотвращает запуск Grafana.

disabled_orgs

Список ID организаций, разделённых запятыми, для которых нужно отключить Grafana 8 Unified Alerting.

admin_config_poll_interval

Укажите частоту опроса изменений конфигурации. Значение по умолчанию — 60s.

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

alertmanager_config_poll_interval

Укажите частоту опроса изменений конфигурации Alertmanager. Значение по умолчанию — 60s.

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

alertmanager_max_template_output_bytes

Максимальный размер в байтах, которого может достичь развёрнутый результат любого отдельного выражения шаблона (например, {{ .CommonAnnotations.description }}, {{ .ExternalURL }} и т. д.) во время отображения уведомления. Лимит проверяется после выполнения шаблона для каждого шаблонного поля, но перед вставкой значения в итоговую полезную нагрузку уведомления, отправляемую получателю. При превышении уведомление будет содержать вывод, усечённый до лимита, и будет записано предупреждение. Значение по умолчанию — 10 485 760 байт (10Mb).

ha_redis_address

Адрес или адреса сервера Redis. Это может быть один адрес Redis при использовании автономного Redis, или список адресов, разделённых запятыми, при использовании Redis Cluster/Sentinel.

Note

Дополнительную информацию о Redis см. в разделе Включение высокой доступности оповещений с помощью Redis.

ha_redis_cluster_mode_enabled

Установите true при использовании Redis в режиме Cluster. Взаимоисключающий с ha_redis_sentinel_mode_enabled.

ha_redis_sentinel_mode_enabled

Установите true при использовании Redis в режиме Sentinel. Взаимоисключающий с ha_redis_cluster_mode_enabled.

ha_redis_sentinel_master_name

Имя мастера Redis Sentinel. Применимо только когда ha_redis_sentinel_mode_enabled установлен в true.

ha_redis_username

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

ha_redis_password

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

ha_redis_sentinel_username

Имя пользователя, которое должно использоваться для аутентификации в Redis Sentinel. Применимо только когда ha_redis_sentinel_mode_enabled установлен в true.

ha_redis_sentinel_password

Пароль, который должен использоваться для аутентификации в Redis Sentinel. Применимо только когда ha_redis_sentinel_mode_enabled установлен в true.

ha_redis_db

База данных Redis. Значение по умолчанию — 0.

ha_redis_prefix

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

ha_redis_peer_name

Имя узла кластера, используемое в качестве идентификатора. Если не предоставлено, генерируется случайное.

ha_redis_max_conns

Максимальное количество одновременных соединений Redis.

ha_redis_tls_enabled

Включить TLS на клиенте, используемом для связи с сервером Redis. Это должно быть установлено в true, если используется любое из других полей ha_redis_tls_*.

ha_redis_tls_cert_path

Путь к файлу клиентского сертификата TLS в кодировке PEM, используемому для аутентификации на сервере Redis. Требуется при использовании Mutual TLS.

ha_redis_tls_key_path

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

ha_redis_tls_ca_path

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

ha_redis_tls_server_name

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

ha_redis_tls_insecure_skip_verify

Пропускает проверку сертификата сервера Redis.

ha_redis_tls_cipher_suites

Переопределяет список наборов шифров TLS по умолчанию.

ha_redis_tls_min_version

Переопределяет минимальную версию TLS по умолчанию. Допустимые значения: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13

ha_listen_address

IP-адрес и порт для прослушивания для приёма сообщений unified alerting от других экземпляров Grafana. Порт используется как для TCP, так и для UDP. Предполагается, что другие экземпляры Grafana также работают на том же порту. Значение по умолчанию — 0.0.0.0:9094.

ha_advertise_address

Явный IP-адрес и порт для объявления другим экземплярам Grafana. Порт используется как для TCP, так и для UDP.

ha_peers

Список начальных экземпляров, разделённых запятыми (в формате <HOST>:<PORT>), которые образуют кластер HA. Настройка этого параметра включает режим высокой доступности для оповещений.

ha_peer_timeout

Время ожидания, пока экземпляр отправит уведомление через Alertmanager. В HA каждому экземпляру Grafana назначается позиция (например, 0, 1). Затем мы умножаем эту позицию на тайм-аут, чтобы указать, как долго должен ждать каждый экземпляр перед отправкой уведомления, чтобы учесть задержку репликации. Значение по умолчанию — 15s.

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

ha_label

Метка — это необязательная строка для включения в каждый пакет и поток. Она уникально идентифицирует кластер и предотвращает проблемы перекрёстной коммуникации при отправке сообщений gossip в среде с несколькими кластерами.

ha_gossip_interval

Интервал между отправкой сообщений gossip. Понижая это значение (более часто), сообщения gossip распространяются по кластеру быстрее за счёт увеличения использования пропускной способности. Значение по умолчанию — 200ms.

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

ha_reconnect_timeout

Продолжительность времени, в течение которого предпринимается попытка переподключиться к потерянному узлу. При работе Grafana в кластере Kubernetes установите эту длительность меньше 15m.

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

ha_push_pull_interval

Интервал между полными синхронизациями состояния gossip. Установка этого интервала меньше (более часто) увеличивает скорость сходимости в больших кластерах за счёт увеличения использования пропускной способности. Значение по умолчанию — 60s.

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

ha_single_node_evaluation

Включить режим вычисления на одном узле для оповещений в конфигурации высокой доступности. Когда включено, только один экземпляр Grafana в кластере вычисляет правила оповещений вместо того, чтобы все экземпляры вычисляли все правила. Это снижает нагрузку на запросы к источникам данных с N раз до 1. Значение по умолчанию — false.

Требует настройки кластеризации высокой доступности (либо Memberlist, либо Redis).

Дополнительную информацию см. в разделе Режим вычисления на одном узле.

ha_single_evaluation_alert_broadcast_queue_size

Размер очереди сообщений, используемой для трансляции оповещений от основного экземпляра другим экземплярам в режиме вычисления на одном узле. Увеличьте это значение, если у вас много правил оповещений и вы видите, что сообщения трансляции отбрасываются. Значение по умолчанию — 200. Используется только когда ha_single_node_evaluation равен true.

execute_alerts

Включить или отключить выполнение правил оповещений. Значение по умолчанию — true. Интерфейс оповещений остаётся видимым.

evaluation_timeout

Задаёт тайм-аут вычисления оповещения при получении данных из источника данных. Значение по умолчанию — 30s.

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

max_attempts

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

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

Вы можете настроить поведение повторных попыток с помощью initial_retry_delay, max_retry_delay и randomization_factor.

initial_retry_delay

Начальная задержка перед повторной попыткой неудачного вычисления оповещения. По умолчанию 1s.

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

initialization_timeout

Позволяет настроить крайний срок контекста для службы AlertNG. Тайм-аут по умолчанию — 30s.

max_retry_delay

Максимальная задержка между повторными попытками во время экспоненциальной задержки. По умолчанию 4s.

После того как задержка повторной попытки достигает max_retry_delay, все последующие повторные попытки используют эту задержку.

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

randomization_factor

Коэффициент рандомизации для повторных попыток с экспоненциальной задержкой. По умолчанию 0.1.

Значение должно быть между 0 и 1.

Фактическая задержка повторной попытки выбирается случайным образом между:

[current_delay*(1-randomization_factor), current_delay*(1+randomization_factor)]

min_interval

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

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

Note

Эта настройка имеет приоритет над частотой каждого отдельного правила. Если частота правила ниже этого значения, то применяется это значение.

rule_version_record_limit

Определяет лимиты того, сколько версий правил оповещений хранится в базе данных на одно правило оповещения.

Значение по умолчанию 0 означает отсутствие лимита.

limit_email_to_org_members

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

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

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

[unified_alerting.screenshots]

Дополнительную информацию о снимках экрана см. в разделе Изображения в уведомлениях.

capture

Включить снимки экрана в уведомлениях. Этот параметр требует удалённой службы рендеринга изображений по HTTP. Дополнительную информацию см. в разделе [rendering].

capture_timeout

Тайм-аут для захвата снимков экрана. Если снимок экрана не может быть захвачен в течение тайм-аута, то уведомление отправляется без снимка экрана. Максимальная длительность — 30 секунд. Этот тайм-аут должен быть меньше минимального интервала всех групп вычисления, чтобы избежать противодавления на вычисление правил оповещений.

max_concurrent_screenshots

Максимальное количество снимков экрана, которые могут быть сделаны одновременно. Этот параметр отличается от concurrent_render_request_limit, так как max_concurrent_screenshots задаёт количество одновременных снимков экрана, которые могут быть сделаны одновременно для всех сработавших оповещений, тогда как concurrent_render_request_limit задаёт общее количество одновременных снимков экрана во всех службах Grafana.

upload_external_image_storage

Загружает снимки экрана на локальный сервер Grafana или в удалённое хранилище, такое как Azure, S3 и GCS. Дополнительную информацию см. в разделе [external_image_storage]. Если этот параметр false, то снимки экрана сохраняются на диск на срок до temp_data_lifetime.

[unified_alerting.reserved_labels]

Дополнительную информацию о зарезервированных метках Grafana см. в разделе Метки в Grafana Alerting

disabled_labels

Список зарезервированных меток, добавленных движком Grafana Alerting, которые должны быть отключены, разделённых запятыми.

Например: disabled_labels=grafana_folder

[unified_alerting.state_history]

Этот раздел настраивает, куда Grafana Alerting записывает историю состояний оповещений. См. Настройка истории состояний оповещений для сквозной настройки и примеров.

enabled

Включает запись истории состояний оповещений. По умолчанию false.

backend

Выберите серверную часть, используемую для хранения истории состояний оповещений. Поддерживаемые значения: loki, prometheus, multiple.

loki_remote_url

URL сервера Loki, используемый когда backend = loki (или когда backend = multiple и Loki является основным/второстепенным).

prometheus_target_datasource_uid

UID целевого источника данных Prometheus, используемый для записи изменений состояний оповещений, когда backend = prometheus (или когда backend = multiple и Prometheus является второстепенным).

prometheus_metric_name

Необязательно. Имя метрики для метрики состояния оповещения. По умолчанию GRAFANA_ALERTS.

prometheus_write_timeout

Необязательно. Тайм-аут для записи данных о состоянии оповещения в целевой источник данных. По умолчанию 10s.

primary

Используется только когда backend = multiple. Выбирает основную серверную часть (например loki).

secondaries

Используется только когда backend = multiple. Список второстепенных серверных частей, разделённых запятыми (например prometheus).

[unified_alerting.state_history.annotations]

Этот раздел управляет хранением аннотаций, автоматически создаваемых при вычислении правил оповещений, когда серверная часть истории состояний оповещений настроена как аннотации (см. настройку [unified_alerting.state_history].backend)

max_age

Настраивает, как долго хранятся аннотации оповещений. По умолчанию 0, что хранит их вечно. Эта настройка должна быть выражена как длительность. Например 6h (часы), 10d (дни), 2w (недели), 1M (месяц).

max_annotations_to_keep

Настраивает максимальное количество аннотаций оповещений, которые хранит Grafana. Значение по умолчанию — 0, что хранит все аннотации оповещений.

[unified_alerting.prometheus_conversion]

Этот раздел применяется только к правилам, импортированным как управляемые Grafana правила. Дополнительную информацию о процессе импорта см. в разделе Импорт управляемых источником данных правил в управляемые Grafana правила.

rule_query_offset

Задаёт смещение запроса для импортированных управляемых Grafana правил, когда query_offset не определён в исходной конфигурации группы правил. Значение по умолчанию — 1m.

default_datasource_uid

Задаёт UID источника данных по умолчанию, используемый для выполнения запроса при импорте правил Prometheus. Grafana использует это значение по умолчанию, когда заголовок X-Grafana-Alerting-Datasource-UID не предоставлен во время импорта. Если этот параметр не задан, заголовок становится обязательным. Значение по умолчанию пусто.

[annotations]

cleanupjob_batchsize

Настраивает размер партии для задания очистки аннотаций. Эта настройка используется для аннотаций дашбордов, API и оповещений.

tags_length

Применяет максимально допустимое количество тегов для любых новых введённых аннотаций. Это значение может быть между 500 и 4096 (включительно). Значение по умолчанию — 500. Установка более высокого значения повлияет на производительность и поэтому не рекомендуется.

[annotations.dashboard]

Аннотации дашбордов означают, что аннотации связаны с дашбордом, на котором они созданы.

max_age

Настраивает, как долго хранятся аннотации дашбордов. По умолчанию 0, что хранит их вечно. Эта настройка должна быть выражена как длительность. Примеры: 6h (часы), 10d (дни), 2w (недели), 1M (месяц).

max_annotations_to_keep

Настраивает максимальное количество аннотаций дашбордов, которые хранит Grafana. Значение по умолчанию — 0, что хранит все аннотации дашбордов.

[annotations.api]

Аннотации API означают, что аннотации были созданы с помощью API без какой-либо связи с дашбордом.

max_age

Настраивает, как долго Grafana хранит аннотации API. По умолчанию 0, что хранит их вечно. Эта настройка должна быть выражена как длительность. Примеры: 6h (часы), 10d (дни), 2w (недели), 1M (месяц).

max_annotations_to_keep

Настраивает максимальное количество аннотаций API, которые хранит Grafana. Значение по умолчанию — 0, что хранит все аннотации API.

[explore]

Дополнительную информацию об этой функции см. в разделе Explore.

enabled

Включить или отключить раздел Explore. По умолчанию enabled.

defaultTimeOffset

Задаёт смещение времени по умолчанию от текущего момента в средстве выбора времени. По умолчанию 1 час. Эта настройка должна быть выражена как длительность. Примеры: 1h (час), 1d (день), 1w (неделя), 1M (месяц).

hide_logs_download

Показать или скрыть кнопку загрузки логов в Explore. По умолчанию false, чтобы кнопка была видимой.

[help]

Настраивает раздел справки.

enabled

Включить или отключить раздел Help. По умолчанию enabled.

[profile]

Настраивает раздел Profile.

enabled

Включить или отключить раздел Profile. По умолчанию enabled.

[news]

news_feed_enabled

Включает раздел новостной ленты. По умолчанию true

[query]

concurrent_query_limit

Задаёт количество запросов, которые могут выполняться одновременно на панели со смешанным источником данных. По умолчанию — количество ЦП.

[query_history]

Настраивает историю запросов в Explore.

enabled

Включить или отключить историю запросов. По умолчанию enabled.

Настраивает параметры, связанные с функцией коротких ссылок.

expire_time

Короткие ссылки, к которым никогда не обращаются, считаются истёкшими или устаревшими и могут быть удалены в ходе очистки. Задайте время истечения в днях. По умолчанию -1 дней (никогда не истекают). Максимум — 365 дней.

Значение выше максимума использует значение 365 вместо него. Отрицательное значение, такое как -1, отключает истечение.

[metrics]

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

enabled

Включить отчётность метрик. По умолчанию true. Доступно через HTTP API <URL>/metrics.

interval_seconds

Интервал сброса/записи при отправке метрик во внешнюю TSDB. По умолчанию 10.

disable_total_stats

Если установлено true, то генерация общей статистики (метрики stat_totals_*) отключена. По умолчанию false.

total_stats_collector_interval_seconds

Задаёт интервал сборщика общей статистики. По умолчанию 1800 секунд (30 минут).

basic_auth_username and basic_auth_password

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

[metrics.environment_info]

Добавляет измерения к метрике grafana_environment_info, которая может раскрыть больше информации об экземпляре Grafana.

; exampleLabel1 = exampleValue1
; exampleLabel2 = exampleValue2

[metrics.graphite]

Используйте эти параметры, если вы хотите отправлять внутренние метрики Grafana в Graphite.

address

Включите, задав адрес. Формат — <Hostname or ip>:port.

prefix

Префикс метрик Graphite. По умолчанию prod.grafana.%(instance_name)s.

[grafana_net]

Обратитесь к конфигурации [grafana_com], так как это предпочтительное имя конфигурации. Конфигурация [grafana_net] всё ещё принимается и разбирается как конфигурация [grafana_com].

[grafana_com]

url

По умолчанию https://grafana.com. Провайдер идентификации аутентификации по умолчанию для Grafana Cloud.

proxy_token

По умолчанию пусто. Выделенный токен API для просмотра каталога плагинов и установки плагинов через grafana-cli. Требует включённого переключателя функции dedicatedGrafanaComProxyAPIToken.

Задаётся через переменную среды: GF_GRAFANA_COM_PROXY_TOKEN.

[tracing.jaeger]

[Устарело — используйте вместо этого tracing.opentelemetry.jaeger или tracing.opentelemetry.otlp]

Настройте клиент Jaeger в Grafana для распределённой трассировки.

Вы также можете использовать стандартные переменные среды JAEGER_* для настройки Jaeger. Полный список см. в таблице в разделе Настройка трассировки через переменные среды. Переменные среды переопределяют любые настройки, предоставленные здесь.

address

Пункт назначения host:port для отправки спанов. (напр.: localhost:6831)

Может быть задан с помощью переменных среды JAEGER_AGENT_HOST и JAEGER_AGENT_PORT.

always_included_tag

Список тегов, разделённых запятыми, для включения во все новые спаны, например tag1:value1,tag2:value2.

Может быть задан с помощью переменной среды JAEGER_TAGS (используйте = вместо : с переменной среды).

sampler_type

Значение по умолчанию — const.

Указывает тип сэмплера: const, probabilistic, ratelimiting или remote.

См. https://www.jaegertracing.io/docs/1.16/sampling/#client-sampling-configuration для подробностей о различных типах трассировки.

Может быть задан с помощью переменной среды JAEGER_SAMPLER_TYPE.

Чтобы переопределить эту настройку, введите sampler_type в разделе tracing.opentelemetry.

sampler_param

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

Это параметр конфигурации сэмплера. В зависимости от значения sampler_type он может быть 0, 1 или десятичным значением между ними.

  • Для сэмплера const: 0 или 1 для всегда false/true соответственно
  • Для сэмплера probabilistic: вероятность между 0 и 1.0
  • Для сэмплера rateLimiting: количество спанов в секунду
  • Для сэмплера remote: аргумент тот же, что и для probabilistic, и указывает начальную частоту сэмплирования до фактических, полученных от удалённого источника.

Может быть задан с помощью переменной среды JAEGER_SAMPLER_PARAM.

Установка sampler_param в разделе tracing.opentelemetry переопределяет эту настройку.

sampling_server_url

sampling_server_url — это URL менеджера сэмплирования, предоставляющего стратегию сэмплирования.

Установка sampling_server_url в разделе tracing.opentelemetry переопределяет эту настройку.

zipkin_propagation

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

Управляет тем, использовать ли формат распространения спанов Zipkin (с HTTP-заголовками x-b3-). По умолчанию используется формат Jaeger.

Может быть задан с помощью переменной среды и значения JAEGER_PROPAGATION=b3.

disable_shared_zipkin_spans

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

Установка этого в true отключает общие спаны RPC. Оставление этого доступным — наиболее распространённая настройка при использовании Zipkin в другом месте вашей инфраструктуры.

[tracing.opentelemetry]

Настройте общие параметры, используемые всеми провайдерами OpenTelemetry.

custom_attributes

Список атрибутов, разделённых запятыми, для включения во все новые спаны, например key1:value1,key2:value2.

Может быть задан или переопределён с помощью переменной среды OTEL_RESOURCE_ATTRIBUTES (используйте = вместо : с переменной среды). Имя службы может быть задано или переопределено с помощью атрибутов или с помощью переменной среды OTEL_SERVICE_NAME.

sampler_type

Значение по умолчанию — const.

Указывает тип сэмплера: const, probabilistic, ratelimiting или remote.

sampler_param

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

В зависимости от значения sampler_type параметр конфигурации сэмплера может быть 0, 1 или любым десятичным значением между 0 и 1.

  • Для сэмплера const используйте 0, чтобы никогда не сэмплировать, или 1, чтобы всегда сэмплировать
  • Для сэмплера probabilistic вы можете использовать десятичное значение между 0.0 и 1.0
  • Для сэмплера rateLimiting введите количество спанов в секунду
  • Для сэмплера remote используйте десятичное значение между 0.0 и 1.0, чтобы указать начальную частоту сэмплирования, используемую до получения первого обновления от сервера сэмплирования

sampling_server_url

Когда sampler_type — remote, это указывает URL сервера сэмплирования. Это может использоваться всеми провайдерами трассировки.

Используйте сервер сэмплирования, поддерживающий API удалённого сэмплирования Jaeger, такой как jaeger-agent, jaeger-collector, opentelemetry-collector-contrib или Grafana Alloy.

[tracing.opentelemetry.jaeger]

Настройте Grafana с клиентом Jaeger для распределённой трассировки.

address

Пункт назначения <HOST>:<PORT> для отправки спанов. Например, localhost:14268/api/traces.

propagation

Распространение задаёт формат распространения текстовой карты. Поддерживаются значения jaeger и w3c. Добавьте запятую (,) между значениями, чтобы указать несколько форматов (например, "jaeger,w3c"). Значение по умолчанию — w3c.

[tracing.opentelemetry.otlp]

Настройте Grafana с клиентом OTLP для распределённой трассировки.

address

Пункт назначения <HOST>:<PORT> для отправки спанов. Например, localhost:4317.

propagation

Распространение задаёт формат распространения текстовой карты. Поддерживаются значения jaeger и w3c. Добавьте запятую (,) между значениями, чтобы указать несколько форматов (например, "jaeger,w3c"). Значение по умолчанию — w3c.

insecure

Переключает настройку незащищённой связи, по умолчанию true. Когда установлено false, клиент OTLP будет использовать учётные данные TLS с пулом сертификатов системы по умолчанию для связи.

[tracing.opentelemetry.file]

Grafana может захватывать свои собственные распределённые трассировки в локальный файл в формате JSON OpenTelemetry Protocol (OTLP), без запуска коллектора или серверной части трассировки. Захват останавливается, когда файл достигает лимита размера или истекает длительность захвата, в зависимости от того, что наступит раньше. Используйте этот экспортёр для поддержки: включите его, воспроизведите проблему, затем соберите и поделитесь файлом.

path

Путь к файлу захвата, например /var/lib/grafana/traces/capture.json. Установка этого параметра включает файловый экспортёр. Родительский каталог должен уже существовать и быть доступным для записи Grafana. Значение по умолчанию пусто, что отключает экспортёр.

max_file_size_bytes

Максимальный размер файла захвата в байтах. Значение по умолчанию — 104857600 (100 MiB). Значение должно быть больше 0.

capture_duration

Как долго захватывать трассировки после запуска Grafana, выражается как длительность, например 10m. Значение по умолчанию — 10m. Значение должно быть больше 0.

[external_image_storage]

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

provider

Варианты: s3, webdav, gcs, azure_blob, local). Если оставить пустым, то Grafana игнорирует действие загрузки.

[external_image_storage.s3]

endpoint

Необязательный URL конечной точки (имя хоста или полный URI) для переопределения генерируемой по умолчанию конечной точки S3. Если вы хотите сохранить значение по умолчанию, просто оставьте это пустым. Вы всё равно должны предоставить значение region, если указываете конечную точку.

path_style_access

Установите это в true, чтобы принудительно использовать адресацию в стиле пути в запросах S3, которая использует http://s3.amazonaws.com/<BUCKET>/<KEY> вместо значения по умолчанию, которое использует адресацию виртуального размещённого бакета, когда это возможно (http://<BUCKET>.s3.amazonaws.com/<KEY>).

Note

Этот параметр специфичен для службы Amazon S3.

bucket_url

(для обратной совместимости, работает только когда не настроены ни bucket, ни region) URL бакета для S3. Регион AWS может быть указан в URL или по умолчанию ‘us-east-1’, например,

bucket

Имя бакета для S3. Например, grafana.snapshot.

region

Имя региона для S3. Например, us-east-1 или cn-north-1.

path

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

access_key

Ключ доступа, например AAAAAAAAAAAAAAAAAAAA.

Ключ доступа требует разрешений на бакет S3 для действий ‘s3:PutObject’ и ‘s3:PutObjectAcl’.

secret_key

Секретный ключ, например AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA.

enable_presigned_urls

Генерировать presigned-URL-адреса для загруженных изображений вместо требования публично читаемых объектов. Когда включено, объекты загружаются без заголовка ACL, что делает это совместимым с бакетами S3, у которых ObjectOwnership установлен в BucketOwnerEnforced (ACL отключены). По умолчанию false.

presigned_url_expiration

Длительность, в течение которой presigned-URL-адреса остаются действительными. Использует формат длительности Go (например, 168h для 7 дней, 6h для 6 часов). По умолчанию 168h (7 дней).

Note

Максимальное истечение зависит от типа ваших учётных данных AWS: учётные данные пользователя IAM поддерживают до 7 дней, учётные данные роли IAM или STS ограничены продолжительностью сессии (обычно 1–12 часов), а учётные данные профиля экземпляра ограничены 6 часами.

[external_image_storage.webdav]

url

URL, куда Grafana отправляет PUT-запрос с изображениями.

username

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

password

Пароль базовой аутентификации.

public_url

Необязательный URL для отправки пользователям в уведомлениях. Если строка содержит последовательность {{file}}, она заменяется именем загруженного файла. В противном случае имя файла добавляется к части пути URL, оставляя любую строку запроса без изменений.

[external_image_storage.gcs]

key_file

Необязательный путь к JSON-файлу ключа, связанному с учётной записью службы Google, для аутентификации и авторизации. Если значение не предоставлено, он пытается использовать учётные данные приложения по умолчанию. Ключи учётной записи службы можно создать и загрузить с https://console.developers.google.com/permissions/serviceaccounts.

Учётная запись службы должна иметь роль “Storage Object Writer”. Модель управления доступом бакета должна быть “Set object-level and bucket-level permissions”. Grafana делает изображения публично доступными для чтения, когда подписанные URL не включены.

bucket

Имя бакета в Google Cloud Storage.

path

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

enable_signed_urls

Если установлено true, Grafana создаёт подписанный URL для изображения, загруженного в Google Cloud Storage.

signed_url_expiration

Задаёт срок истечения подписанного URL, который по умолчанию составляет семь дней.

[external_image_storage.azure_blob]

account_name

Имя учётной записи хранилища.

account_key

Ключ учётной записи хранилища

container_name

Имя контейнера, где хранить “Blob”-изображения со случайными именами. Требуется предварительное создание blob-контейнера. Поддерживаются только публичные контейнеры.

sas_token_expiration_days

Количество дней действия токена SAS. Если указано, к URL изображения прикрепляется токен SAS. Позволяет хранить изображения в приватных контейнерах.

[external_image_storage.local]

Этот параметр не требует никакой конфигурации.

[rendering]

Параметры для настройки удалённой службы рендеринга изображений по HTTP, например, с использованием https://github.com/grafana/grafana-image-renderer.

renderer_token

Токен аутентификации отправляется и проверяется рендерером. Рендерер отклоняет любой запрос без токена аутентификации, соответствующего настроенному на рендерере.

server_url

URL удалённой службы рендеринга изображений по HTTP, например http://localhost:8081/render, которую Grafana может использовать для рендеринга панелей и дашбордов в PNG-изображения с помощью HTTP-запросов к внешней службе.

callback_url

Если удалённая служба рендеринга изображений по HTTP работает на другом сервере, чем сервер Grafana, вам может потребоваться настроить это на URL, где Grafana доступна, например http://grafana.domain/.

callback_url также можно настроить для поддержки использования рендерера изображений, работающего как плагин с поддержкой SSL / HTTPS. Например https://localhost:3000/.

concurrent_render_request_limit

Лимит одновременных запросов рендеринга влияет на то, когда используется конечная точка HTTP /render. Рендеринг многих изображений одновременно может перегрузить сервер, от чего эта настройка может помочь защитить, разрешая только определённое количество одновременных запросов. По умолчанию 30.

ca_cert_file_path

Путь к файлу сертификата CA в кодировке PEM от сервера Image Renderer.

default_image_width

Настраивает ширину отрендеренного изображения. Ширина по умолчанию — 1000.

default_image_height

Настраивает высоту отрендеренного изображения. Высота по умолчанию — 500.

default_image_scale

Настраивает масштаб отрендеренного изображения. Масштаб по умолчанию — 1.

[panels]

enable_alpha

Установите true, если вы хотите протестировать альфа-панели, которые ещё не готовы для общего использования. По умолчанию false.

disable_sanitize_html

Note

Эта конфигурация недоступна в экземплярах Grafana Cloud.

Если установлено true, Grafana разрешает теги script в текстовых панелях. Не рекомендуется, так как это включает уязвимости XSS. По умолчанию false.

[plugins]

enable_alpha

Установите true, если вы хотите протестировать альфа-плагины, которые ещё не готовы для общего использования. По умолчанию false.

allow_loading_unsigned_plugins

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

Мы не рекомендуем использовать этот параметр. Дополнительную информацию см. в разделе Подписи плагинов.

plugin_admin_enabled

Доступно только администраторам Grafana, включает установку, удаление и обновление плагинов непосредственно из интерфейса Grafana. Установлено в true по умолчанию. Установка его в false скрывает элементы управления.

Дополнительную информацию см. в разделе Каталог плагинов.

plugin_admin_external_manage_enabled

Установите true, если вы хотите включить внешнее управление плагинами. По умолчанию false. Это применимо только к пользователям Grafana Cloud.

plugin_catalog_url

Пользовательский URL установки/узнать больше для плагинов Enterprise. По умолчанию https://grafana.com/grafana/plugins/.

plugin_catalog_hidden_plugins

Введите список идентификаторов плагинов, разделённых запятыми, чтобы скрыть их в каталоге плагинов.

public_key_retrieval_disabled

Отключить загрузку публичного ключа для проверки подписи плагинов. По умолчанию false. Когда вы отключаете загрузку, Grafana проверяет подписи плагинов только с помощью ключей, встроенных в бинарный файл, и не запрашивает базу данных или сервер API. Когда загрузка включена, Grafana сначала читает ключи из базы данных и возвращается к встроенным ключам. См. Как Grafana находит ключ подписи.

public_key_retrieval_on_startup

Принудительно загрузить публичный ключ для проверки подписи плагинов при запуске. По умолчанию false. Если отключено, публичный ключ извлекается каждые 10 дней. Требует, чтобы public_key_retrieval_disabled был false, чтобы иметь какой-либо эффект.

disable_plugins

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

preinstall

Введите список идентификаторов плагинов, разделённых запятыми, для установки при запуске, используя каталог Grafana в качестве источника. Предустановленные плагины нельзя удалить из пользовательского интерфейса Grafana; их нужно сначала удалить из этого списка.

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

Чтобы закрепить плагины на конкретной версии, используйте формат plugin_id@version, напримерgrafana-piechart-panel@1.6.0. Если версия не указана, устанавливается последняя версия. Плагин автоматически обновляется до последней версии, когда новая версия становится доступной в каталоге плагинов Grafana при запуске (кроме новых основных версий).

Чтобы использовать пользовательский URL для загрузки плагина, используйте формат plugin_id@version@url, например grafana-piechart-panel@1.6.0@https://example.com/grafana-piechart-panel-1.6.0.zip.

По умолчанию Grafana устанавливает некоторые предлагаемые плагины при запуске. Список предустановленных по умолчанию плагинов см. в pkg/setting/setting_plugins.go:35.

preinstall_sync

Введите список идентификаторов плагинов, разделённых запятыми, для установки при запуске, используя каталог Grafana в качестве источника. То же, что и preinstall, но устанавливает плагины синхронно.

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

preinstall_disabled

Этот параметр отключает все предустановленные плагины. По умолчанию false. Чтобы отключить предустановку конкретного плагина, используйте параметр disable_plugins.

preinstall_auto_update

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

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

Чтобы предотвратить автоматические обновления для конкретных плагинов, закрепите их на конкретной версии, используя формат plugin_id@version в настройке preinstall.

[marketplace]

license_directory

Каталог, содержащий файлы лицензий Marketplace для плагинов. Назовите каждый файл license-<PLUGIN_ID>.jwt. По умолчанию — путь данных Grafana, рядом с файлом license.jwt Enterprise по умолчанию.

[live]

max_connections

Параметр max_connections задаёт максимальное количество соединений с конечной точкой Grafana Live WebSocket на один экземпляр сервера Grafana. По умолчанию 100.

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

0 отключает Grafana Live, -1 означает неограниченное количество соединений.

allowed_origins

Параметр allowed_origins — это список дополнительных источников, разделённых запятыми (заголовок Origin запроса HTTP Upgrade во время установления WebSocket-соединения), которые принимаются Grafana Live.

Если не задано (по умолчанию), то источник сопоставляется с root_url, что должно быть достаточно для большинства сценариев.

Шаблоны источников поддерживают символ подстановки “*”.

Например:

ini 
[live]
allowed_origins = "https://*.example.com"

ha_engine

Экспериментально

Имя движка высокой доступности (HA) для Grafana Live. По умолчанию оно не задано. Единственное возможное значение — redis.

Дополнительную информацию см. в разделе Настройка конфигурации Grafana Live HA.

ha_engine_address

Экспериментально

Адрес выбранного движка Live высокой доступности (HA). Для Redis это строка host:port или URL соединения redis:// или rediss://. Пример:

ini 
[live]
ha_engine = redis
ha_engine_address: redis-headless.grafana.svc.cluster.local:6379
ha_engine_password: $__file{/your/redis/password/secret/mount}

Используйте схему rediss:// для подключения к Redis по TLS. URL-адреса соединений также могут содержать учётные данные и номер базы данных; пароль, заданный в URL (даже явно пустой), имеет приоритет, а ha_engine_password применяется, когда в URL пароль не задан. Пример:

ini 
[live]
ha_engine = redis
ha_engine_address = rediss://redis.example.com:6380

[provisioning]

allowed_targets

Список целей, которыми может управлять репозиторий, разделённых запятыми. По умолчанию folder. Используйте folder, если вы хотите, чтобы репозиторий управлял только папкой внутри экземпляра Grafana. Используйте instance, если вы хотите, чтобы репозиторий управлял всем экземпляром Grafana.

allow_image_rendering

Разрешён ли рендеринг изображений для предпросмотров дашбордов. Требует настроенной службы рендеринга изображений. По умолчанию true.

allow_insecure

Разрешать ли URL репозиториев http:// вместе с настроенным токеном. Поскольку это отправляет токен в открытом виде при каждой операции Git, по умолчанию это отклоняется. Предназначено только для локального использования и разработки. Также неявно разрешено, когда app_mode = development. По умолчанию false.

allowed_git_urls

Хотя публичные адреса всегда разрешены, для предотвращения подделки запросов на стороне сервера (SSRF) URL-адреса репозиториев, которые разрешаются в адреса loopback, приватные (RFC 1918), link-local или неопределённые, по умолчанию отклоняются.

Если вы хотите разрешить внутренний или самостоятельно размещённый сервер Git, например локальный хост GitHub Enterprise, добавьте запись здесь. Каждая запись может быть именем хоста, host:port, полным URL (используется только хост), литеральным IP-адресом или диапазоном CIDR.

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

min_sync_interval

Минимальный интервал синхронизации, который вы можете задать для репозитория. Указывает, как часто контроллер будет проверять изменения в репозитории, которые не были распространены через вебхук. Минимальное значение — 10s. По умолчанию 10s.

repository_types

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

Поддерживаемые типы: local, git, github. Grafana Enterprise дополнительно поддерживает bitbucket и gitlab.

max_repositories

Максимальное количество разрешённых репозиториев. По умолчанию 10. Установите 0 для неограниченного количества репозиториев.

max_resources_per_repository

Максимальное количество ресурсов (дашборды, папки и т. д.), разрешённых на репозиторий. По умолчанию 0, что означает без ограничений.

public_root_url

Публичный корневой URL этого экземпляра Grafana, используемый провижинингом для построения URL-адресов, которые должны быть доступны из внешних систем. Когда пусто, возвращается к [server] root_url.

Два потребителя учитывают эту настройку:

  • Обратные вызовы вебхуков, зарегистрированные у провайдера Git (например, GitHub). spec.webhook.baseUrl для отдельного репозитория, когда задан, всё равно имеет приоритет.
  • Изображения снимков экрана, встроенные в комментарии к pull-request. Они загружаются серверами провайдера Git, поэтому URL должен быть доступен из публичного интернета.

Задайте это, когда [server] root_url указывает на внутренний адрес кластера (например, когда Grafana работает за приватным ingress), но провижинингу нужен внешне доступный хост. Это аналогично [rendering] callback_url, который служит той же цели для плагина рендеринга изображений.

webhook_trusted_ip_header

Имя заголовка, который несёт реальный IP клиента, используемый для ключа ограничения скорости по клиенту на конечной точке вебхука. Когда пусто, ограничитель скорости использует ключ по реальному адресу TCP-узла.

Задайте это только когда конечная точка находится за прокси, который перезаписывает заголовок разрешённым IP клиента, например X-Real-Ip.

webhook_rate_limit_rps

Устойчивое количество запросов в секунду, которое конечная точка вебхука разрешает на клиента перед возвратом 429 Too Many Requests. Мгновенное разрешение на всплеск — вдвое больше этого значения. По умолчанию 0, что отключает ограничение скорости.

[plugin.plugin_id]

Этот раздел можно использовать для настройки специфичных для плагина настроек. Замените атрибут plugin_id на ID плагина, присутствующий в plugin.json.

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

tracing

Note

OpenTelemetry также должен быть настроен.

Если true, распространять контекст трассировки в серверную часть плагина и включить трассировку (если серверная часть её поддерживает).

as_external

Загрузить внешнюю версию основного плагина, если она была установлена.

[plugin.grafana-image-renderer]

Дополнительную информацию см. в разделе Рендеринг изображений.

rendering_timezone

Указывает экземпляру headless-браузера использовать часовой пояс по умолчанию, когда он не предоставлен Grafana, например, при рендеринге изображения панели оповещения. Список поддерживаемых ID часовых поясов см. в файле ICU metaZones.txt. Возвращается к переменной среды TZ, если не задано.

rendering_language

Указывает экземпляру headless-браузера использовать язык по умолчанию, когда он не предоставлен Grafana, например, при рендеринге изображения панели оповещения. Обратитесь к заголовку HTTP Accept-Language, чтобы понять, как форматировать это значение, например, ‘fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5’.

rendering_viewport_device_scale_factor

Указывает экземпляру headless-браузера использовать коэффициент масштаба устройства по умолчанию, когда он не предоставлен Grafana, например, при рендеринге изображения панели оповещения. По умолчанию 1. Использование более высокого значения создаёт более детализированные изображения (более высокий DPI), но требует больше места на диске для хранения изображения.

rendering_ignore_https_errors

Указывает экземпляру headless-браузера, игнорировать ли ошибки HTTPS во время навигации. По умолчанию ошибки HTTPS не игнорируются. Из-за риска безопасности мы не рекомендуем игнорировать ошибки HTTPS.

rendering_verbose_logging

Указывает экземпляру headless-браузера, захватывать ли и логировать подробную информацию при рендеринге изображения. По умолчанию false и захватываются только сообщения об ошибках.

Когда включено, отладочные сообщения также захватываются и логируются.

Чтобы подробная информация была включена в лог сервера Grafana, вы должны настроить уровень лога рендеринга на debug, настроив [log].filter = rendering:debug.

rendering_dumpio

Указывает экземпляру headless-браузера, выводить ли свои отладочные и ошибочные сообщения в работающий процесс удалённой службы рендеринга. По умолчанию false.

Может быть полезно установить это в true при устранении неполадок.

rendering_timing_metrics

Note

Доступно начиная с grafana-image-renderer v3.9.0+

Указывает экземпляру headless-браузера, записывать ли метрики для продолжительности каждого шага рендеринга. По умолчанию false.

Установка этого в true может быть полезна при оптимизации настроек режима рендеринга для повышения производительности плагина или при устранении неполадок.

rendering_args

Дополнительные аргументы для передачи экземпляру headless-браузера. Значения по умолчанию — --no-sandbox,--disable-gpu. Список флагов Chromium можно найти на (https://peter.sh/experiments/chromium-command-line-switches/). Разделяйте несколько аргументов запятыми.

rendering_chrome_bin

Вы можете настроить плагин на использование другого бинарного файла браузера вместо предварительно упакованной версии Chromium.

Обратите внимание, что это не рекомендуется. Вы можете столкнуться с проблемами, если установленная версия Chrome или Chromium несовместима с плагином.

rendering_mode

Указывает, как создаются экземпляры headless-браузера. По умолчанию default и создаёт новый экземпляр браузера при каждом запросе.

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

Режим reusable использует один экземпляр браузера и создаёт новую страницу в режиме инкогнито при каждом запросе.

rendering_clustering_mode

Когда rendering_mode = clustered, вы можете указать, сколько браузеров или страниц в режиме инкогнито могут выполняться одновременно. По умолчанию browser и кластеризация с использованием экземпляров браузера.

Режим context кластеризуется с использованием страниц в режиме инкогнито.

rendering_clustering_max_concurrency

Когда rendering_mode = clustered, вы можете определить максимальное количество экземпляров браузера или страниц в режиме инкогнито, которые могут выполняться одновременно. По умолчанию 5.

rendering_clustering_timeout

Note

Доступно в grafana-image-renderer v3.3.0 и более поздних версиях.

Когда rendering_mode = clustered, вы можете указать длительность, в течение которой запрос рендеринга может выполняться до истечения тайм-аута. По умолчанию 30 секунд.

rendering_viewport_max_width

Ограничить максимальную ширину области просмотра, которая может быть запрошена.

rendering_viewport_max_height

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

rendering_viewport_max_device_scale_factor

Ограничить максимальный коэффициент масштаба устройства области просмотра, который может быть запрошен.

grpc_host

Изменить хост прослушивания сервера gRPC. Хост по умолчанию — 127.0.0.1.

grpc_port

Изменить порт прослушивания сервера gRPC. Порт по умолчанию — 0 и использует неиспользуемый порт.

[enterprise]

Дополнительную информацию о Grafana Enterprise см. в разделе Grafana Enterprise.

[feature_toggles]

FEATURE_NAME = <value>

Используйте пару ключ-значение, чтобы задать значения флагов функций явно, переопределяя любые значения по умолчанию. Поддерживается несколько разных типов, согласно спецификации OpenFeature. Дополнительные сведения см. в файле defaults.ini.

Например, чтобы отключить включённый по умолчанию переключатель функции с именем exploreMixedDatasource, укажите exploreMixedDatasource = false.

enable

Note

Этот параметр устарел и будет удалён в будущем основном релизе. Вместо него используйте отдельные записи переключателей.

Ключи функций для включения, разделённые пробелами.

[date_formats]

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

Шаблоны формата используют токены форматирования Moment.js.

full_date

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

intervals

Эти форматы интервалов используются на графике для отображения только частичной даты или времени. Например, если между метками делений оси Y только минуты, то используется формат interval_minute.

Значения по умолчанию

interval_second = HH:mm:ss
interval_minute = HH:mm
interval_hour = MM/DD HH:mm
interval_day = MM/DD
interval_month = YYYY-MM
interval_year = YYYY

use_browser_locale

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

default_timezone

Используется как часовой пояс по умолчанию для предпочтений пользователя. Может быть либо browser для местного часового пояса браузера, либо именем часового пояса из базы данных часовых поясов IANA, например UTC или Europe/Amsterdam.

default_week_start

Задаёт начало недели по умолчанию, допустимые значения: saturday, sunday, monday или browser, чтобы использовать локаль браузера для определения первого дня недели. По умолчанию browser.

[time_picker]

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

quick_ranges

Задаёт набор быстрых относительных диапазонов времени по умолчанию, которые отображаются в правом столбце средства выбора времени. Каждая запись конфигурации должна иметь поля from, to и display. Любая конфигурация для этого поля должна быть в допустимом формате JSON, состоящем из списка конфигураций быстрых диапазонов.

Поля from и to должны быть допустимыми относительными диапазонами времени. Дополнительную информацию о форматах относительного времени см. в разделе Единицы времени и относительные диапазоны. Поле from обязательно, но пропуск to приведёт к использованию значения from в обоих полях.

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

Например:

ini 
[time_picker]
quick_ranges = """[
{"from":"now-6s","to":"now","display":"Last 6 seconds"},
{"from":"now-10m","to":"now","display":"Last 10 minutes"},
{"from":"now-25h","to":"now","display":"Last 24 hours"},
{"from":"now/w","to":"now/w","display":"This week"},
{"from":"now-1w/w","to":"now-1w/w","display":"Last week"},
{"from":"now-10d","to":"now","display":"Last 10 days"}
]"""

[expressions]

enabled

Установите false, чтобы отключить выражения и скрыть их в интерфейсе Grafana. По умолчанию true.

sql_expression_cell_limit

Задаёт максимальное количество ячеек, которые можно передать в SQL-выражение. По умолчанию 100000. Значение 0 означает отсутствие лимита.

sql_expression_output_cell_limit

Задаёт максимальное количество ячеек, которые можно вернуть из SQL-выражения. По умолчанию 100000. Значение 0 означает отсутствие лимита.

sql_expression_query_length_limit

Задаёт максимальную длину SQL-запроса, который можно использовать в SQL-выражении. По умолчанию 10000 символов. Значение 0 означает отсутствие лимита.

sql_expression_timeout

Длительность, в течение которой будет выполняться SQL-выражение до отмены. По умолчанию 10s. Значение 0s означает отсутствие лимита.

math_expression_memory_limit

Задаёт максимальную оцениваемую память в байтах, которую может выделить одна бинарная операция математического выражения. По умолчанию 1073741824 (1 GiB). Значение 0 означает отсутствие лимита.

[geomap]

Этот раздел управляет настройками по умолчанию для плагина Geomap.

default_baselayer_config

Конфигурация JSON, используемая для определения базовой карты по умолчанию. Четыре варианта базовой карты на выбор: carto, esriXYZTiles, xyzTiles, standard. Например, чтобы установить cartoDB light в качестве базового слоя по умолчанию:

ini 
default_baselayer_config = `{
  "type": "xyz",
  "config": {
    "attribution": "OpenStreetMap",
    "url": "https://tile.openstreetmap.org/{z}/{x}/{y}.png"
  }
}`

enable_custom_baselayers

Установите это в false, чтобы отключить загрузку других пользовательских базовых карт и скрыть их в интерфейсе Grafana. По умолчанию true.

[rbac]

Дополнительную информацию см. в разделе Управление доступом на основе ролей.

plugins_cleanup

Список ID плагинов, разделённых запятыми, данные RBAC которых (роли, разрешения и начальные назначения) будут удалены из базы данных при запуске. Используйте это для очистки оставшихся данных от плагинов, которые были удалены или переименованы.

Очистка выполняется один раз при запуске и не делает ничего, когда список пуст.

ini 
# Example
plugins_cleanup = grafana-slo-app, grafana-irm-app

Переместить плагин приложения (указанный по его id), включая все его страницы, в определённый раздел навигации. Формат: <pluginId> = <sectionId> <sortWeight>

Переместить отдельную страницу плагина приложения (указанную по её полю path) в определённый раздел навигации. Формат: <pageUrl> = <sectionId> <sortWeight>

[public_dashboards]

Этот раздел настраивает функцию общих дашбордов.

enabled

Установите это в false, чтобы отключить функцию общих дашбордов. Это не позволяет пользователям создавать новые общие дашборды и отключает существующие.