配置 Grafana
您可以使用 Grafana Cloud 来避免安装、维护和扩展您自己的 Grafana 实例。 创建免费帐户 立即开始使用,其中包括永久免费访问 10k 个指标、50GB 日志、50GB 追踪、500VUh k6 测试等。
Grafana 具有默认和自定义配置文件。您可以通过修改自定义配置文件或使用环境变量来自定义 Grafana 实例。要查看 Grafana 实例的设置列表,请参阅 查看服务器设置.
注意
添加自定义选项后, 取消注释 配置文件中的相关部分。重新启动 Grafana 使更改生效。
配置文件位置
Grafana 实例的默认设置存储在 $WORKING_DIR/conf/defaults.ini
文件中。不要更改此文件。
根据您的操作系统,您的自定义配置文件是 $WORKING_DIR/conf/custom.ini
文件或 /usr/local/etc/grafana/grafana.ini
文件。可以使用 --config
参数覆盖自定义配置文件路径。
Linux
如果您使用 deb
或 rpm
包安装了 Grafana,那么您的配置文件位于 /etc/grafana/grafana.ini
,并且不会使用单独的 custom.ini
。此路径在 Grafana init.d 脚本中使用 --config
文件参数指定。
Docker
有关环境变量、持久存储和构建自定义 Docker 镜像的信息,请参阅 配置 Grafana Docker 镜像.
Windows
在 Windows 上,sample.ini
文件位于与 defaults.ini
文件相同的目录中。它包含所有被注释掉的设置。复制 sample.ini
并将其命名为 custom.ini
。
macOS
默认情况下,配置文件位于 /usr/local/etc/grafana/grafana.ini
。对于使用 Homebrew 安装的 Grafana 实例,直接编辑 grafana.ini
文件。否则,将名为 custom.ini
的配置文件添加到 conf
文件夹中,以覆盖 conf/defaults.ini
中定义的设置。
在 .ini 文件中删除注释
Grafana 使用分号 (;
字符) 在 .ini
文件中注释掉行。您必须通过从要修改的 custom.ini
或 grafana.ini
文件行的开头删除 ;
来取消注释每行。否则您的更改将被忽略。
例如
# The HTTP port to use
;http_port = 3000
使用环境变量覆盖配置
不要使用环境变量来添加新的配置设置。相反,使用环境变量来覆盖现有选项。
要覆盖选项
GF_<SectionName>_<KeyName>
其中,部分名称是方括号中的文本。所有内容都应为大写,.
和 -
应替换为 _
。例如,如果您有以下配置设置
# 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]
enable = newNavigation
您可以在 Linux 机器上使用以下命令覆盖变量:
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_ENABLE=newNavigation
变量扩展
注意
仅在 Grafana 7.1+ 中可用。
如果您的任何选项包含表达式 $__<provider>{<argument>}
或 ${<environment variable>}
,那么它们将由 Grafana 的变量扩展器处理。扩展器使用提供的参数运行提供程序,以获取选项的最终值。
有三个提供程序:env
、file
和 vault
。
Env 提供程序
env
提供程序可用于扩展环境变量。如果您将选项设置为 $__env{PORT}
,则将使用 PORT
环境变量代替。对于环境变量,您也可以使用简写语法 ${PORT}
。在以下示例中,Grafana 的日志目录将设置为 LOGDIR
环境变量后面的目录中的 grafana
目录。
[paths]
logs = $__env{LOGDIR}/grafana
文件提供程序
file
从文件系统读取文件。它会修剪文件开头和结尾的空白字符。在以下示例中,数据库密码将替换为 /etc/secrets/gf_sql_password
文件的内容
[database]
password = $__file{/etc/secrets/gf_sql_password}
Vault 提供程序
vault
提供程序允许您使用 Hashicorp Vault 管理您的机密信息。
Vault 提供程序仅在 Grafana Enterprise v7.1+ 中可用。有关更多信息,请参阅 Grafana Enterprise 中的 Vault 集成。
app_mode
选项为 production
和 development
。默认值为 production
。不要更改此选项,除非您正在进行 Grafana 开发。
instance_name
设置 grafana-server 实例的名称。用于日志记录、内部指标和集群信息。默认为:${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 服务文件中的命令行指定。您可以在配置文件或默认环境变量文件中覆盖它。但是,请注意,通过覆盖它,默认日志路径将暂时使用,直到 Grafana 完全初始化/启动。
使用命令行参数 cfg:default.paths.logs
覆盖日志路径。
./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
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,您需要 either give the Grafana binary permission for example
$ sudo setcap 'cap_net_bind_service=+ep' /usr/sbin/grafana-server
或者使用以下方法将端口 80 重定向到 Grafana 端口
$ sudo iptables -t nat -A PREROUTING -p tcp --dport 80 -j REDIRECT --to-port 3000
另一种方法是在 Grafana 前面放置一个 Web 服务器(如 Nginx 或 Apache),并让它们将请求代理到 Grafana。
domain
此设置仅用作 root_url
设置的一部分(见下文)。如果您使用 GitHub 或 Google OAuth,这一点很重要。
enforce_domain
如果主机头与域不匹配,则重定向到正确的域。防止 DNS 绑定攻击。默认值为 false
。
root_url
这是从 Web 浏览器访问 Grafana 使用的完整 URL。如果您使用 Google 或 GitHub OAuth 身份验证,这一点很重要(为了使回调 URL 正确)。
注意
如果您在 Grafana 前面有一个反向代理,它通过子路径公开 Grafana,那么此设置也很重要。在这种情况下,将子路径添加到此 URL 设置的末尾。
serve_from_sub_path
从 root_url
设置中指定的子路径提供 Grafana。默认情况下,出于兼容性原因,它被设置为 false
。
通过启用此设置并在 root_url
中使用子路径,例如root_url = https://127.0.0.1:3000/grafana
,可以在 https://127.0.0.1:3000/grafana
上访问 Grafana。如果在没有子路径的情况下访问,Grafana 将重定向到带有子路径的 URL。
router_logging
设置为 true
使 Grafana 记录所有 HTTP 请求(不仅仅是错误)。这些日志作为 Info 级别事件记录到 Grafana 日志中。
static_root_path
前端文件(HTML、JS 和 CSS 文件)所在目录的路径。默认为 public
,这就是为什么 Grafana 二进制文件需要使用设置为安装路径的工作目录来执行。
enable_gzip
将此选项设置为 true
以启用 HTTP 压缩,这可以提高传输速度和带宽利用率。建议大多数用户将其设置为 true
。默认情况下,出于兼容性原因,它被设置为 false
。
cert_file
证书文件的路径(如果 protocol
设置为 https
或 h2
)。
cert_key
证书密钥文件的路径(如果 protocol
设置为 https
或 h2
)。
certs_watch_interval
控制是否定期监视 cert_key
和 cert_file
以查看是否有更改。默认情况下禁用。启用后,会监视 cert_key
和 cert_file
以查看是否有更改。如果有更改,新证书将自动加载。
警告
加载新证书后,使用旧证书的连接将无法工作。您必须重新加载对旧证书的连接,才能使其正常工作。
socket_gid
当 protocol=socket
时,应将套接字设置为的 GID。确保目标组位于 Grafana 进程的组中,并且 Grafana 进程是文件所有者,然后再更改此设置。建议将 gid 设置为 http 服务器用户的 gid。当值为 -1 时不设置。
socket_mode
当 protocol=socket
时,应将套接字设置为的模式。确保 Grafana 进程是文件所有者,然后再更改此设置。
socket
当 protocol=socket
时,应创建套接字的路径。确保 Grafana 具有该路径的适当权限,然后再更改此设置。
cdn_url
注意
在 Grafana v7.4 及更高版本中可用。
指定指向 Grafana CDN 资产根目录的完整 HTTP URL 地址。Grafana 将添加版本和版本路径。
例如,给定一个像 https://cdn.myserver.com
这样的 cdn url,grafana 将尝试从 http://cdn.myserver.com/grafana-oss/7.4.0/public/build/app.<hash>.js
加载 javascript 文件。
read_timeout
设置使用持续时间格式(5s/5m/5ms)在超时读取传入请求和关闭空闲连接之前的时间。0
表示读取请求没有超时。
[server.custom_response_headers]
此设置使您可以指定服务器添加到 HTTP(S) 响应的附加标头。
exampleHeader1 = exampleValue1
exampleHeader2 = exampleValue2
[database]
Grafana 需要一个数据库来存储用户和仪表板(以及其他内容)。默认情况下,它配置为使用 sqlite3
,这是一个嵌入式数据库(包含在 Grafana 主二进制文件中)。
type
可以是 mysql
、postgres
或 sqlite3
,由您选择。
host
仅适用于 MySQL 或 Postgres。包括 IP 或主机名和端口,或者在 Unix 套接字的情况下,包括指向它的路径。例如,对于在与 Grafana 相同主机上运行的 MySQL:host = 127.0.0.1:3306
或使用 Unix 套接字:host = /var/run/mysqld/mysqld.sock
name
Grafana 数据库的名称。将其保留为 grafana
或其他名称。
user
数据库用户(不适用于 sqlite3
)。
password
数据库用户的密码(不适用于 sqlite3
)。如果密码包含 #
或 ;
,则必须用三引号将其括起来。例如 """#password;"""
url
使用 URL 或以下其他字段配置数据库示例:mysql://user:secret@host:port/database
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,使用任何 有效的 libpq sslmode
,例如 disable
、require
、verify-full
等。对于 MySQL,使用 true
、false
或 skip-verify
。
ssl_sni
对于 Postgres,设置为 0
以禁用 服务器名称指示。默认情况下,在启用了 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
mysql
或 postgres
服务器使用的证书的通用名称字段。如果 ssl_mode
设置为 skip-verify
,则不需要。
path
仅适用于 sqlite3
数据库。数据库将存储在其中的文件路径。
cache_mode
仅适用于 “sqlite3”。用于连接到数据库的 共享缓存 设置。(private、shared)默认为 private
。
wal
仅适用于 “sqlite3”。设置以启用/禁用 预写日志。默认值为 false
(禁用)。
query_retries
此设置仅适用于 sqlite
,并控制当数据库被锁定时系统重试查询的次数。默认值为 0
(禁用)。
transaction_retries
此设置仅适用于 sqlite
,并控制当数据库被锁定时系统重试事务的次数。默认值为 5
。
instrument_queries
设置为 true
以为数据库查询添加指标和跟踪。默认值为 false
。
[remote_cache]
在配置的数据库、Redis 或 Memcached 中缓存身份验证详细信息和会话信息。此设置不配置 Grafana Enterprise 中的查询缓存。
type
可以是 redis
、memcached
或 database
。默认为 database
connstr
远程缓存连接字符串。格式取决于远程缓存的 type
。选项为 database
、redis
和 memcache
。
database
使用 database
时保留为空,因为它将使用主数据库。
redis
示例连接字符串:addr=127.0.0.1:6379,pool_size=100,db=0,ssl=false
addr
是 Redis 服务器的 host:
port。pool_size
(可选)是可建立到 Redis 的底层连接数量。db
(可选)是要使用的 Redis 数据库的数字标识符。ssl
(可选)指示是否应使用 SSL 连接到 Redis 服务器。值可以是true
、false
或insecure
。将值设置为insecure
将跳过在建立连接时对证书链和主机名的验证。
memcache
示例连接字符串:127.0.0.1:11211
[dataproxy]
logging
启用数据代理日志记录,默认值为 false
。
timeout
数据代理在超时前应等待的时间。默认值为 30 秒。
此设置也适用于核心后端 HTTP 数据源,其中查询请求使用设置了超时的 HTTP 客户端。
keep_alive_seconds
两次保持活动探测之间的间隔。默认值为 30
秒。有关更多详细信息,请查看 Dialer.KeepAlive 文档。
tls_handshake_timeout_seconds
Grafana 等待与数据源成功进行 TLS 握手的时间长度。默认值为 10
秒。有关更多详细信息,请查看 Transport.TLSHandshakeTimeout 文档。
expect_continue_timeout_seconds
如果请求具有“Expect: 100-continue”标头,Grafana 等待数据源在完全写入请求标头后接收第一个响应标头的时间长度。值为 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
限制将从传出 HTTP 请求的响应中读取/接受的字节数。默认值为 0
,表示已禁用。
row_limit
限制 Grafana 从 SQL(关系型)数据源处理的行数。默认值为 1000000
。
user_agent
为传出数据代理请求设置 User-Agent
标头的自定义值。如果为空,则默认值为 Grafana/<BuildVersion>
(例如 Grafana/9.0.0
)。
[analytics]
enabled
此选项也称为使用情况分析。当为 false
时,此选项将禁用写入 Grafana 数据库的写入器以及相关的功能,例如仪表板和数据源洞察、存在指示器和高级仪表板搜索。默认值为 true
。
reporting_enabled
启用后,Grafana 将向 stats.grafana.org
发送匿名使用情况统计信息。不会跟踪任何 IP 地址,只跟踪简单的计数器以跟踪运行实例、版本、仪表板和错误计数。这对我们非常有帮助,因此请保持启用。计数器每 24 小时发送一次。默认值为 true
。
check_for_updates
设置为 false,禁用从 Grafana 的 GitHub 存储库检查 Grafana 的新版本。启用后,检查新版本每 10 分钟运行一次。它将在有新版本可用时通过 UI 通知。检查本身不会提示任何 Grafana 软件的自动更新,也不会发送任何敏感信息。
check_for_plugin_updates
注意
在 Grafana v8.5.0 及更高版本中可用。
设置为 false 将禁用从 https://grafana.org.cn 检查已安装插件的新版本。启用后,检查新插件每 10 分钟运行一次。它将在有新插件更新可用时通过 UI 通知。检查本身不会提示任何插件的自动更新,也不会发送任何敏感信息。
google_analytics_ua_id
如果你想通过 Google Analytics 跟踪 Grafana 的使用情况,请在此处指定你的通用分析 ID。默认情况下,此功能已禁用。
google_analytics_4_id
如果你想通过 Google Analytics 4 跟踪 Grafana 的使用情况,请在此处指定你的 GA4 ID。默认情况下,此功能已禁用。
google_tag_manager_id
Google Tag Manager ID,仅在你在此处输入 ID 时才启用。
rudderstack_write_key
如果你想通过 Rudderstack 跟踪 Grafana 的使用情况,请在此处指定你的Rudderstack 写入密钥。要启用此功能,还必须提供 rudderstack_data_plane_url
。默认情况下,此功能已禁用。
rudderstack_data_plane_url
将接收 Rudderstack 事件的 Rudderstack 数据平面 URL。要启用此功能,还必须提供 rudderstack_write_key
。
rudderstack_sdk_url
可选。如果启用了使用 Rudderstack 进行跟踪,则可以提供自定义 URL 来加载 Rudderstack SDK。
rudderstack_config_url
可选。如果启用了使用 Rudderstack 进行跟踪,则可以提供自定义 URL 来加载 Rudderstack 配置。
rudderstack_integrations_url
可选。如果启用了使用 Rudderstack 进行跟踪,则可以提供自定义 URL 来加载设备模式下运行的目标的 SDK。此设置仅对 Rudderstack 版本 1.1 及更高版本有效。
application_insights_connection_string
如果你想通过 Azure Application Insights 跟踪 Grafana 的使用情况,请指定你的Application Insights 连接字符串。由于连接字符串包含分号,因此你需要用反引号(`)将其括起来。默认情况下,跟踪使用情况已禁用。
application_insights_endpoint_url
可选,使用此选项覆盖 Application Insights 数据收集的默认端点地址。有关详细信息,请参阅 Azure 文档。
feedback_links_enabled
设置为 false
以从 UI 中删除所有反馈链接。默认值为 true
。
[security]
disable_initial_admin_creation
仅在 Grafana v6.5+ 中可用。
禁用在 Grafana 首次启动时创建管理员用户。默认值为 false
。
admin_user
默认 Grafana 管理员用户的名称,该用户具有完全权限。默认值为 admin
。
admin_password
默认 Grafana 管理员的密码。在首次运行时设置一次。默认值为 admin
。
admin_email
默认 Grafana 管理员的电子邮件地址,在启动时创建。默认值为 admin@localhost
。
secret_key
用于对某些数据源设置(如机密和密码)进行签名,使用的加密格式为 CFB 模式下的 AES-256。无法更改,除非需要更新数据源设置以重新对其进行编码。
disable_gravatar
设置为 true
以禁用使用 Gravatar 作为用户资料图片。默认值为 false
。
data_source_proxy_whitelist
定义允许的 IP 地址或域名的白名单,以及端口,这些地址或域名将用于包含 Grafana 数据源代理的数据源 URL。格式:ip_or_domain:port
,以空格分隔。PostgreSQL、MySQL 和 MSSQL 数据源不使用代理,因此不受此设置的影响。
disable_brute_force_login_protection
设置为 true
以禁用 暴力破解登录保护。默认值为 false
。现有用户的帐户将在 5 分钟内尝试 5 次后被锁定。
cookie_secure
如果你在 HTTPS 后面托管 Grafana,则设置为 true
。默认值为 false
。
cookie_samesite
设置 SameSite
cookie 属性,并阻止浏览器将此 cookie 与跨站点请求一起发送。主要目标是降低跨源信息泄露的风险。此设置还提供了一些针对跨站点请求伪造攻击(CSRF)的保护措施,在此处阅读有关 SameSite 的更多信息。有效值为 lax
、strict
、none
和 disabled
。默认值为 lax
。使用值 disabled
不会向 cookie 添加任何 SameSite
属性。
allow_embedding
当为 false
时,HTTP 标头 X-Frame-Options: deny
将在 Grafana HTTP 响应中设置,这将指示浏览器不要允许在 <frame>
、<iframe>
、<embed>
或 <object>
中呈现 Grafana。主要目标是降低 Clickjacking 的风险。默认值为 false
。
strict_transport_security
如果你想启用 HTTP Strict-Transport-Security
(HSTS) 响应标头,则设置为 true
。仅在你的配置中启用了 HTTPS 时,或当有另一个上游系统确保你的应用程序使用 HTTPS(如前端负载均衡器)时使用。HSTS 告诉浏览器该站点只能使用 HTTPS 访问。
strict_transport_security_max_age_seconds
设置浏览器应缓存 HSTS 的时间(以秒为单位)。仅在 strict_transport_security 启用时应用。默认值为 86400
。
strict_transport_security_preload
设置为 true
以启用 HSTS 预加载
选项。仅在 strict_transport_security 启用时应用。默认值为 false
。
strict_transport_security_subdomains
设置为 true
以启用 HSTS includeSubDomains 选项。仅在 strict_transport_security 启用时应用。默认值为 false
。
x_content_type_options
设置为 false
以禁用 X-Content-Type-Options 响应标头。X-Content-Type-Options 响应 HTTP 标头是服务器使用的标记,用于指示 Content-Type 标头中通告的 MIME 类型不应更改,应予以遵循。默认值为 true
。
x_xss_protection
设置为 false
以禁用 X-XSS-Protection 标头,该标头告诉浏览器在检测到反射型跨站点脚本(XSS)攻击时停止页面加载。默认值为 true
。
content_security_policy
设置为 true
以将 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 使你能够通过监控政策的影响来试验政策,而不会强制执行它们。你可以同时启用两种政策。
content_security_policy_template
设置用于在向请求添加Content-Security-Policy-Report-Only
标头的策略模板。模板中的$NONCE
包含一个随机的 nonce。
angular_support_enabled
默认情况下,此项设置为 false,表示不会加载 Angular 框架和支持组件。这意味着所有依赖 Angular 支持的插件和核心功能将停止工作。
依赖 Angular 的核心功能包括
- 旧的图形面板
- 旧的表格面板
这些功能都有支持的替代方案,我们建议使用它们。
csrf_trusted_origins
通过 CSRF 检查的额外允许 URL 列表。建议在身份验证来自 IdP 时使用。
csrf_additional_headers
用户允许设置的标头列表。建议在身份验证位于反向代理之后时使用。
csrf_always_check
设置为true
以执行 CSRF 检查,即使请求中没有登录 cookie(默认值为false
)。
disable_frontend_sandbox_for_plugins
不会在前端沙箱中加载的插件 ID 的逗号分隔列表。建议仅对已知在前端沙箱中运行有问题的插件使用此选项。
[快照]
enabled
设置为false
以禁用快照功能(默认值为true
)。
external_enabled
设置为false
以禁用外部快照发布端点(默认值为true
)。
external_snapshot_url
将根 URL 设置为要发布外部快照的 Grafana 实例(默认为https://snapshots.raintank.io)。
external_snapshot_name
为外部快照按钮设置名称。默认为发布到 snapshots.raintank.io
。
public_mode
设置为 true 以使此 Grafana 实例充当外部快照服务器,并允许对创建和删除快照的未经身份验证的请求。默认值为false
。
[仪表盘]
versions_to_keep
要保留的仪表盘版本数量(每个仪表盘)。默认值:20
,最小值:1
。
min_refresh_interval
仅在 Grafana v6.7+ 中可用。
此功能可以防止用户将仪表盘刷新间隔设置为低于给定间隔值的间隔值。默认间隔值为 5 秒。间隔字符串是一个可能带符号的十进制数字序列,后跟一个单位后缀(ms、s、m、h、d),例如30s
或1m
。
从 Grafana v7.3 开始,这也限制了 Explore 中的刷新间隔选项。
default_home_dashboard_path
默认主页仪表盘的路径。如果此值为空,则 Grafana 使用 StaticRootPath + “dashboards/home.json”。
注意
在 Linux 上,Grafana 使用/usr/share/grafana/public/dashboards/home.json
作为默认主页仪表盘位置。
[SQL 数据源]
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)。数据源设置中配置的值将优先于默认值。
[用户]
allow_sign_up
设置为false
以禁止用户注册/创建用户帐户。默认值为false
。管理员用户仍然可以创建用户。有关创建用户的更多信息,请参阅添加用户。
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
设置默认 UI 主题:dark
、light
或system
。默认主题为dark
。
system
与用户的系统主题匹配。
default_language
如果支持的 IETF 语言标签(如en-US
)可用,此选项将设置默认 UI 语言。如果设置为detect
,默认 UI 语言将由浏览器首选项决定。默认值为en-US
。
home_page
自定义主页的路径。仅当使用默认主页仪表盘时,用户才会被重定向到此页面。它应该与前端路由匹配,并包含一个前导斜杠。
外部用户管理
如果您在外部管理用户,可以使用指向外部网站的链接以及描述来替换组织的用户邀请按钮。
viewers_can_edit
查看者可以访问和使用Explore,并在他们有权访问的仪表盘中对面板进行临时编辑。他们无法保存他们的更改。默认值为false
。
editors_can_admin
编辑者可以管理他们创建的仪表盘、文件夹和团队。默认值为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 UI 中隐藏。他们对 Grafana 管理员和他们自己仍然可见。
[身份验证]
Grafana 提供了许多身份验证用户的方法。有关如何设置和配置身份验证的详细说明,请参阅 Grafana 的身份验证概述和其他身份验证文档。
login_cookie_name
用于存储身份验证令牌的 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 时很有用。默认值为 false。
disable_signout_menu
设置为true
以禁用侧边菜单中的注销链接。这在您使用 auth.proxy 时很有用。默认值为false
。
signout_redirect_url
用户注销后被重定向到的 URL。为了支持OpenID Connect RP-Initiated Logout,用户必须将post_logout_redirect_uri
添加到signout_redirect_url
中。
示例
signout_redirect_url = https://127.0.0.1:8087/realms/grafana/protocol/openid-connect/logout?post_logout_redirect_uri=http%3A%2F%2Flocalhost%3A3000%2Flogin
oauth_auto_login
注意
此选项已弃用 - 请使用特定 OAuth 提供程序的auto_login
选项。
设置为true
以尝试使用 OAuth 自动登录,跳过登录屏幕。如果配置了多个 OAuth 提供程序,则此设置会被忽略。默认值为false
。
oauth_state_cookie_max_age
OAuth 状态 cookie 在被删除之前存活多少秒。默认值为600
(秒)管理员可以增加此值,如果他们遇到 OAuth 登录状态不匹配错误。
oauth_skip_org_role_update_sync
注意
此选项已从 G11 中删除,取而代之的是 OAuth 提供程序特定的skip_org_role_sync
设置。以下部分解释了每个提供程序的设置。
如果您想将oauth_skip_org_role_update_sync
设置从true
更改为false
,则为每个设置的提供程序,使用skip_org_role_sync
设置来指定是否要跳过同步。
警告
目前,如果找不到用户的组织角色映射,Grafana 不会更新用户的组织角色。在 Grafana 10 中,如果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
。
注意:启用
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 | 生成的 Org 角色 | 可修改 |
---|---|---|---|
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 | 生成的 Org 角色 | 可修改 |
---|---|---|---|
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 | 生成的 Org 角色 | 可修改 |
---|---|---|---|
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 |
注意
对于 GitLab、GitHub、Okta、通用 OAuth 提供商,Grafana 会同步组织角色并设置 Grafana 管理员。allow_assign_grafana_admin
设置也会被考虑,以允许或不允许从外部提供商设置 Grafana 管理员角色。
[auth.github]
oauth_skip_org_role_update_sync | skip_org_role_sync | 生成的 Org 角色 | 可修改 |
---|---|---|---|
false | false | 将用户组织角色与 GitHub 角色同步。如果未提供角色,则设置为 auto_assign_org_role 。 | false |
true | false | 跳过所有 OAuth 提供商用户的组织角色同步。角色设置为 auto_assign_org_role 。 | true |
false | true | 跳过 GitHub 用户的组织角色和 Grafana 管理员同步。角色设置为 auto_assign_org_role 。 | true |
true | true | 跳过所有 OAuth 提供商的组织角色同步,并跳过 GitHub 用户的 Grafana 管理员同步。角色设置为 auto_assign_org_role 。 | true |
[auth.gitlab]
oauth_skip_org_role_update_sync | skip_org_role_sync | 生成的 Org 角色 | 可修改 |
---|---|---|---|
false | false | 将用户组织角色与 Gitlab 角色同步。如果未提供角色,则设置为 auto_assign_org_role 。 | false |
true | false | 跳过所有 OAuth 提供商用户的组织角色同步。角色设置为 auto_assign_org_role 。 | true |
false | true | 跳过 Gitlab 用户的组织角色和 Grafana 管理员同步。角色设置为 auto_assign_org_role 。 | true |
true | true | 跳过所有 OAuth 提供商的组织角色同步,并跳过 Gitlab 用户的 Grafana 管理员同步。角色设置为 auto_assign_org_role 。 | true |
[auth.generic_oauth]
oauth_skip_org_role_update_sync | skip_org_role_sync | 生成的 Org 角色 | 可修改 |
---|---|---|---|
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 | 生成的 Org 角色 | 可修改 |
---|---|---|---|
false | false | 将用户组织角色与 Okta 角色同步。如果未提供角色,则设置为 auto_assign_org_role 。 | false |
true | false | 跳过所有 OAuth 提供商用户的组织角色同步。角色设置为 auto_assign_org_role 。 | true |
false | true | 跳过 Okta 用户的组织角色和 Grafana 管理员同步。角色设置为 auto_assign_org_role 。 | true |
true | true | 跳过所有 OAuth 提供商的组织角色同步,并跳过 Okta 用户的 Grafana 管理员同步。角色设置为 auto_assign_org_role 。 | true |
示例 skip_org_role_sync
[auth.google]
oauth_skip_org_role_update_sync | skip_org_role_sync | 生成的 Org 角色 | 示例场景 |
---|---|---|---|
false | false | 与 Google Auth 组织角色同步 | 用户使用其 Google 帐户登录 Grafana,其组织角色会根据他们在 Google 中的角色自动设置。 |
true | false | 跳过所有 OAuth 提供商的组织角色同步 | 用户使用其 Google 帐户登录 Grafana,其组织角色不会根据其角色设置。但 Grafana 管理员可以从 UI 修改角色。 |
false | true | 跳过 Google 的组织角色同步 | 用户使用其 Google 帐户登录 Grafana,其组织角色不会根据其在 Google 中的角色设置。但 Grafana 管理员可以从 UI 修改角色。 |
true | true | 跳过所有 OAuth 提供商(包括 Google)的组织角色同步 | 用户使用其 Google 帐户登录 Grafana,其组织角色不会根据其在 Google 中的角色设置。但 Grafana 管理员可以从 UI 修改角色。 |
api_key_max_seconds_to_live
API 密钥在过期之前生存的秒数限制。默认值为 -1(无限)。
sigv4_auth_enabled
仅在 Grafana 7.3+ 中可用。
设置为 true
以启用基于 HTTP 的数据源的 AWS 签名版本 4 身份验证选项。默认值为 false
。
sigv4_verbose_logging
仅在 Grafana 8.4+ 中可用。
设置为 true
以在启用 AWS 签名版本 4 身份验证时启用详细的请求签名记录。默认值为 false
。
[auth.anonymous]
有关详细说明,请参阅 匿名身份验证。
[auth.github]
有关详细说明,请参阅 GitHub OAuth2 身份验证。
[auth.gitlab]
有关详细说明,请参阅 Gitlab OAuth2 身份验证。
[auth.google]
有关详细说明,请参阅 Google OAuth2 身份验证。
[auth.grafananet]
旧的密钥名称,仍在配置文件中,以便它们在环境变量中工作。
[auth.grafana_com]
旧的密钥名称,仍在配置文件中,以便它们在环境变量中工作。
[auth.azuread]
有关详细说明,请参阅 Azure AD OAuth2 身份验证。
[auth.okta]
有关详细说明,请参阅 Okta OAuth2 身份验证。
[auth.generic_oauth]
有关详细说明,请参阅 通用 OAuth 身份验证。
[auth.basic]
有关详细说明,请参阅 基本身份验证。
[auth.proxy]
有关详细说明,请参阅 身份验证代理身份验证。
[auth.ldap]
有关详细说明,请参阅 LDAP 身份验证。
[aws]
您可以配置核心和外部 AWS 插件。
allowed_auth_providers
指定 AWS 插件允许哪些身份验证提供商。有关允许提供商的列表,请参阅给定插件的数据源配置页面。如果您通过配置插件来进行配置,则仅允许在 allowed_auth_providers
中指定的提供商。
选项:default
(AWS SDK 默认值)、keys
(访问和密钥)、credentials
(凭据文件)、ec2_iam_role
(EC2 IAM 角色)
assume_role_enabled
设置为 false
以禁用 AWS 身份验证使用具有临时安全凭据的假定角色。有关假定角色的详细信息,请参阅 AWS API 参考文档关于 AssumeRole 操作的内容。
如果此选项被禁用,则假定角色和外部 ID 字段将从 AWS 数据源配置页面中删除。如果使用配置来配置插件,则只要将 assume_role_enabled
设置为 true
,就可以使用假定角色。
list_metrics_page_limit
使用 List Metrics API 选项加载 CloudWatch 数据源中自定义命名空间的指标。默认情况下,页面限制为 500。
[azure]
当托管在 Azure 云中时,Grafana 支持与 Azure 服务的额外集成。
cloud
托管 Grafana 的 Azure 云环境
Azure 云 | 值 |
---|---|
Microsoft Azure 公共云 | AzureCloud(默认) |
Microsoft 中国国家云 | AzureChinaCloud |
美国政府云 | AzureUSGovernment |
Microsoft 德国国家云(“黑森林”) | AzureGermanCloud |
clouds_config
JSON 配置定义托管在自定义 Azure 环境中的 Azure 云及其关联的属性列表。
例如
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
指定是否在配置了托管身份的 Azure 服务中托管的 Grafana(例如,Azure 虚拟机实例)。默认情况下禁用,需要显式启用。
managed_identity_client_id
用于用户分配的托管身份的客户端 ID。
应为用户分配的身份设置,并且应为空以用于系统分配的身份。
workload_identity_enabled
指定是否应在支持它的数据源中启用 Azure AD 工作负载身份验证。
有关 Azure AD 工作负载身份的更多文档,请查看 Azure AD 工作负载身份 文档。
默认情况下禁用,需要显式启用。
workload_identity_tenant_id
Azure AD 工作负载身份的租户 ID。
允许覆盖与 Kubernetes 服务帐户关联的 Azure AD 身份的默认租户 ID。
workload_identity_client_id
Azure AD 工作负载身份的客户端 ID。
允许覆盖与 Kubernetes 服务帐户关联的 Azure AD 身份的默认客户端 ID。
workload_identity_token_file
Azure AD 工作负载身份的令牌文件自定义路径。
允许设置投影服务帐户令牌文件的自定义路径。
user_identity_enabled
指定是否应在支持它的数据源中启用用户身份验证(代表当前登录的用户)(需要 AAD 身份验证)。
默认情况下禁用,需要显式启用。
user_identity_fallback_credentials_enabled
指定是否应在数据源中启用用户身份验证回退凭据。启用此功能允许数据源创建者为后端发起的请求(例如,警报、记录的查询等)提供回退凭据。
默认情况下启用,需要显式禁用。如果用户身份验证被禁用,则它将没有任何影响。
user_identity_token_url
覆盖 Azure Active Directory 的令牌 URL。
默认情况下与为 AAD 身份验证设置配置的令牌 URL 相同。
user_identity_client_id
覆盖将用于将用户令牌交换为数据源的访问令牌的 ADD 应用程序 ID。
默认情况下与 AAD 身份验证中使用的相同,或者可以设置为另一个应用程序(用于 OBO 流程)。
user_identity_client_secret
覆盖 AAD 应用程序客户端密钥。
默认情况下与 AAD 身份验证中使用的相同,或者可以设置为另一个应用程序(用于 OBO 流程)。
forward_settings_to_plugins
设置将通过插件上下文接收 Azure 设置的插件。
默认情况下,这将包括所有 Grafana Labs 拥有的 Azure 插件或使用 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
。对于隐式 TLS,请使用端口 465。
user
在 SMTP 身份验证的情况下,默认值为 empty
。
password
在 SMTP 身份验证的情况下,默认值为 empty
。如果密码包含 #
或 ;
,则必须用三个引号将其括起来。例如:“”"#password;"""
cert_file
证书文件的路径,默认值为 empty
。
key_file
密钥文件的路径,默认值为 empty
。
skip_verify
验证 SMTP 服务器的 SSL,默认值为 false
。
from_address
发送电子邮件时使用的地址,默认值为 [email protected]
。
from_name
发送电子邮件时使用的名称,默认值为 Grafana
。
ehlo_identity
在 SMTP 对话中用作客户端身份的名称,默认值为 <instance_name>
。
startTLS_policy
可以是“OpportunisticStartTLS”、“MandatoryStartTLS”、“NoStartTLS”。默认值为 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”。默认值为info
。
filters
可选设置,用于为特定记录器设置不同的级别。例如:filters = sqlstore:debug
user_facing_default_error
使用此配置选项来设置显示给用户的默认错误消息。此消息将显示在敏感后端错误(应被混淆)代替。默认消息为Please inspect the Grafana server log for details.
。
[log.console]
仅在[log]
模式中使用“console”时适用。
level
选项包括“debug”、“info”、“warn”、“error”和“critical”。默认值从[log]
级别继承。
format
日志行格式,有效选项包括 text、console 和 json。默认值为console
。
[log.file]
仅在[log]
模式中使用“file”时适用。
level
选项包括“debug”、“info”、“warn”、“error”和“critical”。默认值从[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
选项包括“debug”、“info”、“warn”、“error”和“critical”。默认值从[log]
级别继承。
format
日志行格式,有效选项包括 text、console 和 json。默认值为text
。
network and address
Syslog 网络类型和地址。可以是 UDP、TCP 或 UNIX。如果留空,则使用默认的 UNIX 端点。
facility
Syslog 设施。有效选项包括 user、daemon 或 local0 到 local7。默认值为空。
tag
Syslog 标签。默认情况下,使用进程的argv[0]
。
[log.frontend]
注意:此功能在 Grafana 7.4+ 中可用。
enabled
Faro javascript 代理已初始化。默认值为false
。
custom_endpoint
用于将 Faro 代理捕获的事件发送到的自定义 HTTP 端点。默认情况下,/log-grafana-javascript-agent
将将事件记录到标准输出。
log_endpoint_requests_per_second_limit
对 Grafana 后端日志提取端点/log-grafana-javascript-agent
强制执行的每秒请求限制,在扩展期间有效。默认值为3
。
log_endpoint_burst_limit
对 Grafana 后端日志提取端点/log-grafana-javascript-agent
在短时间内接受的最大请求数。默认值为15
。
instrumentations_errors_enabled
启用错误检测。仅影响 Grafana Javascript 代理。
instrumentations_console_enabled
启用控制台检测。仅影响 Grafana Javascript 代理
instrumentations_webvitals_enabled
启用 Web Vitals 检测。仅影响 Grafana Javascript 代理
instrumentations_tracing_enabled
启用跟踪检测。仅影响 Grafana Javascript 代理。
api_key
如果custom_endpoint
需要身份验证,则可以在此处设置 api 密钥。仅与 Grafana Javascript 代理提供程序相关。
[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 警报。
enabled
启用或禁用 Grafana 警报。默认值为true
。
从仪表盘和面板迁移的警报规则将包括一个通过annotations
返回的链接。
disabled_orgs
要禁用 Grafana 8 统一警报的组织 ID 的逗号分隔列表。
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。
ha_redis_address
要连接的 Redis 服务器地址。
注意
有关 Redis 的更多信息,请参阅使用 Redis 启用警报高可用性。
ha_redis_username
用于对 Redis 服务器进行身份验证的用户名。
ha_redis_password
用于对 Redis 服务器进行身份验证的密码。
ha_redis_db
Redis 数据库。默认值为0
。
ha_redis_prefix
用于在 Redis 服务器上创建的每个键或通道的前缀,作为警报的 HA 的一部分。
ha_redis_peer_name
将用作标识符的集群对等体的名称。如果没有提供,则会生成一个随机名称。
ha_redis_max_conns
同时 Redis 连接的最大数量。
ha_listen_address
用于接收其他 Grafana 实例的统一警报消息的监听 IP 地址和端口。该端口用于 TCP 和 UDP。假设其他 Grafana 实例也在相同的端口上运行。默认值为0.0.0.0:9094
。
ha_advertise_address
用于向其他 Grafana 实例通告的显式 IP 地址和端口。该端口用于 TCP 和 UDP。
ha_peers
将形成 HA 集群的初始实例(以 host:port 格式)的逗号分隔列表。配置此设置将启用警报的高可用性模式。
ha_peer_timeout
等待实例通过 Alertmanager 发送通知的时间。在 HA 中,每个 Grafana 实例将被分配一个位置(例如 0、1)。然后,我们将此位置乘以超时时间以指示每个实例在发送通知之前应等待多长时间,以考虑复制延迟。默认值为15s
。
间隔字符串是一个可能带符号的小数序列,后面跟着一个单位后缀(ms、s、m、h、d),例如 30s 或 1m。
ha_label
该标签是一个可选字符串,包含在每个数据包和流中。它唯一地标识集群,并在在具有多个集群的环境中发送八卦消息时防止交叉通信问题。
ha_gossip_interval
发送八卦消息之间的间隔。通过降低此值(更频繁),八卦消息会更快地传播到整个集群,但会增加带宽使用率。默认值为200ms
。
间隔字符串是一个可能带符号的小数序列,后面跟着一个单位后缀(ms、s、m、h、d),例如 30s 或 1m。
ha_reconnect_timeout
尝试重新连接到丢失的对等体的时长。在 Kubernetes 集群中运行 Grafana 时,将此持续时间设置为小于15m
。
该字符串是一个可能带符号的小数序列,后面跟着一个单位后缀(ms、s、m、h、d),例如30s
或1m
。
ha_push_pull_interval
八卦完整状态同步之间的间隔。将此间隔设置为更低(更频繁)将提高更大集群的收敛速度,但会增加带宽使用率。默认值为60s
。
间隔字符串是一个可能带符号的小数序列,后面跟着一个单位后缀(ms、s、m、h、d),例如 30s 或 1m。
execute_alerts
启用或禁用警报规则执行。默认值为true
。警报 UI 保持可见。
evaluation_timeout
在从数据源获取数据时设置警报评估超时时间。默认值为30s
。
超时字符串是一个可能带符号的小数序列,后面跟着一个单位后缀(ms、s、m、h、d),例如 30s 或 1m。
max_attempts
设置在放弃该评估之前尝试评估警报规则的最大次数。默认值为1
。
min_interval
设置规则评估之间强制执行的最小间隔。默认值为10s
,等于调度程序间隔。如果规则小于此值,或者不是调度程序间隔(10s)的倍数,则会调整规则。较高的值可以帮助资源管理,因为我们将随着时间的推移安排更少的评估。
间隔字符串是一个可能带符号的小数序列,后面跟着一个单位后缀(ms、s、m、h、d),例如 30s 或 1m。
注意。此设置优先于每个单独的规则频率。如果规则频率低于此值,则强制执行此值。
[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 警报中的标签
disabled_labels
由 Grafana 警报引擎添加的应禁用的保留标签的逗号分隔列表。
例如:disabled_labels=grafana_folder
[unified_alerting.state_history.annotations]
本节控制在配置警报状态历史记录后端为注释时(参见设置 [unified_alerting.state_history].backend)评估警报规则时自动创建的注释的保留。
max_age
配置警报注释存储的时间长度。默认值为 0,表示永久保存。此设置应表示为持续时间。例如 6h(小时)、10d(天)、2w(周)、1M(月)。
max_annotations_to_keep
配置 Grafana 存储的警报注释的最大数量。默认值为 0,表示保留所有警报注释。
[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
配置 Grafana 保留的 API 注释的最大数量。默认值为 0,表示保留所有 API 注释。
[explore]
有关此功能的更多信息,请参阅 Explore。
enabled
启用或禁用 Explore 部分。默认值为 enabled
。
defaultTimeOffset
在时间选择器上设置相对于当前时间的默认时间偏移量。默认值为 1 小时。此设置应表示为持续时间。例如:1h(小时)、1d(天)、1w(周)、1M(月)。
[help]
配置帮助部分。
enabled
启用或禁用帮助部分。默认值为 enabled
。
[profile]
配置个人资料部分。
enabled
启用或禁用个人资料部分。默认值为 enabled
。
[news]
news_feed_enabled
启用新闻提要部分。默认值为 true
[query]
concurrent_query_limit
设置在混合数据源面板中可以同时执行的查询数量。默认值为 CPU 数量。
[query_history]
配置 Explore 中的查询历史记录。
enabled
启用或禁用查询历史记录。默认值为 enabled
。
[short_links]
配置围绕短链接功能的设置。
expire_time
从未访问过的短链接被视为已过期或过时,并将被删除作为清理。设置过期时间(以天为单位)。默认值为 7
天。最大值为 365
天,设置超过最大值将设置为 365
。设置 0
表示短链接将在大约每 10 分钟清理一次。
[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 和 basic_auth_password
如果两者都设置,则需要基本身份验证才能访问指标端点。
[metrics.environment_info]
向 grafana_environment_info
指标添加维度,这可以公开有关 Grafana 实例的更多信息。
; exampleLabel1 = exampleValue1
; exampleLabel2 = exampleValue2
[metrics.graphite]
如果您想将内部 Grafana 指标发送到 Graphite,请使用这些选项。
address
通过设置地址启用。格式为 <主机名或 IP>
:port。
prefix
Graphite 指标前缀。默认为 prod.grafana.%(instance_name)s.
[grafana_net]
url
默认值为 https://grafana.org.cn。
[grafana_com]
url
默认值为 https://grafana.org.cn。
[tracing.jaeger]
[已弃用 - 请改用 tracing.opentelemetry.jaeger 或 tracing.opentelemetry.otlp]
配置 Grafana 的 Jaeger 客户端以进行分布式跟踪。
您还可以使用标准的 JAEGER_*
环境变量来配置 Jaeger。有关完整列表,请参见 https://jaeger.golang.ac.cn/docs/1.16/client-features/ 结尾处的表格。环境变量将覆盖此处提供的任何设置。
address
用于报告跨度的主机:端口目标。(例如: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://jaeger.golang.ac.cn/docs/1.16/sampling/#client-sampling-configuration。
可以使用环境变量 JAEGER_SAMPLER_TYPE
设置。
要覆盖此设置,请在 tracing.opentelemetry
部分中输入 sampler_type
。
sampler_param
默认值为 1
。
这是采样器配置参数。根据 sampler_type
的值,它可以是 0
、1
或介于两者之间的十进制值。
- 对于
const
采样器,0
或1
分别表示始终为false
/true
- 对于
probabilistic
采样器,概率在0
和1.0
之间 - 对于
rateLimiting
采样器,每秒跨度数 - 对于
remote
采样器,param 与probabilistic
相同,表示在从母舰接收实际采样率之前的初始采样率
可以使用环境变量 JAEGER_SAMPLER_PARAM
设置。
在 tracing.opentelemetry
部分中设置 sampler_param
将覆盖此设置。
sampling_server_url
sampling_server_url 是提供采样策略的采样管理器的 URL。
在 tracing.opentelemetry
部分中设置 sampling_server_url
将覆盖此设置。
zipkin_propagation
默认值为 false
。
控制是否使用 Zipkin 的跨度传播格式(使用 x-b3-
HTTP 标头)。默认情况下,使用 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。这可供所有跟踪提供者使用。
使用支持 Jaeger 远程采样 API 的采样服务器,例如 jaeger-agent、jaeger-collector、opentelemetry-collector-contrib 或 Grafana Alloy。
[tracing.opentelemetry.jaeger]
配置 Grafana 的 Jaeger 客户端以进行分布式跟踪。
address
用于报告跨度的主机:端口目标。(例如:localhost:14268/api/traces
)
propagation
传播指定文本映射传播格式。支持的值为 jaeger
和 w3c
。在值之间添加逗号 (,
) 以指定多种格式(例如,"jaeger,w3c"
)。默认值为 w3c
。
[tracing.opentelemetry.otlp]
配置 Grafana 的 otlp 客户端以进行分布式跟踪。
address
用于报告跨度的主机:端口目标。(例如:localhost:4317
)
propagation
传播指定文本映射传播格式。支持的值为 jaeger
和 w3c
。在值之间添加逗号 (,
) 以指定多种格式(例如,"jaeger,w3c"
)。默认值为 w3c
。
[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
)。
注意
此选项特定于 Amazon S3 服务。
bucket_url
(为了向后兼容,仅在未配置桶或区域时才有效)S3 的桶 URL。可以在 URL 中指定 AWS 区域,或者默认为 '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。
[external_image_storage.webdav]
url
Grafana 向其发送 PUT 请求以包含图像的 URL。
username
基本身份验证用户名。
password
基本身份验证密码。
public_url
可选 URL,用于在通知中发送给用户。如果字符串包含序列 {{file}}
,则将其替换为上传的文件名。否则,文件名将追加到 URL 的路径部分,保留任何查询字符串不变。
[external_image_storage.gcs]
key_file
与 Google 服务帐户关联的 JSON 密钥文件的可选路径,用于身份验证和授权。如果未提供任何值,则它会尝试使用 应用程序默认凭据。可以从 https://console.developers.google.com/permissions/serviceaccounts 创建和下载服务帐户密钥。
服务帐户应具有“存储对象写入者”角色。桶的访问控制模型需要为“设置对象级和桶级权限”。Grafana 本身将在未启用签名 URL 时使图像公开可读。
bucket
Google Cloud Storage 上的桶名称。
path
桶内的可选额外路径。
enable_signed_urls
如果设置为 true,Grafana 会为上传到 Google Cloud Storage 的图像创建 签名 URL。
signed_url_expiration
设置签名 URL 过期时间,默认值为七天。
[external_image_storage.azure_blob]
account_name
存储帐户名称。
account_key
存储帐户密钥
container_name
用于存储具有随机名称的“Blob”图像的容器名称。 必须事先创建 Blob 容器。 只支持公共容器。
sas_token_expiration_days
SAS 令牌有效期(天数)。 如果指定了 SAS 令牌,则它将附加到图像 URL。 允许将图像存储在私有容器中。
[external_image_storage.local]
此选项不需要任何配置。
[rendering]
配置远程 HTTP 图像渲染服务的选项,例如使用 https://github.com/grafana/grafana-image-renderer。
renderer_token
注意
在 Grafana v9.1.2 和 Image Renderer v3.6.1 或更高版本中可用。
一个身份验证令牌将发送到渲染器并由渲染器验证。 渲染器会拒绝任何没有与渲染器上配置的身份验证令牌匹配的身份验证令牌的请求。
server_url
远程 HTTP 图像渲染服务 URL,例如 https://127.0.0.1:8081/render,将使 Grafana 能够使用对外部服务的 HTTP 请求将面板和仪表板渲染为 PNG 图像。
callback_url
如果远程 HTTP 图像渲染服务运行在与 Grafana 服务器不同的服务器上,则可能需要将其配置为 Grafana 可访问的 URL,例如 http://grafana.domain/。
concurrent_render_request_limit
并发渲染请求限制会影响何时使用 /render HTTP 端点。 同时渲染许多图像可能会使服务器过载,此设置可以通过仅允许一定数量的并发请求来帮助防止这种情况。 默认值为 30
。
default_image_width
配置渲染图像的宽度。 默认宽度为 1000
。
default_image_height
配置渲染图像的高度。 默认高度为 500
。
default_image_scale
配置渲染图像的缩放比例。 默认缩放比例为 1
。
[panels]
enable_alpha
如果要测试尚未准备好供一般使用 Alpha 面板,请将其设置为 true
。 默认值为 false
。
disable_sanitize_html
注意
此配置在 Grafana Cloud 实例中不可用。
如果设置为 true,Grafana 将允许文本面板中的脚本标记。 不建议使用此选项,因为它会启用 XSS 漏洞。 默认值为 false。
[plugins]
enable_alpha
如果要测试尚未准备好供一般使用 Alpha 插件,请将其设置为 true
。 默认值为 false
。
allow_loading_unsigned_plugins
输入一个逗号分隔的插件标识符列表,以标识即使未签名也要加载的插件。 具有修改签名的插件永远不会加载。
我们不建议使用此选项。 有关更多信息,请参阅 插件签名。
plugin_admin_enabled
仅对 Grafana 管理员可用,可直接从 Grafana UI 安装/卸载/更新插件。 默认设置为 true
。 设置为 false
将隐藏安装/卸载/更新控件。
有关更多信息,请参阅 插件目录。
plugin_admin_external_manage_enabled
如果要启用插件的外部管理,请将其设置为 true
。 默认值为 false
。 这只适用于 Grafana Cloud 用户。
plugin_catalog_url
企业插件的自定义安装/了解更多 URL。 默认值为 https://grafana.org.cn/grafana/plugins/。
plugin_catalog_hidden_plugins
输入一个逗号分隔的插件标识符列表,以在插件目录中隐藏这些标识符。
public_key_retrieval_disabled
禁用下载公钥以验证插件签名。 默认值为 false
。 如果禁用,它将使用硬编码的公钥。
public_key_retrieval_on_startup
在启动时强制下载公钥以验证插件签名。 默认值为 false
。 如果禁用,则每 10 天检索一次公钥。 需要 public_key_retrieval_disabled
为 false 才能生效。
disable_plugins
输入一个逗号分隔的插件标识符列表,以避免加载(包括核心插件)。 这些插件将在目录中隐藏。
[live]
max_connections
注意
在 Grafana v8.0 及更高版本中可用。
max_connections
选项指定每个 Grafana 服务器实例到 Grafana Live WebSocket 端点的最大连接数。 默认值为 100
。
如果您指定了比默认值更高的数字,请参阅 Grafana Live 配置文档,因为这可能需要进行一些操作系统和基础设施调整。
0 禁用 Grafana Live,-1 表示无限连接。
allowed_origins
注意
在 Grafana v8.0.4 及更高版本中可用。
allowed_origins
选项是一个逗号分隔的附加来源列表(WebSocket 连接建立期间 HTTP 升级请求的 Origin
标头),Grafana Live 将接受这些来源。
如果没有设置(默认),则来源将与 root_url 匹配,这对于大多数场景来说应该足够了。
来源模式支持通配符“*”。
例如
[live]
allowed_origins = "https://*.example.com"
ha_engine
注意
在 Grafana v8.1 及更高版本中可用。
实验性
Grafana Live 的高可用性 (HA) 引擎名称。 默认情况下,它没有设置。 唯一可能的值是“redis”。
有关更多信息,请参阅 配置 Grafana Live HA 设置。
ha_engine_address
注意
在 Grafana v8.1 及更高版本中可用。
实验性
选定高可用性 (HA) Live 引擎的地址字符串。 对于 Redis,它是一个 host:port
字符串。 例如
[live]
ha_engine = redis
ha_engine_address = 127.0.0.1:6379
[plugin.plugin_id]
此部分可用于配置特定于插件的设置。 将 plugin_id
属性替换为 plugin.json
中存在的插件 ID。
在本部分中描述的属性可用于所有插件,但您必须为每个插件分别设置它们。
tracing
注意
在 Grafana v9.5.0 或更高版本中可用,以及 OpenTelemetry 必须配置为 well。
如果为 true
,则将跟踪上下文传播到插件后端并启用跟踪(如果后端支持)。
as_external
如果已安装核心插件的外部版本,则加载该版本。
实验性。 需要启用功能切换 externalCorePlugins
。
[plugin.grafana-image-renderer]
有关更多信息,请参阅 图像渲染。
rendering_timezone
指示无头浏览器实例在 Grafana 未提供默认时区时使用默认时区,例如在渲染警报的面板图像时。 有关支持的时区 ID 列表,请参阅 ICUs metaZones.txt。 如果未设置,则回退到 TZ 环境变量。
rendering_language
指示无头浏览器实例在 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
指示无头浏览器实例在 Grafana 未提供默认设备缩放因子时使用默认设备缩放因子,例如在渲染警报的面板图像时。 默认值为 1
。 使用更高的值将生成更详细的图像(更高的 DPI),但需要更多磁盘空间来存储图像。
rendering_ignore_https_errors
指示无头浏览器实例是否忽略 HTTPS 错误。 默认情况下,不会忽略 HTTPS 错误。 由于存在安全风险,我们不建议您忽略 HTTPS 错误。
rendering_verbose_logging
指示无头浏览器实例是否捕获和记录详细的渲染图像信息。 默认值为 false
,并且仅捕获和记录错误消息。
启用后,调试消息也会被捕获和记录。
要将详细的信息包含在 Grafana 服务器日志中,您必须将渲染日志级别调整为调试,配置 [log].filter = rendering:debug。
rendering_dumpio
指示无头浏览器实例是否将其调试和错误消息输出到远程渲染服务的运行进程中。 默认值为 false
。
在进行故障排除时,将其设置为 true
可能会有用。
rendering_timing_metrics
注意:从 grafana-image-renderer v3.9.0+ 开始可用
指示无头浏览器实例是否记录每个渲染步骤的持续时间的指标。 默认值为 false
。
在优化渲染模式设置以提高插件性能或进行故障排除时,将其设置为 true
可能会有用。
rendering_args
传递给无头浏览器实例的附加参数。 默认值为 --no-sandbox,--disable-gpu
。 Chromium 标记列表可在 (https://peter.sh/experiments/chromium-command-line-switches/) 中找到。 使用逗号分隔多个参数。
rendering_chrome_bin
您可以配置插件以使用不同的浏览器二进制文件,而不是预打包的 Chromium 版本。
请注意,不建议这样做。 如果安装的 Chrome/Chromium 版本与插件不兼容,您可能会遇到问题。
rendering_mode
指示如何创建无头浏览器实例。 默认值为 default
,并且将在每次请求时创建一个新的浏览器实例。
模式 clustered
将确保只有最大数量的浏览器/隐身页面可以同时执行。
模式 reusable
将拥有一个浏览器实例,并在每次请求时创建一个新的隐身页面。
rendering_clustering_mode
当 rendering_mode = clustered 时,您可以指示可以同时执行多少个浏览器或隐身页面。 默认值为 browser
,并且将使用浏览器实例进行聚类。
模式 context
将使用隐身页面进行聚类。
rendering_clustering_max_concurrency
当 rendering_mode = clustered 时,您可以定义可以同时执行的浏览器实例/隐身页面的最大数量。 默认值为 5
。
rendering_clustering_timeout
注意
在 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]
enable
要启用的功能的键,用空格分隔。
FEATURE_TOGGLE_NAME = false
一些稳定功能的功能切换默认情况下处于开启状态。 使用此设置禁用默认情况下处于开启状态的名称为 FEATURE_TOGGLE_NAME 的功能切换,例如 exploreMixedDatasource = false
。
[feature_management]
本部分中的选项配置实验性功能切换管理页面功能,该功能使用 featureToggleAdminPage
功能切换启用。 Grafana Labs 提供尽力而为的支持,并且在功能普遍可用之前可能会发生重大更改。
有关详细信息,请参阅配置功能开关。
allow_editing
允许您在功能管理页面切换功能开关状态。默认值为false
。
update_webhook
设置管理功能开关更新的控制器的 URL。如果未设置,功能管理页面中的功能开关将为只读。
注意
功能开关更新的 API 尚未定义。
hidden_toggles
从功能管理页面隐藏其他特定功能开关。默认情况下,unknown
、experimental
和private preview
阶段的功能开关在 UI 中隐藏。使用此选项隐藏public preview
、general availability
和deprecated
阶段的功能开关。
read_only_toggles
用于在功能管理页面中禁用对其他特定功能开关的更新。默认情况下,仅当功能开关处于general availability
和deprecated
阶段时才能更新它们。使用此选项禁用对这些阶段的功能开关的更新。
[date_formats]
注意
以下日期格式选项仅在 Grafana v7.2+ 中可用。
本节控制时间范围、图表和日期输入框中使用的日期格式的系统范围默认值。
格式模式使用Moment.js格式化标记。
full_date
时间范围选择器和其他需要渲染完整日期的地方使用的完整日期格式。
intervals
这些间隔格式用于图表中,仅显示部分日期或时间。例如,如果 Y 轴刻度标签之间只有分钟,则使用interval_minute
格式。
Defaults
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
。
[expressions]
注意
此功能在 Grafana v7.4 及更高版本中可用。
enabled
将此设置为false
以禁用表达式并在 Grafana UI 中隐藏它们。默认为true
。
[geomap]
本节控制 Geomap 插件的默认设置。
default_baselayer_config
用于定义默认底图的 json 配置。可以选择四个底图选项:carto
、esriXYZTiles
、xyzTiles
、standard
。例如,要将 cartoDB light 设置为默认底图
default_baselayer_config = `{
"type": "xyz",
"config": {
"attribution": "Open street map",
"url": "https://tile.openstreetmap.org/{z}/{x}/{y}.png"
}
}`
enable_custom_baselayers
将此设置为false
以禁用加载其他自定义底图并在 Grafana UI 中隐藏它们。默认为true
。
[rbac]
有关详细信息,请参阅基于角色的访问控制。
[navigation.app_sections]
将应用程序插件(通过其 ID 引用)及其所有页面移动到特定的导航部分。格式:<pluginId> = <sectionId> <sortWeight>
[navigation.app_standalone_pages]
将单个应用程序插件页面(通过其path
字段引用)移动到特定的导航部分。格式:<pageUrl> = <sectionId> <sortWeight>
[public_dashboards]
本节配置公共仪表板功能。
enabled
将此设置为false
以禁用公共仪表板功能。这将阻止用户创建新的公共仪表板,并禁用现有的公共仪表板。