文档 Grafana文档 设置 配置Grafana

配置Grafana

您可以使用Grafana Cloud来避免安装、维护和扩展自己的Grafana实例。 创建免费账户 开始使用，包括永久免费访问10k指标、50GB日志、50GB跟踪、500VUh k6测试等功能。

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

默认情况下，配置文件位于/opt/homebrew/etc/grafana/grafana.ini或/usr/local/etc/grafana/grafana.ini。对于使用Homebrew安装的Grafana实例，直接编辑grafana.ini文件。否则，将名为custom.ini的配置文件添加到conf文件夹以覆盖conf/defaults.ini中定义的设置。

在.ini文件中取消注释

Graphana使用分号（;字符）在.ini文件中注释行。您必须取消注释要修改的custom.ini或grafana.ini文件中的每一行，通过从该行的开头删除;来实现。否则，您的更改将被忽略。

例如

复制

# The HTTP port  to use
;http_port = 3000

使用环境变量覆盖配置

不要使用环境变量来添加新的配置设置。相反，使用环境变量来覆盖现有的选项。

要覆盖一个选项

bash 复制

GF_<SectionName>_<KeyName>

其中部分名称是括号内的文本。所有内容都应该是大写，.和-应该替换为_。例如，如果您有这些配置设置

bash 复制

# 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机器上覆盖变量

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_ENABLE=newNavigation

变量扩展

如果您的任何选项包含表达式$__<provider>{<argument>}或${<environment variable>}，则它们将由Grafana的变量展开器进行处理。展开器使用提供的参数运行提供者以获取选项的最终值。

有三个提供者：env、file和vault。

Env提供者

env提供者可用于展开环境变量。如果您将选项设置为$__env{PORT}，则将使用PORT环境变量替换它。对于环境变量，您还可以使用简写语法${PORT}。在以下示例中，Grafana的日志目录将设置为LOGDIR环境变量后面的grafana目录。

ini 复制

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

文件提供者

file从文件系统中读取文件。它从文件的开始和结尾删除空白字符。以下示例中的数据库密码将被替换为/etc/secrets/gf_sql_password文件的内容

ini 复制

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

瓦尔特提供者

vault提供者允许您使用Hashicorp Vault管理您的机密。

瓦尔特提供者仅在Grafana Enterprise v7.1+中可用。有关更多信息，请参阅Vault集成，位于Grafana Enterprise。

app_mode

选项是production和development。默认是production。不要更改此选项，除非您正在开发Grafana。

instance_name

设置grafana-server实例的名称。用于日志记录、内部指标和集群信息。默认值：${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 覆盖日志路径

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

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

另一种方法是放置一个Web服务器（如Nginx或Apache）在Grafana前面，并让它们将请求代理到Grafana。

domain

此设置仅用于作为root_url设置的一部分（见下文）。如果使用GitHub或Google OAuth，则很重要。

enforce_domain

如果主机标题与域名不匹配，则重定向到正确的域名。防止DNS重绑定攻击。默认为false。

root_url

这是从Web浏览器访问Grafana的完整URL。如果您使用Google或GitHub OAuth身份验证（回调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 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 套接字的路径。例如，对于在同一主机上运行的 MySQL：host = 127.0.0.1:3306 或使用 Unix 套接字：host = /var/run/mysqld/mysqld.sock

name

Grafana 数据库的名称。保留为 grafana 或其他名称。

user

数据库用户（不适用于 sqlite3）。

密码

数据库用户的密码（对于 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 企业版中的查询缓存。

type

可以是 redis、memcached 或 database。默认为 database

connstr

远程缓存连接字符串。格式取决于远程缓存的类型。选项有database、redis和memcache。

database

使用database时留空，因为它将使用主数据库。

redis

示例连接字符串：addr=127.0.0.1:6379,pool_size=100,db=0,ssl=false

• addr是redis服务器的主机 : 端口。
• 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

Graphana等待与数据源成功TLS握手的时长。默认为10秒。有关更多详细信息，请参阅Transport.TLSHandshakeTimeout文档。

expect_continue_timeout_seconds

Graphana在完全写入请求头后等待数据源的第一个响应头的时间长度，如果请求有“Expect: 100-continue”头。值为0会导致立即发送体。默认为1秒。有关更多详细信息，请参阅Transport.ExpectContinueTimeout文档。

max_conns_per_host

可选地限制每个主机上的总连接数，包括正在拨号、活动和非活动状态的连接。在违反限制时，拨号将被阻止。值为0表示没有限制。默认为0。有关更多详细信息，请参阅Transport.MaxConnsPerHost文档。

max_idle_connections

Graphana将维护的最大空闲连接数。默认为100。有关更多详细信息，请参阅Transport.MaxIdleConns文档。

idle_conn_timeout_seconds

Graphana在关闭之前维护空闲连接的时长。默认为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仓库中的新版本。当启用时，每10分钟检查一次新版本。当有新版本可用时，将通过UI通知。检查本身不会提示自动更新Grafana软件，也不会发送任何敏感信息。

check_for_plugin_updates

设置为false将禁用检查已安装插件的新版本。当启用时，每10分钟检查一次新插件。当存在新插件更新时，将通过UI通知。检查本身不会提示插件自动更新，也不会发送任何敏感信息。

google_analytics_ua_id

如果您想通过Google分析跟踪Grafana的使用，请在此处指定您的通用分析ID。默认情况下，此功能是禁用的。

google_analytics_4_id

如果您想通过Google Analytics 4跟踪Grafana的使用，请在此处指定您的GA4 ID。默认情况下，此功能是禁用的。

google_tag_manager_id

Google标签管理器ID，只有在此处输入ID时才启用。

rudderstack_write_key

如果您想通过Rudderstack跟踪Grafana的使用，请在此处指定您的Rudderstack Write Key。要启用此功能，还必须提供rudderstack_data_plane_url。默认情况下，此功能是禁用的。

rudderstack_data_plane_url

Rudderstack数据平面URL，将接收Rudderstack事件。要启用此功能，还必须提供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

设置SameSitecookie属性，防止浏览器在跨站请求中发送此cookie。主要目标是减轻跨源信息泄露的风险。此设置还提供了一些针对跨站请求伪造攻击（CSRF）的保护，关于SameSite的更多信息。有效值是lax、strict、none和disabled。默认为lax。使用值disabled不会向cookie添加任何SameSite属性。

allow_embedding

当false时，Grafana的HTTP响应将设置HTTP头X-Frame-Options: deny，指示浏览器不允许在<frame>、<iframe>、<embed>或<object>中渲染Grafana。主要目标是减轻Clickjacking的风险。默认为false。

strict_transport_security

如果您想启用HTTPStrict-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。

xxss_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。

actions_allow_post_url

设置 API 路径，允许插件之间使用 POST 动词进行访问。如果值为空，则只能通过代理传递远程请求。如果设置了值，还可以向本地服务器发送经过身份验证的 POST 请求。通常用于启用插件之间的后端通信。

这是一个以逗号分隔的列表，使用通配符匹配。

这将允许访问所有具有后端的插件

actions_allow_post_url=/api/plugins/*

这将限制对单个插件后端的访问

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

angular_support_enabled

默认设置为 false，这意味着 angular 框架和支持组件将不会被加载。这意味着所有依赖于 angular 支持的 插件 和核心功能将停止工作。

依赖于 angular 的核心功能包括

• 旧版图形面板
• 旧版表格面板

这些功能每个都有支持的替代方案，我们建议使用它们。

csrf_trusted_origins

允许通过 CSRF 检查的额外允许 URL 列表。在身份验证来自 IdP 时建议使用。

csrf_additional_headers

允许用户设置的允许头列表。如果身份验证位于反向代理后面，建议使用。

csrf_always_check

设置为 true 以在登录 cookie 不在请求中时也执行 CSRF 检查（默认 false）。

disable_frontend_sandbox_for_plugins

以逗号分隔的插件 ID 列表，这些插件 ID 不会在前端沙盒中加载。仅推荐在已知有问题的插件中使用此选项。

[快照]

enabled

设置为 false 以禁用快照功能（默认 true）。

external_enabled

设置为 false 以禁用外部快照发布端点（默认 true）。

external_snapshot_url

设置要发布外部快照的 Grafana 实例的根 URL（默认为 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”。

[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

将此值设置为自动将新用户添加到提供的 org。这需要将 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

如果可用，则此选项将设置默认UI语言，例如en-US等受支持的IETF语言标记。如果设置为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管理员和本人可见。

[auth]

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。

示例

注销重定向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

设置为 true 以自动尝试使用OAuth登录，跳过登录界面。如果配置了多个OAuth提供程序，则忽略此设置。默认值为 false。

oauth_state_cookie_max_age

OAuth状态cookie在删除之前存活多少秒。默认值为 600（秒）。管理员可以将其增加，以解决OAuth登录状态不匹配错误。

oauth_login_error_message

当用户未经授权时，自定义错误消息。默认为前端国际化短语的关键字，登录提供程序拒绝登录请求。

oauth_refresh_token_server_lock_min_wait_ms

服务器锁定重试机制的最低等待时间（以毫秒为单位）。默认值为 1000（毫秒）。服务器锁定重试机制用于防止多个Grafana实例同时刷新OAuth令牌。在此机制重试获取服务器锁定之前，至少等待此时间。

总共有五次重试，因此使用默认值，总等待时间（获取锁）至少为5秒（重试之间的等待时间计算为随机(n, n + 500)），这意味着最大令牌刷新时间必须小于5-6秒。

如果您遇到OAuth令牌刷新机制问题，您可以增加此值，以允许更多时间完成令牌刷新。

oauth_skip_org_role_update_sync

如果您想将 oauth_skip_org_role_update_sync 设置从 true 更改为 false，则针对您设置的每个提供程序，使用 skip_org_role_sync 设置来指定是否要跳过同步。

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]

[auth.azuread]

[auth.google]

[auth.github]

[auth.gitlab]

[auth.generic_oauth]

[auth.okta]

跳过org_role_sync示例

[auth.google]

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。

managed_service_accounts_enabled

仅适用于Grafana 11.3及以上版本。

设置为true以启用插件认证使用托管服务账户。默认为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参考文档中关于假设角色操作的文档。

如果禁用此选项，则从AWS数据源配置页面中删除假设角色和外部ID字段。如果通过配置来配置插件，则只要将assume_role_enabled设置为true，就可以使用假设角色。

list_metrics_page_limit

使用List Metrics API选项来加载CloudWatch数据源中自定义命名空间下的指标。默认页面限制为500。

[azure]

当Grafana托管在Azure云中时，Grafana支持与Azure服务的额外集成。

cloud

托管Grafana的Azure云环境

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

指定是否在配置了托管标识的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监控、Azure数据探索器、Prometheus、MSSQL）。

azure_entra_password_credentials_enabled

指定是否可以使用Entra密码认证用于MSSQL数据源。此认证不推荐，启用之前应考虑。

默认禁用，需要显式启用。

[auth.jwt]

请参阅JWT身份验证以获取更多信息。

[smtp]

电子邮件服务器设置。

enabled

启用此选项以允许Grafana发送电子邮件。默认为false。

host

默认为localhost:25。使用端口465进行隐式TLS。

user

在SMTP身份验证的情况下，默认为空。

密码

在SMTP身份验证的情况下，默认为空。如果密码包含#或;，则必须用三重引号括起来。例如：“”"#password;"

cert_file

证书文件的文件路径，默认为空。

key_file

密钥文件的文件路径，默认为空。

skip_verify

验证SMTP服务器的SSL，默认为false。

from_address

发送电子邮件时使用的地址，默认为[email protected]。

from_name

发送电子邮件时使用的名称，默认为Grafana。

ehlo_identity

在SMTP对话中用作客户端身份的名称，默认为<instance_name>。

startTLS_policy

可以是“OpportunisticStartTLS”、“MandatoryStartTLS”或“NoStartTLS”。默认为空。

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

输入一个逗号分隔的内容类型列表，这些内容类型应包含在发送的电子邮件中。按降序偏好列出内容类型，例如，对于最偏好的HTML，使用text/html, text/plain。部分顺序很重要，因为邮件客户端将使用受支持并最偏好的发送者内容类型。支持的内容类型是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

使用此配置选项来设置显示给用户的默认错误消息。此消息将显示代替敏感的后端错误，这些错误应被混淆。默认消息是请检查Grafana服务器日志以获取详细信息。。

[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。

网络和地址

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

自定义HTTP端点，用于将Faro代理捕获的事件发送到。默认为/log-grafana-javascript-agent，将事件记录到stdout。

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

开启webvitals仪器。仅影响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

以逗号分隔的组织ID列表，用于禁用Grafana 8统一警报。

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服务器地址。

ha_redis_username

用于与Redis服务器进行认证的用户名。

ha_redis_password

用于与Redis服务器进行认证的密码。

ha_redis_db

Redis数据库。默认值是0。

ha_redis_prefix

用于在Redis服务器上创建的每个键或通道的前缀，作为警报高可用性的部分。

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

显式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

发送八卦消息的间隔。降低此值（更频繁）将使八卦消息在集群中传播得更快，但会增加带宽使用量。默认值是 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，保留所有警报注释。

[注释]

cleanupjob_batchsize

配置注释清理作业的批量大小。此设置用于仪表板、API和警报注释。

tags_length

强制限制任何新引入注释的标签最大允许长度。它可以是500到4096（包含）。默认值为500。将其设置为更高的值会影响性能，因此不推荐。

[注释.仪表板]

仪表板注释表示注释与创建它们的仪表板相关联。

max_age

配置仪表板注释的存储时长。默认为0，表示永久保留。此设置应表示为时长。例如：6h（小时）、10d（天）、2w（周）、1M（月）。

max_annotations_to_keep

配置Grafana存储的仪表板注释的最大数量。默认值为0，保留所有仪表板注释。

[注释.API]

API注释表示注释是通过API创建的，没有与仪表板关联。

max_age

配置Grafana存储API注释的时长。默认为0，表示永久保留。此设置应表示为时长。例如：6h（小时）、10d（天）、2w（周）、1M（月）。

max_annotations_to_keep

配置Grafana保留的API注释的最大数量。默认值为0，保留所有API注释。

[探索]

有关此功能的更多信息，请参阅探索。

enabled

启用或禁用探索部分。默认为启用。

defaultTimeOffset

设置时间选择器上的默认时间偏移。默认为1小时。此设置应表示为时长。例如：1h（小时）、1d（天）、1w（周）、1M（月）。

[帮助]

配置帮助部分。

enabled

启用或禁用帮助部分。默认为启用。

[个人资料]

配置个人资料部分。

enabled

启用或禁用个人资料部分。默认为启用。

[新闻]

news_feed_enabled

启用新闻源部分。默认为true。

[查询]

concurrent_query_limit

设置在混合数据源面板中可以并发执行查询的数量。默认值为CPU数量。

[查询历史]

配置探索中的查询历史。

enabled

启用或禁用查询历史。默认为启用。

[短链接]

配置短链接功能的相关设置。

expire_time

从未被访问的短链接被视为已过期或过时，并将作为清理删除。以天为单位设置过期时间。默认为7天。最大为365天，设置超过最大值将使用365。设置0表示短链接大约每10分钟清理一次。

[指标]

有关详细信息，请参阅内部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>:端口号。

prefix

Graphite 指标前缀。默认为 prod.grafana.%(instance_name)s.

[grafana_net]

请参考 [grafana_com] 配置，因为那是新的首选配置名称。grafana_net 配置仍然被接受并解析为 grafana_com 配置。

[grafana_com]

URL

默认为 https://grafana.org.cn。Grafana Cloud 的默认身份验证提供者。

[tracing.jaeger]

[已弃用 - 请使用 tracing.opentelemetry.jaeger 或 tracing.opentelemetry.otlp]

配置 Grafana 的 Jaeger 客户端以进行分布式跟踪。

您还可以使用标准的 JAEGER_* 环境变量来配置 Jaeger。请参阅 https://jaeger.golang.ac.cn/docs/1.16/client-features/ 末尾的表格，获取完整的列表。环境变量将覆盖此处提供的任何设置。

address

报告 span 的主机:端口目标。 (例如：localhost:6831)

可以通过环境变量 JAEGER_AGENT_HOST 和 JAEGER_AGENT_PORT 来设置。

always_included_tag

逗号分隔的标签列表，包括在所有新的 span 中，例如 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 采样器，分别为始终 false/true 的 0 或 1
• 对于 probabilistic 采样器，一个介于 0 和 1.0 之间的概率
• 对于 rateLimiting 采样器，每秒的 span 数量
• 对于 remote 采样器，参数与 probabilistic 相同，表示在从母舰接收实际采样率之前的初始采样率

可以通过环境变量 JAEGER_SAMPLER_PARAM 来设置。

在 tracing.opentelemetry 部分设置 sampler_param 将覆盖此设置。

sampling_server_url

sampling_server_url 是提供采样策略的采样管理器的 URL。

在 tracing.opentelemetry 部分设置 sampling_server_url 将覆盖此设置。

zipkin_propagation

默认值为 false。

控制是否使用 Zipkin 的 span 传播格式（使用 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。

bucket_url

（为向后兼容性，仅在未配置存储桶或区域时才生效）S3 的存储桶 URL。AWS 区域可以包含在 URL 中，默认为 ‘us-east-1’，例如。

• http://grafana.s3.amazonaws.com/
• https://grafana.s3-ap-southeast-2.amazonaws.com/

bucket

S3 的存储桶名称。例如：grafana.snapshot。

region

S3 的区域名称。例如：‘us-east-1’，‘cn-north-1’，等等。

path

存储桶内部可选的额外路径，用于应用过期策略。

access_key

访问密钥，例如：AAAAAAAAAAAAAAAAAAAAAAAAAAA。

访问密钥需要权限执行 S3 存储桶的 ‘s3:PutObject’ 和 ‘s3:PutObjectAcl’ 操作。

secret_key

Secret key，例如：AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA。

[external_image_storage.webdav]

URL

将图像发送 PUT 请求的 URL。

username

基本认证用户名。

密码

基本认证密码。

public_url

可选 URL，用于在通知中发送给用户。如果字符串包含序列 {{file}}，则替换为上传的文件名。否则，将文件名追加到 URL 的路径部分，保持任何查询字符串不变。

[external_image_storage.gcs]

key_file

可选的JSON密钥文件路径，用于与Google服务账户关联以进行身份验证和授权。如果没有提供值，它将尝试使用应用程序默认凭据。服务账户密钥可以从https://console.developers.google.com/permissions/serviceaccounts创建和下载。

服务账户应具有“存储对象写入者”角色。存储桶的访问控制模型需要是“设置对象级和存储桶级权限”。如果未启用签名URL，Grafana本身将使图像可公开读取。

bucket

Google云存储上的存储桶名称。

path

存储桶内可选的额外路径。

enable_signed_urls

如果设置为true，Grafana将为上传到Google云存储的图像创建签名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

将发送一个身份验证令牌到渲染器并对其进行验证。渲染器将拒绝任何没有与渲染器上配置的匹配身份验证令牌的请求。

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

如果设置为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

max_connections选项指定每个Grafana服务器实例对Grafana Live WebSocket端点的最大连接数。默认为100。

如果指定了高于默认值的数字，请参阅Grafana Live配置文档，因为这可能需要一些操作系统和基础设施的调整。

0禁用Grafana Live，-1表示无限连接。

allowed_origins

allowed_origins选项是逗号分隔的附加来源列表（WebSocket连接建立期间HTTP升级请求的Origin标头），这些来源将被Grafana Live接受。

如果没有设置（默认），则与root_url匹配起源，这应该适用于大多数场景。

起源模式支持通配符“*”。

例如

ini 复制

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

ha_engine

实验性

是Grafana Live的高可用性（HA）引擎名称。默认情况下，它未设置。唯一可能的值是“redis”。

有关更多信息，请参阅配置Grafana Live HA设置。

ha_engine_address

实验性

所选高可用性（HA）Live引擎的地址字符串。对于Redis，它是一个host:port字符串。示例

ini 复制

[live]
ha_engine = redis
ha_engine_address = 127.0.0.1:6379

[plugin.plugin_id]

此部分可以用于配置特定插件的设置。将plugin_id属性替换为存在于plugin.json中的插件ID。

本节中描述的属性适用于所有插件，但您必须为每个插件单独设置它们。

tracing

如果为true，则将跟踪上下文传播到插件后端并启用跟踪（如果后端支持）。

as_external

如果已安装，则加载核心插件的外部版本。

实验性功能。需要启用功能切换 externalCorePlugins。

[plugin.grafana-image-renderer]

更多信息，请参阅图像渲染。

rendering_timezone

指示无头浏览器实例在Grafana未提供时使用默认时区，例如渲染警报面板图像时。请参阅ICUs metaZones.txt以获取支持的时区ID列表。如果没有设置，则回退到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

当渲染模式设置为“clustered”时，您可以指定多少个浏览器或隐身页面可以并发执行。默认为browser，将使用浏览器实例进行集群。

模式 context 将使用隐身页面进行集群。

rendering_clustering_max_concurrency

当渲染模式设置为“clustered”时，您可以定义可以并发执行的最大浏览器实例/隐身页面数量。默认为5。

rendering_clustering_timeout

当渲染模式设置为“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，并将自动分配一个未使用的端口。

[企业版]

有关 Grafana 企业版的信息，请参阅Grafana 企业版。

[功能开关]

enable

启用功能的键，用空格分隔。

FEATURE_TOGGLE_NAME = false

某些稳定功能的默认功能开关是开启的。使用此设置禁用默认开启的功能开关，例如，exploreMixedDatasource = false。

[功能管理]

本节中的选项配置了实验性的功能开关管理页面功能，该功能通过 featureToggleAdminPage 功能开关启用。Grafana Labs 提供基于最佳努力的支持，并且在使用该功能之前可能会出现破坏性更改。

有关更多信息，请参阅配置功能开关。

allow_editing

允许在功能管理页面中切换功能开关状态。默认为 false。

update_webhook

设置管理功能开关更新的控制器 URL。如果未设置，功能管理页面中的功能开关将是只读的。

hidden_toggles

从功能管理页面隐藏额外的特定功能开关。默认情况下，处于 unknown、experimental 和 private preview 阶段的功能开关在 UI 中被隐藏。使用此选项隐藏处于 public preview、general availability 和 deprecated 阶段的功能开关。

read_only_toggles

用于在功能管理页面中禁用额外的特定功能开关的更新。默认情况下，只有处于 general availability 和 deprecated 阶段的功能开关才能更新。使用此选项禁用这些阶段的功能开关更新。

[日期格式]

本节控制系统范围内用于时间范围、图形和日期输入框的日期格式的默认值。

格式模式使用 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

设置默认的周开始时间，有效值有：satursday、sunday、monday或browser（使用浏览器区域设置定义一周的第一天）。默认为browser。

[expressions]

enabled

将此设置为false以禁用表达式并隐藏它们在 Grafana UI 中。默认为true。

[geomap]

本节控制 Geomap 插件的默认设置。

default_baselayer_config

用于定义默认基础图的 json 配置。有四种基础图选项可供选择：carto、esriXYZTiles、xyzTiles、standard。例如，要将 cartoDB light 设置为默认基础图层

ini 复制

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以禁用公共仪表板功能。这将防止用户创建新的公共仪表板并禁用现有的仪表板。