菜单

设置

配置 Grafana

配置 Grafana Enterprise

Enterprise Open source

配置 Grafana Enterprise

本页介绍可以在 .ini 配置文件或使用环境变量指定的 Grafana Enterprise 特有的配置选项。有关可用配置选项的更多信息，请参阅配置。

[enterprise]

license_path

Grafana Enterprise 许可文件的本地文件系统路径。默认为 <paths.data>/license.jwt。

license_text

设置为许可的文本表示（即许可文件的内容）时，Grafana 将评估并应用给定的许可到实例。

auto_refresh_license

启用时，Grafana 会将许可和使用统计信息发送给许可颁发者。如果许可在颁发者端已更新，使其对不同数量的用户或新持续时间有效，你的 Grafana 实例将自动更新新条款。默认为 true。

注意
许可每天仅自动更新一次。要立即更新许可的条款，请使用 Grafana UI 更新你的许可 token。

license_validation_type

设置为 aws 时，Grafana 将使用 Amazon Web Services (AWS) 而非 Grafana Labs 验证其许可状态。仅在你从 AWS Marketplace 购买了企业版许可时使用此设置。默认为空，这意味着 Grafana Enterprise 默认使用由 Grafana Labs 颁发的许可进行验证。有关由 AWS 颁发的许可的详细信息，请参阅激活通过 AWS Marketplace 购买的 Grafana Enterprise 许可。

[white_labeling]

app_title

设置为你的公司名称以覆盖应用程序标题。

login_logo

设置为完整 URL 以覆盖登录徽标。

login_background

设置为完整的 CSS background 表达式以覆盖登录背景。示例

[white_labeling]
login_background = url(http://www.bhmpics.com/wallpapers/starfield-1920x1080.jpg)

menu_logo

设置为完整 URL 以覆盖菜单徽标。

fav_icon

设置为完整 URL 以覆盖 fav icon（浏览器标签页中显示的图标）。

apple_touch_icon

设置为完整 URL 以覆盖 Apple/iOS 图标。

hide_edition

设置为 true 以移除页脚中显示的 Grafana 版本。

footer_links

在此处列出要使用的链接 ID。Grafana 将查找匹配的链接配置，链接 ID 应以空格分隔，不包含空格。

[usage_insights.export]

通过导出使用日志，你可以直接查询这些日志并创建你最关心的信息的仪表盘，例如仪表盘错误、最活跃的组织或你的前 10 个最常用的查询。

enabled

启用使用情况洞察导出功能。

storage

指定存储类型。默认为 loki。

[usage_insights.export.storage.loki]

type

设置与 Loki 通信时使用的协议，可以是 grpc 或 http。默认为 grpc。

url

设置向 Loki 写入日志的地址（格式必须是 host:port）。

tls

决定在建立与 Loki 的连接时是否启用 TLS (Transport Layer Security) 协议。默认为 true。

tenant_id

设置 Loki 通信的租户 ID，默认禁用。在 Loki 运行在多租户模式下时，租户 ID 是必需的。

[analytics.summaries]

buffer_write_interval

将仪表盘使用统计信息缓冲区写入数据库的间隔。

buffer_write_timeout

将仪表盘使用统计信息缓冲区写入数据库的超时时间。

rollup_interval

尝试汇总每个仪表盘使用摘要的间隔。每天最多只汇总一次。

rollup_timeout

尝试汇总每个仪表盘使用摘要的超时时间。

[analytics.views]

recent_users_age

最近活跃用户的年龄。

[reporting]

enabled

启用或禁用报告功能。禁用时，不生成报告，并且 UI 被隐藏。默认情况下，报告是启用的（true）。

rendering_timeout

以下报告渲染请求的超时时间：生成 PDF，生成报告电子邮件的嵌入式仪表盘图像，以及生成附加的 CSV 文件。默认为 10 秒 (10s)。

concurrent_render_limit

对渲染服务的并发调用最大数量。默认为 4。

image_scale_factor

渲染图像的缩放因子。值 2 足以满足显示器分辨率，4 更适合打印材料。设置更高的值会影响性能和内存。默认为 2。

max_attachment_size_mb

设置报告电子邮件附件的最大文件大小（兆字节）。默认为 10。

fonts_path

字体文件所在目录的路径。

font_regular

常规风格 TrueType 字体文件的名称。默认为 DejaVuSansCondensed.ttf。

font_bold

粗体风格 TrueType 字体文件的名称。

font_italic

斜体风格 TrueType 字体文件的名称。默认为 DejaVuSansCondensed-Oblique.ttf。

max_retries_per_panel

以下报告渲染请求在返回错误之前重试的最大次数：生成 PDF，生成报告电子邮件的嵌入式仪表盘图像，以及生成附加的 CSV 文件。要禁用重试功能，输入 0。此功能处于公开预览阶段，需要 reportingRetries 功能开关。默认为 3。

allowed_domains

允许接收报告的域。使用星号 (*) 允许所有域。使用逗号分隔列表允许多个域。示例：allowed_domains = grafana.com, example.org。默认为 *。

[auditing]

审计允许你跟踪 Grafana 实例的重要更改。默认情况下，审计日志记录到文件，但审计功能也支持直接将日志发送到 Loki。

enabled

启用审计功能。默认为 false。

loggers

启用的日志记录器列表。

log_dashboard_content

在日志中保留仪表盘内容（请求或响应字段）。这会显著增加日志的大小。

verbose

记录所有请求并保留请求和响应主体。这会显著增加日志的大小。

log_all_status_codes

设置为 false 以仅记录状态码为 2xx、3xx、401、403、500 的请求。

max_response_size_bytes

要记录的最大响应主体大小（字节）。有助于减少审计造成的内存占用。

[auditing.logs.file]

path

日志文件夹的路径。

max_files

保留的最大日志文件数量。

max_file_size_mb

每个日志文件的最大大小（兆字节）。

[auditing.logs.loki]

url

设置向 Loki 写入日志的 URL。

tls

如果为 true，则建立与 Loki 的安全连接。默认为 true。

tenant_id

设置 Loki 通信的租户 ID，默认禁用。在 Loki 运行在多租户模式下时，租户 ID 是必需的。

[auth.saml]

enabled

如果为 true，则启用此功能。默认为 false。

allow_sign_up

如果为 true，则允许通过 SAML 登录创建新的 Grafana 用户。默认为 true。

certificate

Base64 编码的公共 X.509 证书。用于签署发送给 IdP 的请求。

certificate_path

公共 X.509 证书的路径。用于签署发送给 IdP 的请求。

private_key

Base64 编码的私钥。用于解密 IdP 的 assertion。

private_key_path

私钥的路径。用于解密 IdP 的 assertion。

idp_metadata

Base64 编码的 IdP SAML 元数据 XML。用于验证和获取 IdP 的绑定位置。

idp_metadata_path

SAML 元数据 XML 的路径。用于验证和获取 IdP 的绑定位置。

idp_metadata_url

获取 SAML IdP 元数据的 URL。用于验证和获取 IdP 的绑定位置。

max_issue_delay

自 IdP 发送响应以来，SP 允许处理该响应的时间。默认为 90 秒。

metadata_valid_duration

SP 元数据的有效时间。默认为 48 小时。

assertion_attribute_name

SAML assertion 中用作用户名的属性的友好名称或名称。或者，这可以是包含与 SAML assertion 中属性名称匹配的变量的模板。

assertion_attribute_login

SAML assertion 中用作用户登录句柄的属性的友好名称或名称。

assertion_attribute_email

SAML assertion 中用作用户电子邮件的属性的友好名称或名称。

assertion_attribute_groups

SAML assertion 中用作用户组的属性的友好名称或名称。

assertion_attribute_role

SAML assertion 中用作用户角色的属性的友好名称或名称。

assertion_attribute_org

SAML assertion 中用作用户组织的属性的友好名称或名称。

allowed_organizations

逗号或空格分隔的组织列表。每个用户必须是至少一个组织的成员才能登录。

org_mapping

逗号或空格分隔的 Organization:OrgId:Role 映射列表。Organization 可以是 *，表示“所有用户”。Role 是可选的，可以有以下值：Admin、Editor、Viewer 或 None。

role_values_none

逗号或空格分隔的将映射到 None 角色的角色列表。

role_values_viewer

逗号或空格分隔的将映射到 Viewer 角色的角色列表。

role_values_editor

逗号或空格分隔的将映射到 Editor 角色的角色列表。

role_values_admin

逗号或空格分隔的将映射到 Admin 角色的角色列表。

role_values_grafana_admin

逗号或空格分隔的将映射到 Grafana Admin (Super Admin) 角色的角色列表。

[keystore.vault]

url

Vault 服务器的位置。

namespace

如果使用多租户 Vault，则为 Vault 命名空间。

auth_method

向 Vault 进行身份验证的方法。如果未设置此选项，则 Vault 将处于非活动状态。当前可能的值：token。

token

当 auth_method 为 token 时连接到 Vault 的秘密 token。

lease_renewal_interval

检查是否有任何秘密需要续订的时间间隔。

lease_renewal_expires_within

续订 token 的过期时间。该值应高于 lease_renewal_interval。

lease_renewal_increment

续订 token 的新持续时间。Vault 可能配置为忽略此值并施加更严格的限制。

[security.egress]

出站安全可以控制从 Grafana 服务器发出的流量。

host_deny_list

以空格分隔的主机名或 IP 地址列表，这些地址的请求将被阻止。

host_allow_list

以空格分隔的主机名或 IP 地址列表，这些地址的请求将被允许。所有其他请求将被阻止。

header_drop_list

从出站数据源和警报请求中剥离的标头列表。

cookie_drop_list

从出站数据源和警报请求中剥离的 cookie 列表。

[security.encryption]

algorithm

用于加密存储在数据库和 cookie 中的秘密信息的加密算法。可能的值为 aes-cfb（默认）和 aes-gcm。AES-CFB 代表 Advanced Encryption Standard（高级加密标准）的 cipher feedback（密文反馈）模式，AES-GCM 代表 Advanced Encryption Standard 的 Galois/Counter Mode（伽罗瓦/计数器模式）。

[caching]

启用查询缓存后，Grafana 可以临时存储数据源查询的结果，并向类似的请求提供缓存的响应。

backend

用于存储缓存查询的缓存后端。选项：memory、redis 和 memcached。

默认为 memory。

enabled

将“enabled”设置为 true 允许用户为数据源配置查询缓存。

此值默认为 true。

注意
此设置启用缓存功能，但不会为任何数据源开启查询缓存。要为数据源开启查询缓存，请在数据源配置页面更新设置。有关更多信息，请参阅查询缓存文档。

ttl

Time to live（TTL）是查询结果在缓存系统中存储的时间，之后将被删除或刷新。此设置定义了查询缓存的生存时间，当未在数据源设置中配置 TTL 时生效。默认值为 1m（1 分钟）。

max_ttl

查询结果在缓存系统中存储的最长持续时间，之后将被删除或刷新。如果 ttl 值大于 max_ttl，则该值将覆盖 ttl 配置选项或数据源设置。要禁用此限制，请将该值设置为 0s。

默认值是 0s（已禁用）。

注意
在生产环境中不建议禁用此限制。

max_value_mb

此值限制单个缓存值的大小。如果缓存值（或查询结果）超出此大小，则不会被缓存。要禁用此限制，请将此值设置为 0。

默认值是 1。

connection_timeout

此设置定义了等待连接到缓存后端的时间。

默认值是 5s。

read_timeout

此设置定义了等待缓存后端返回缓存结果的时间。要禁用此超时，请将此值设置为 0s。

默认值是 0s（已禁用）。

注意
在生产环境中不建议禁用此超时。

write_timeout

此设置定义了等待缓存后端存储结果的秒数。要禁用此超时，请将此值设置为 0s。

默认值是 0s（已禁用）。

注意
在生产环境中不建议禁用此超时。

[caching.encryption]

enabled

当“enabled”为 true 时，缓存中的查询值将被加密。

默认值是 false。

encryption_key

用于生成用于加密缓存的密钥的字符串。为了使加密的缓存数据在 Grafana 重启后仍然存在，您必须指定此密钥。如果在启用加密时此字段为空，则会在启动时自动生成密钥，并且缓存会在重启时清除。

默认值是 ""。

[caching.memory]

gc_interval

当在内存中存储缓存数据时，此设置定义了后台进程清理内存缓存中陈旧数据的频率。“垃圾回收”越频繁，内存使用量就越不容易攀升，但会增加 CPU 使用率。

默认值是 1m。

max_size_mb

内存缓存的最大大小（以兆字节为单位）。达到此大小时，新的缓存项将被拒绝。要更灵活地控制缓存逐出策略和大小，请使用 Redis 或 Memcached 后端。

要禁用此最大值，请将此值设置为 0。

默认值是 25。

注意
在生产环境中不建议禁用此最大值。

[caching.redis]

url

您的 Redis 服务器的完整 Redis URL。例如：redis://username:password@localhost:6379。要启用 TLS，请使用 rediss 方案。

默认值是 "redis://:6379"。

cluster

Redis 集群成员的逗号分隔列表，可以是 host:port 格式或使用完整的 Redis URL (redis://username:password@localhost:6379)。例如，localhost:7000, localhost: 7001, localhost:7002。如果您使用完整的 Redis URL，则只能指定一次方案、用户名和密码。例如，redis://username:password@localhost:0000,localhost:1111,localhost:2222。您不能为每个 URL 指定不同的用户名和密码。