这是关于下一个《Grafana》的版本。有关最新的稳定版本,请转到最新版本.
配置Grafana
您可以使用Grafana Cloud来避免安装、维护和扩展您自己的Grafana实例。创建一个免费帐户开始,其中包括永远免费访问10k指标,50GB日志,50GB跟bob体育手机二维码踪,等等。
Grafana有默认和自定义配置文件。您可以通过修改自定义配置文件或使用环境变量来定制您的Grafana实例。要查看Grafana实例的设置列表,请参见查看服务器设置.
注意:添加自定义选项后,取消注释配置文件的相关部分。重新启动Grafana,使您的更改生效。
配置文件位置
Grafana实例的默认设置存储在WORKING_DIR / conf / defaults.ini美元
文件。不更改此文件。
根据您的操作系统,您的自定义配置文件是WORKING_DIR / conf / defaults.ini美元
文件或/usr/local/etc/grafana/grafana.ini
文件。方法可以覆盖自定义配置文件路径——配置
参数。
Linux
如果您使用黛比
或rpm
包,则配置文件位于/etc/grafana/grafana.ini
还有一个单独的custom.ini
未使用。该路径在Grafana初始化中指定。使用D脚本——配置
文件参数。
码头工人
指配置一个Grafana Docker镜像获取有关环境变量、持久存储和构建自定义Docker映像的信息。
窗户
在Windows上,sample.ini
文件位于相同的目录defaults.ini
文件。它包含所有被注释掉的设置。复制sample.ini
给它命名custom.ini
.
macOS
缺省情况下,配置文件位于/usr/local/etc/grafana/grafana.ini
.对于使用Homebrew安装的Grafana实例,请编辑grafana.ini
直接文件。否则,添加一个名为custom.ini
到相依
中定义的设置conf / defaults.ini
.
删除.ini文件中的注释
Grafana使用分号(the;
类中的行注释. ini
文件。中的每一行都必须取消注释custom.ini
或者是grafana.ini
要删除的文件;
从这一行开始。否则,您的更改将被忽略。
例如:
#要使用的HTTP端口
使用环境变量重写配置
不使用环境变量添加新的配置设置。相反,使用环境变量覆盖现有的选项。
重写一个选项:
GF_ < SectionName > _ < KeyName >
其中,节名是括号内的文本。所有东西都应该大写,.
而且-
应由_
.例如,如果你有这些配置设置:
# default section instance_name = ${HOSTNAME} [security] admin_user = admin[认证]谷歌]client_secret = 0ldS3cretKey[插件。]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+中可用。
如果您的任何选项包含表达式美元__ <供应商>{<参数>}
或${<环境变量>}
,然后由Grafana的变量扩展器进行处理。展开器使用所提供的参数运行提供程序以获得选项的最终值。
有三个提供者:env
,文件
,库
.
Env提供者
的env
提供程序可用于展开环境变量。如果您将一个选项设置为美元__env{港口}
的港口
环境变量将被用于它的位置。对于环境变量,也可以使用简写语法${港口}
.Grafana的日志目录将设置为grafana
目录在目录后面LOGDIR
环境变量。
[paths] logs = $__env{LOGDIR}/grafana . log
文件提供者
文件
从文件系统中读取文件。它从文件的开头和结尾删除空白。的内容替换下例中的数据库密码/etc/secrets/gf_sql_password
文件:
[database] password = $__file{/etc/secrets/gf_sql_password}
库提供者
的库
提供商允许您管理您的秘密Hashicorp库.
保险库提供程序仅在Grafana Enterprise v7.1+中可用。有关更多信息,请参阅库集成在Grafana企业.
app_mode
选项是生产
而且发展
.默认是生产
.不除非你正在开发Grafana,否则请更改此选项。
instance_name
设置grafana-server实例的名称。用于日志记录、内部指标和集群信息。默认为:${主机名}
,该变量将被环境变量替换主机名
,如果它为空或不存在,Grafana将尝试使用系统调用来获取机器名。
force_migration
强制迁移将执行可能导致数据丢失的迁移。默认是假
.
(路径)
数据
Grafana存储sqlite3数据库(如果使用)、基于文件的会话(如果使用)和其他数据的路径。该路径通常通过init中的命令行指定。D脚本或systemd服务文件。
macOS:默认的SQLite数据库位于/usr/local/var/lib/grafana
temp_data_lifetime
临时图像在多长时间数据
应保存目录。默认为:24小时
.支持修饰符:h
(小时)米
(分钟),例如:168 h
,30米
,10 h30m
.使用0
永远不清理临时文件。
日志
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
.
插件
Grafana自动扫描和查找插件的目录。有关手动或自动安装插件的信息,请参见安装Grafana插件.
macOS:默认情况下,Mac插件的位置是:/usr/local/var/lib/grafana/plugins
.
供应
包含供应Grafana将在启动时应用的配置文件。当json文件发生变化时,仪表板将被重新加载。
(服务器)
协议
http
,https
,h2
或套接字
http_addr
要绑定的IP地址。如果为空将绑定到所有接口
http_port
要绑定的端口,默认为3000
.要使用端口80,你需要给Grafana二进制权限,例如:
$ 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前面放置一个网络服务器,如Nginx或Apache,并让他们代理请求到Grafana。
域
的一部分中使用此设置root_url
设置(见下文)。如果你使用GitHub或谷歌OAuth,这很重要。
enforce_domain
如果主机标头与域不匹配,则重定向到正确的域。防止DNS重绑定攻击。默认是假
.
root_url
这是用于从web浏览器访问Grafana的完整URL。如果您使用谷歌或GitHub OAuth身份验证(以便回调URL正确),这很重要。
注意:如果在Grafana前面有一个反向代理,通过子路径公开它,那么这个设置也很重要。在这种情况下,将子路径添加到URL设置的末尾。
serve_from_sub_path
中指定的子路径服务Grafanaroot_url
设置。默认设置为假
出于兼容性的考虑。
通过启用此设置并在中使用子路径root_url
以上,如。Root_url = http://localhost:3000/grafana
, Grafana可访问http://localhost:3000/grafana
.
router_logging
设置为真正的
为Grafana记录所有的HTTP请求(不只是错误)。这些被记录为Grafana日志中的Info级事件。
static_root_path
前端文件(HTML、JS和CSS文件)所在目录的路径。默认为公共
这就是为什么Grafana二进制文件需要在工作目录设置为安装路径的情况下执行。
enable_gzip
将此选项设置为真正的
启用HTTP压缩,这可以提高传输速度和带宽利用率。建议大多数用户设置为真正的
.默认设置为假
出于兼容性的考虑。
cert_file
证书文件的路径(如果协议
设置为https
或h2
).
cert_key
证书密钥文件的路径(如果协议
设置为https
或h2
).
socket_gid
时设置套接字的GID协议=套接字
.在更改此设置之前,请确保目标组在Grafana进程的组中,并且Grafana进程是文件所有者。建议将gid设置为http服务器用户gid。当值为-1时不设置。
socket_mode
时,套接字应设置的模式协议=套接字
.在更改此设置之前,请确保Grafana进程是文件所有者。
套接字
时应创建套接字的路径协议=套接字
.在更改此设置之前,请确保Grafana对该路径具有适当的权限。
cdn_url
请注意:在Grafana v7.4及更高版本中可用。
指定一个完整的HTTP URL地址到您的Grafana CDN资产的根。Grafana将添加版本和版本路径。
例如,给定一个cdn urlhttps://cdn.myserver.com
Grafana将尝试从http://cdn.myserver.com/grafana-oss/7.4.0/public/build/app。<散列> . js
.
read_timeout
使用持续时间格式(5s/5m/5ms)设置传入请求读取超时和关闭空闲连接之前的最大时间。0
表示读取请求时没有超时。
(server.custom_response_headers)
此设置使您能够指定服务器添加到HTTP(S)响应的附加头。
exampleHeader1 = exampleevalue1 exampleHeader2 = exampleevalue2
(数据库)
Grafana需要一个数据库来存储用户和仪表板(以及其他东西)。默认情况下,它被配置为使用sqlite3
这是一个嵌入式数据库(包含在主要的Grafana二进制文件中)。
类型
要么mysql
,postgres
或sqlite3
这是你的选择。
宿主
仅适用于MySQL或Postgres。包括IP或主机名和端口,如果是Unix套接字,则包括到它的路径。例如,MySQL和Grafana运行在同一台主机上:Host = 127.0.0.1:3306
或Unix套接字:Host = /var/run/mysqld/mysqld.sock
的名字
Grafana数据库的名称。设置为grafana
或者其他名字。
用户
数据库用户(不适用sqlite3
).
密码
数据库用户的密码(不适用于sqlite3
).如果密码包含#
或;
必须用三引号括起来。例如”“#密码;""
url
使用URL或下面的其他字段来配置数据库。mysql: / /用户:secret@host:港口/数据库
max_idle_conn
空闲连接池中的最大连接数。
max_open_conn
到数据库的最大打开连接数。
conn_max_lifetime
设置连接可重用的最大时间。默认值是14400(这意味着14400秒或4小时)。对于MySQL,此设置应短于wait_timeout
变量。
locking_attempt_timeout_sec
对于“mysql”,如果migrationLocking
设置了特性切换,指定迁移锁定数据库失败前的等待时间(以秒为单位)。默认值为0。
log_query
设置为真正的
记录SQL调用和执行时间。
ssl_mode
对于Postgres,两者都可以使用禁用
,需要
或verify-full
.对于MySQL,两者都可以真正的
,假
,或skip-verify
.
isolation_level
在Grafana中,只有MySQL驱动程序支持隔离级别。如果该值为空,则应用驱动程序的默认隔离级别。可选选项有“读未提交”、“读已提交”、“可重复读”或“可序列化”。
ca_cert_path
要使用的CA证书的路径。在许多Linux系统上,可以在/etc/ssl/certs
.
client_key_path
客户端密钥的路径。仅当服务器需要客户端身份验证时。
client_cert_path
客户端证书的路径。仅当服务器需要客户端身份验证时。
server_cert_name
属性所使用的证书的公共名称字段mysql
或postgres
服务器。如果没有必要ssl_mode
设置为skip-verify
.
路径
只适用于sqlite3
数据库。存储数据库的文件路径。
cache_mode
仅适用于“sqlite3”。共享缓存用于连接数据库的设置。(private, shared)默认为私人
.
细胞膜
仅适用于“sqlite3”。设置为启用/禁用写前日志记录.默认值为假
(禁用)。
query_retries
此设置适用于sqlite
仅和控制系统在数据库被锁定时重试查询的次数。默认值为0
(禁用)。
transaction_retries
此设置适用于sqlite
和控制当数据库被锁定时系统重试事务的次数。默认值为5
.
(remote_cache)
在配置的数据库、Redis或Memcached中缓存认证细节和会话信息。此设置不进行配置在Grafana企业查询缓存.
类型
要么复述,
,memcached
,或数据库
.默认为数据库
connstr
远程缓存连接字符串。格式取决于类型
远程缓存的。选项是数据库
,复述,
,memcache
.
数据库
使用时请留空数据库
因为它将使用主数据库。
复述,
示例connstr:addr = 127.0.0.1:6379 pool_size = 100,德国联邦铁路(db) = 0, ssl = false
addr
是宿主:
redis服务器端口。pool_size
(可选)是可以建立到redis的底层连接的数量。db
(可选)是要使用的redis数据库的编号标识符。ssl
(可选)是是否应该使用SSL连接到redis服务器。值可以是真正的
,假
,或不安全的
.将值设置为不安全的
在建立连接时跳过验证证书链和主机名。
memcache
示例connstr:127.0.0.1:11211
(dataproxy)
日志记录
这将启用数据代理日志记录,默认为假
.
超时
数据代理在超时前应该等待多长时间。默认为30秒。
此设置也适用于核心后端HTTP数据源,其中查询请求使用带超时设置的HTTP客户端。
keep_alive_seconds
保持活动探测之间的间隔。默认是30.
秒。有关详细信息,请查看拨号器。KeepAlive文档。
tls_handshake_timeout_seconds
Grafana等待与数据源成功TLS握手的时间长度。默认是10
秒。有关详细信息,请查看交通工具。TLSHandshakeTimeout文档。
expect_continue_timeout_seconds
如果请求有一个“Expect: 100-continue”报头,那么在完全写入请求报头之后,Grafana等待数据源第一个响应报头的时间长度。值为0
会导致尸体立即被送去。默认是1
第二。有关详细信息,请查看交通工具。ExpectContinueTimeout文档。
max_conns_per_host
可选地限制每台主机的连接总数,包括处于拨号、活动和空闲状态的连接。在违反限制时,表盘被阻塞。值为0
意味着没有限制。默认是0
.有关详细信息,请查看交通工具。MaxConnsPerHost文档。
max_idle_connections
Grafana将维持的最大空闲连接数。默认是One hundred.
.有关详细信息,请查看交通工具。MaxIdleConns文档。
idle_conn_timeout_seconds
Grafana在关闭空闲连接之前保持空闲连接的时间长度。默认是90
秒。有关详细信息,请查看交通工具。IdleConnTimeout文档。
send_user_header
如果启用,用户不是匿名的,数据代理将添加X-Grafana-User头与用户名到请求。默认是假
.
response_limit
限制从传出HTTP请求的响应中读取/接受的字节数。默认是0
也就是说不能用。
row_limit
限制Grafana将处理来自SQL(关系)数据源的行数。默认是1000000
.
[分析]
reporting_enabled
当启用时,Grafana将发送匿名使用统计信息到stats.grafana.org
.没有IP地址被跟踪,只有简单的计数器来跟踪运行实例、版本、仪表板和错误计数。这对我们很有帮助,所以请保持启用。计数器每24小时发送一次。默认值为真正的
.
check_for_updates
设置为false,禁用从Grafana的GitHub存储库检查新版本的Grafana。启用后,检查新版本每10分钟运行一次。当新版本可用时,它将通过UI通知。检查本身不会提示Grafana软件的任何自动更新,也不会发送任何敏感信息。
check_for_plugin_updates
请注意:在Grafana v8.5.0及更高版本中可用。
设置为false将禁用检查已安装插件的新版本//www.tubolov.com.启用后,每10分钟检查一次新插件。当有新的插件更新存在时,它会通过UI通知。检查本身不会提示插件的任何自动更新,也不会发送任何敏感信息。
google_analytics_ua_id
如果你想通过谷歌分析跟踪Grafana的使用,请指定你的万能分析ID在这里。默认情况下,该特性是禁用的。
google_analytics_4_id
如果你想通过谷歌Analytics跟踪Grafana的使用情况,请指定你的这里是GA4 ID。默认情况下,该特性是禁用的。
google_tag_manager_id
谷歌标签管理器ID,仅当您在这里输入ID时启用。
rudderstack_write_key
如果你想通过Rudderstack跟踪Grafana的使用,请指定你的舵台写键在这里。的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配置。
application_insights_connection_string
如果您想通过Azure应用程序洞察跟踪Grafana的使用情况,请指定你的Application Insights连接字符串。由于连接字符串包含分号,所以需要用反引号(')将其括起来。默认情况下,禁用跟踪使用情况。
application_insights_endpoint_url
可选地,使用此选项覆盖用于Application Insights数据收集的默认端点地址。详细信息请参见Azure的文档.
feedback_links_enabled
设置为假
从UI中删除所有反馈链接。默认是真正的
.
(安全)
disable_initial_admin_creation
仅在Grafana v6.5+中可用。
禁用在第一次启动Grafana时创建admin用户。默认是假
.
admin_user
默认的Grafana Admin用户名,具有完全权限。默认是管理
.
admin_password
默认的Grafana Admin的密码。第一次运行时设置一次。默认是管理
.
admin_email
默认的Grafana Admin的电子邮件,在启动时创建。默认是admin@localhost
.
secret_key
用于对一些数据源设置(如秘密和密码)签名,使用的加密格式是CFB模式下的AES-256。如果不更新数据源设置以重新编码,则无法更改。
disable_gravatar
设置为真正的
禁用用户档案图像使用Gravatar。默认是假
.
data_source_proxy_whitelist
定义一个允许的IP地址或域的白名单(带端口),在使用Grafana数据源代理的数据源url中使用。格式:ip_or_domain:端口
用空格分隔。PostgreSQL、MySQL和MSSQL数据源不使用代理,因此不受此设置的影响。
disable_brute_force_login_protection
设置为真正的
禁用强力登录保护.默认是假
.
cookie_secure
设置为真正的
如果你在HTTPS后面托管Grafana。默认是假
.
cookie_samesite
设置SameSite
Cookie属性,并防止浏览器在跨站点请求时发送此Cookie。主要目标是降低跨来源信息泄漏的风险。此设置还提供了一些针对跨站请求伪造攻击(CSRF)的保护,点击这里阅读更多关于SameSite的信息.有效值为宽松的
,严格的
,没有一个
,禁用
.默认是宽松的
.使用值禁用
不添加任何SameSite
属性为cookie。
allow_embedding
当假
, HTTP报头X-Frame-Options:否认
将在Grafana HTTP响应中设置,这将指示浏览器不允许在< >帧
,< iframe >
,<嵌入>
或<对象>
.主要目标是降低风险“点击劫持”.默认是假
.
strict_transport_security
设置为真正的
如果您想启用HTTPStrict-Transport-Security
(HSTS)响应头。只有当您的配置中启用了HTTPS,或者当有另一个上游系统确保您的应用程序执行HTTPS时(如前端负载平衡器),才使用此选项。HSTS告诉浏览器只能使用HTTPS访问站点。
strict_transport_security_max_age_seconds
设置浏览器缓存HSTS的时间(以秒为单位)。仅在启用strict_transport_security时应用。默认值为86400
.
strict_transport_security_preload
设置为真正的
启用HSTS预压法
选择。仅在启用strict_transport_security时应用。默认值为假
.
strict_transport_security_subdomains
设置为真正的
如果启用HSTS inclesubdomains选项。仅在启用strict_transport_security时应用。默认值为假
.
x_content_type_options
设置为真正的
启用X-Content-Type-Options响应头。X-Content-Type-Options响应HTTP报头是服务器使用的一个标记,用于指示在Content-Type报头中发布的MIME类型不应该被更改和遵循。默认值为假
.
x_xss_protection
设置为假
禁用X-XSS-Protection报头,该报头告诉浏览器在检测到反射的跨站脚本攻击(XSS)时停止加载页面。默认值为假
在下一个小版本之前,6.3
.
content_security_policy
设置为真正的
向请求添加内容安全策略报头。CSP允许控制用户代理可以加载的资源,并有助于防止XSS攻击。
content_security_policy_template
属性时使用的策略模板Content-Security-Policy
标题到您的请求。目前美元
在模板中包含一个随机的nonce。
content_security_policy_report_only
设置为真正的
要添加Content-Security-Policy-Report-Only
标题到您的请求。“仅报告”模式下的CSP允许您通过监视策略的效果而不强制执行策略来试验策略。您可以同时启用这两个策略。
content_security_policy_template
属性时使用的策略模板Content-Security-Policy-Report-Only
标题到您的请求。目前美元
在模板中包含一个随机的nonce。
angular_support_enabled
目前默认为真正的
但会默认为假
在未来的版本中。当设置为false时,angular框架和支持组件将不会被加载。这意味着所有依赖于angular支持的插件和核心功能都将停止工作。
将停止工作的当前核心功能:
- 热图面板
- 旧图形面板
- 旧桌板
- Postgres, MySQL和MSSQL数据源查询编辑器
- 遗留的警报编辑规则UI
在我们默认禁用angular支持之前,我们计划将这些剩余区域迁移到React中。
csrf_trusted_origins
允许通过CSRF检查的其他url的列表。当身份验证来自IdP时建议。
csrf_additional_headers
允许用户设置的头的列表。如果身份验证位于反向代理之后,建议使用for。
(快照)
启用
设置为假
禁用快照特性(默认)真正的
).
external_enabled
设置为假
禁用外部快照发布端点(默认值)真正的
).
external_snapshot_url
将根URL设置为您想要发布外部快照的Grafana实例(默认为https://snapshots.raintank.io).
external_snapshot_name
设置外部快照按钮的名称。默认为发布到snapshot .raintank.io
.
public_mode
将该Grafana实例设置为true以启用该Grafana实例作为外部快照服务器,并允许未经身份验证的创建和删除快照请求。默认是假
.
snapshot_remove_expired
启用此功能可自动删除过期的快照。默认是真正的
.
(仪表板)
versions_to_keep
要保留的指示板版本编号(每个指示板)。默认值:20.
最低:1
.
min_refresh_interval
仅在Grafana v6.7+中可用。
该特性防止用户将仪表板刷新间隔设置为低于给定间隔值的值。缺省值为5秒。间隔字符串可能是十进制数字的有符号序列,后面跟着一个单位后缀(ms, s, m, h, d),例如。30年代
或1米
.
从Grafana v7.3开始,这也限制了Explore中的刷新间隔选项。
default_home_dashboard_path
默认主仪表板的路径。如果这个值为空,那么Grafana使用StaticRootPath + " dashboards/home.json "。
注意:在Linux上,Grafana使用
/usr/share/grafana/public/dashboards/home.json
作为默认的主仪表板位置。
(用户)
allow_sign_up
设置为假
禁止用户注册/创建用户帐户。默认是假
.admin用户仍然可以创建用户。有关创建用户的详细信息,请参见添加用户.
allow_org_create
设置为假
禁止用户创建新的组织。默认是假
.
auto_assign_org
设置为真正的
,自动将新用户添加到主组织(id 1)假
,新用户会自动为该新用户创建一个新组织。组织将被创建,即使allow_org_create
设置设置为假
.默认是真正的
.
auto_assign_org_id
设置此值可自动向所提供的组织添加新用户。这需要auto_assign_org
设置为真正的
.请确保该组织已经存在。默认值是1。
auto_assign_org_role
角色新用户将被分配给主组织(如果上述设置设置为true)。默认为查看器
,其他有效选项为管理
而且编辑器
.例如:
auto_assign_org_role =查看器
verify_email_enabled
注册完成前需要电子邮件验证。默认是假
.
login_hint
在登录页面上用于登录/用户名输入的占位符文本。
password_hint
在登录页面上用于密码输入的占位符文本。
default_theme
设置默认的UI主题:黑暗
,光
,或系统
.默认主题为黑暗
.
系统
匹配用户的系统主题。
default_language
此设置配置默认的UI语言,该语言必须是受支持的IETF语言标记,例如en - us
.
home_page
自定义主页的路径。只有在使用默认的主仪表板时,用户才会被重定向到该仪表板。它应该匹配前端路由并包含一个前导斜杠。
外部用户管理
如果您在外部管理用户,则可以使用到外部站点的链接以及描述替换组织的用户邀请按钮。
viewers_can_edit
查看器可以访问和使用探索并对他们可以访问的仪表板中的面板执行临时编辑。它们不能保存更改。默认是假
.
editors_can_admin
编辑可以管理他们创建的仪表板、文件夹和团队。默认是假
.
user_invite_max_lifetime_duration
用户邀请在过期前仍然有效的时间。这个设置应该表示为持续时间。例如:6h(小时),2d(天),1w(周)。默认是24小时
(24小时)。支持的最小持续时间为15米
(15分钟)。
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
设置为真正的
禁用侧菜单中的签出链接。如果使用auth.proxy,这很有用。默认是假
.
signout_redirect_url
用户退出后重定向到的URL。
oauth_auto_login
请注意:该选项不推荐使用
auto_login
选择特定的OAuth提供程序。
设置为真正的
尝试用OAuth自动登录,跳过登录屏幕。如果配置了多个OAuth提供程序,则忽略此设置。默认是假
.
oauth_state_cookie_max_age
OAuth状态cookie在被删除之前存在的秒数。默认是600
(秒)如果管理员遇到OAuth登录状态不匹配错误,可以增加这个值。
oauth_skip_org_role_update_sync
请注意:该选项已弃用,支持特定于OAuth提供程序的选项
skip_org_role_sync
设置。下面几节将解释每个提供程序的设置。
跳过强制分配OrgID1
或auto_assign_org_id
用于外部登录。默认是假
.使用此设置可允许将具有外部登录的用户手动分配给多个组织。
默认情况下,用户的组织和角色将在每次新登录时重置。
警告:目前如果没有找到用户的组织角色映射,Grafana不会更新用户的组织角色。对于Grafana 10,如果
oauth_skip_org_role_update_sync
选项设置为假
,没有映射的用户将在每次登录时被重置为默认的组织角色。看到auto_assign_org_role
选项.
skip_org_role_sync
为防止特定OAuth集成的组织角色同步,可以设置skip_org_role_sync
选项真正的
.当您希望从Grafana内部管理用户的组织角色时,或者当您希望防止从另一个提供者同步用户时发生同步冲突时,此选项非常有用。
(auth.grafana_com)skip_org_role_sync
为防止特定OAuth集成的组织角色同步,可以设置skip_org_role_sync
选项真正的
.请注意,有一个已弃用的设置称为oauth_skip_org_role_update_sync
它有不同的作用域。而skip_org_role_sync
只适用于特定的OAuth提供商,oauth_skip_org_role_update_sync
是影响所有已配置OAuth提供程序的通用设置。
下表显示了OAuth提供程序及其默认值和跳过组织角色同步设置。
OAuth提供者 | oauth_skip_org_role_sync_update |
skip_org_role_sync |
行为 |
---|---|---|---|
Grafana.com | 假 | 假 | 将与Grafana.com角色同步 |
Grafana.com | 真正的 | 假 | 对于OAuth提供者(包括Grafana.com用户)跳过组织角色同步 |
Grafana.com | 假 | 真正的 | 对于www.tubolov.com用户跳过org角色同步 |
Grafana.com | 真正的 | 真正的 | 对于Grafana.com用户和所有其他OAuth提供者,跳过组织角色同步 |
(auth.azuread)skip_org_role_sync
为防止特定OAuth集成的组织角色同步,可以设置skip_org_role_sync
选项真正的
.请注意,有一个已弃用的设置称为oauth_skip_org_role_update_sync
它有不同的作用域。而skip_org_role_sync
只适用于特定的OAuth提供商,oauth_skip_org_role_update_sync
是影响所有已配置OAuth提供程序的通用设置。
下表显示了OAuth提供程序的设置以及默认值和跳过组织角色同步设置。
OAuth提供者 | oauth_skip_org_role_sync_update |
skip_org_role_sync |
行为 |
---|---|---|---|
AzureAD | 假 | 假 | 将与AzureAD角色同步 |
AzureAD | 真正的 | 假 | 对于OAuth提供者(包括AzureAD用户)跳过组织角色同步 |
AzureAD | 假 | 真正的 | AzureAD用户跳过org角色同步 |
AzureAD | 真正的 | 真正的 | 跳过组织角色同步AzureAD用户和所有其他OAuth提供者 |
(auth.google)skip_org_role_sync
为防止特定OAuth集成的组织角色同步,可以设置skip_org_role_sync
选项真正的
.请注意,有一个已弃用的设置称为oauth_skip_org_role_update_sync
它有不同的作用域。而skip_org_role_sync
只适用于特定的OAuth提供商,oauth_skip_org_role_update_sync
是影响所有已配置OAuth提供程序的通用设置。
下表显示了OAuth提供程序的设置以及默认值和跳过组织角色同步设置。
OAuth提供者 | oauth_skip_org_role_sync_update |
skip_org_role_sync |
行为 |
---|---|---|---|
谷歌 | 假 | 假 | 设置用户组织角色defaultRole 无法改变 |
谷歌 | 真正的 | 假 | 设置用户组织角色defaultRole 谷歌。对于其他提供者,同步将被跳过,并且可以更改org角色,以及其他OAuth提供者用户的org角色。 |
谷歌 | 假 | 真正的 | 设置用户组织角色defaultRole 对于谷歌同步用户,可以更改org角色。 |
谷歌 | 真正的 | 真正的 | 设置用户组织角色defaultRole 谷歌。对于其他提供者,同步将被跳过,并且可以更改org角色,以及其他OAuth提供者用户的org角色。 |
(auth.github)skip_org_role_sync
为防止特定OAuth集成的组织角色同步,可以设置skip_org_role_sync
选项真正的
.当用户第一次登录时,Grafana会根据中指定的值设置组织角色AutoAssignOrgRole
.如果需要管理组织角色,请设置skip_org_role_sync
选项真正的
.GitHub同步组织角色并设置Grafana管理员。这也会影响allow_assign_grafana_admin
设置,通过不从GitHub同步grafana管理角色。
请注意,有一个已弃用的设置称为oauth_skip_org_role_update_sync
它有不同的作用域。而skip_org_role_sync
只适用于特定的OAuth提供商,oauth_skip_org_role_update_sync
是影响所有已配置OAuth提供程序的通用设置。
下表显示了OAuth提供程序的设置以及默认值和跳过组织角色同步设置。
OAuth提供者 | oauth_skip_org_role_sync_update |
skip_org_role_sync |
行为 |
---|---|---|---|
GitHub | 假 | 假 | 设置用户组织角色defaultRole 无法改变 |
Github | 真正的 | 假 | 设置用户组织角色defaultRole GitHub和Grafana Admins设置。对于其他提供者,将跳过同步,可以更改org角色以及其他OAuth提供者用户的org角色。 |
GitHub | 假 | 真正的 | 设置用户组织角色defaultRole ,对于已同步GitHub的用户,可以修改组织角色。 |
GitHub | 真正的 | 真正的 | 设置用户组织角色defaultRole 谷歌。对于其他提供者,将跳过同步,可以更改org角色以及其他OAuth提供者用户的org角色。 |
(auth.gitlab)skip_org_role_sync
为防止特定OAuth集成的组织角色同步,可以设置skip_org_role_sync
选项真正的
.当用户第一次登录时,Grafana会根据中指定的值设置组织角色AutoAssignOrgRole
.如果需要管理组织角色,请设置skip_org_role_sync
选项真正的
.GitLab同步组织角色并设置Grafana管理员。这也会影响allow_assign_grafana_admin
设置,通过不从GitLab同步grafana管理角色。
注意:有一个被弃用的设置叫做
oauth_skip_org_role_update_sync
它有不同的作用域。而skip_org_role_sync
只适用于特定的OAuth提供商,oauth_skip_org_role_update_sync
是影响所有已配置OAuth提供程序的通用设置。
下表显示了OAuth提供程序的设置以及默认值和跳过组织角色同步设置。
OAuth提供者 | oauth_skip_org_role_sync_update |
skip_org_role_sync |
行为 |
---|---|---|---|
GitLab | 假 | 假 | 设置用户组织角色defaultRole 无法改变 |
GitLab | 真正的 | 假 | 设置用户组织角色defaultRole 设置了GitLab和Grafana Admins。对于其他提供者,将跳过同步,可以更改org角色以及其他OAuth提供者用户的org角色。 |
GitLab | 假 | 真正的 | 设置用户组织角色defaultRole ,对于GitLab同步的用户,可以修改组织角色。 |
GitLab | 真正的 | 真正的 | 设置用户组织角色defaultRole GitLab。对于其他提供者,将跳过同步,可以更改org角色以及其他OAuth提供者用户的org角色。 |
(auth.generic_oauth)skip_org_role_sync
为防止特定OAuth集成的组织角色同步,可以设置skip_org_role_sync
选项真正的
.当用户第一次登录时,Grafana会根据中指定的值设置组织角色AutoAssignOrgRole
.如果需要管理组织角色,请设置skip_org_role_sync
选项真正的
.OAuth同步组织角色并设置Grafana Admins。这也会影响allow_assign_grafana_admin
设置,通过不从OAuth提供者同步grafana管理角色。
注意:有一个被弃用的设置叫做
oauth_skip_org_role_update_sync
它有不同的作用域。而skip_org_role_sync
只适用于特定的OAuth提供商,oauth_skip_org_role_update_sync
是影响所有已配置OAuth提供程序的通用设置。
下表显示了OAuth提供程序的设置以及默认值和跳过组织角色同步设置。
OAuth提供者 | oauth_skip_org_role_sync_update |
skip_org_role_sync |
行为 |
---|---|---|---|
通用的OAuth | 假 | 假 | 设置用户组织角色defaultRole 无法改变 |
通用的OAuth | 真正的 | 假 | 设置用户组织角色defaultRole Generic OAuth,和Grafana Admins设置。对于其他提供者,将跳过同步,可以更改org角色以及其他OAuth提供者用户的org角色。 |
通用的OAuth | 假 | 真正的 | 设置用户组织角色defaultRole ,对于Generic OAuth同步用户,可以更改组织角色。 |
通用的OAuth | 真正的 | 真正的 | 设置用户组织角色defaultRole 通用OAuth。对于其他提供者,将跳过同步,可以更改org角色以及其他OAuth提供者用户的org角色。 |
(auth.okta)skip_org_role_sync
为防止特定OAuth集成的组织角色同步,可以设置skip_org_role_sync
选项真正的
.当用户第一次登录时,Grafana会根据中指定的值设置组织角色AutoAssignOrgRole
.如果需要管理组织角色,请设置skip_org_role_sync
选项真正的
.Okta同步组织角色并设置Grafana Admins。这也会影响allow_assign_grafana_admin
设置,通过不从Okta同步grafana管理角色。
注意:有一个被弃用的设置叫做
oauth_skip_org_role_update_sync
它有不同的作用域。而skip_org_role_sync
只适用于特定的OAuth提供商,oauth_skip_org_role_update_sync
是影响所有已配置OAuth提供程序的通用设置。
下表显示了OAuth提供程序的设置以及默认值和跳过组织角色同步设置。
OAuth提供者 | oauth_skip_org_role_sync_update |
skip_org_role_sync |
行为 |
---|---|---|---|
Okta | 假 | 假 | 设置用户组织角色defaultRole 并且无法改变。 |
Github | 真正的 | 假 | 设置用户组织角色defaultRole 设置了Okta和Grafana Admins。对于其他提供者,将跳过同步,可以更改org角色以及其他OAuth提供者用户的org角色。 |
Okta | 假 | 真正的 | 设置用户组织角色defaultRole , Okta同步用户可以修改组织角色。 |
Okta | 真正的 | 真正的 | 设置用户组织角色defaultRole Okta。对于其他提供者,将跳过同步,可以更改org角色以及其他OAuth提供者用户的org角色。 |
api_key_max_seconds_to_live
API密钥在过期前的存活秒数限制。默认值是-1(无限制)。
sigv4_auth_enabled
仅在Grafana 7.3+中可用。
设置为真正的
为基于http的数据源启用AWS Signature Version 4身份验证选项。默认是假
.
sigv4_verbose_logging
仅在Grafana 8.4+中可用。
设置为真正的
在启用AWS签名版本4身份验证时启用详细请求签名日志。默认是假
.
(auth.anonymous)
指匿名身份验证详细说明。
(auth.github)
指GitHub OAuth2认证详细说明。
(auth.gitlab)
指Gitlab OAuth2认证详细说明。
(auth.google)
指谷歌OAuth2认证详细说明。
(auth.grafananet)
遗留键名,仍然在配置文件中,所以它们在env变量中工作。
(auth.grafana_com)
遗留键名,仍然在配置文件中,所以它们在env变量中工作。
(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插件允许的身份验证提供程序。有关允许提供程序的列表,请参考给定插件的数据源配置页面。如果您通过provisioning配置插件,则只配置中指定的提供商allowed_auth_providers
是允许的。
选项:默认的
(AWS SDK默认),键
(存取及秘钥),凭证
(凭证文件),ec2_iam_role
(EC2 IAM角色)
assume_role_enabled
设置为假
禁止AWS身份验证使用具有临时安全凭据的假定角色。关于假设角色的详细信息,请参见AWS API参考文档AssumeRole操作。
如果禁用此选项,则假设的作用和外部Id字段将从AWS数据源配置页面中删除。如果插件是使用预置配置的,它可以使用一个假定的角色,只要assume_role_enabled
设置为真正的
.
list_metrics_page_limit
使用列表指标API选项来加载CloudWatch数据源中自定义名称空间的指标。缺省情况下,页面限制为500页。
(azure)
当托管在Azure云中时,Grafana支持与Azure服务的额外集成。
云
托管Grafana的Azure云环境:
Azure云 | 价值 |
---|---|
微软Azure公共云 | AzureCloud (默认的) |
微软中国国家云 | AzureChinaCloud |
美国政府云 | AzureUSGovernment |
微软德国国家云(“黑森林”) | AzureGermanCloud |
managed_identity_enabled
指定是否配置了托管身份的Grafana托管在Azure服务中(例如Azure虚拟机实例)。默认为禁用,需要显式启用。
managed_identity_client_id
用于用户分配的托管标识的客户端ID。
对于用户分配的标识应设置为空,对于系统分配的标识应设置为空。
(auth.jwt)
指JWT身份验证获取更多信息。
(smtp)
邮件服务器设置。
启用
启用此选项允许Grafana发送电子邮件。默认是假
.
宿主
默认是localhost: 25
.
用户
在SMTP认证的情况下,默认为空
.
密码
在SMTP认证的情况下,默认为空
.如果密码包含#
或;
,然后你必须用三引号把它括起来。示例:“”“#密码;”""
cert_file
证书文件的路径,默认为空
.
key_file
密钥文件的文件路径,默认为空
.
skip_verify
验证SMTP服务器的SSL,默认为假
.
from_address
发送邮件时使用的地址,默认为admin@grafana.localhost
.
from_name
发送电子邮件时使用的名称,默认为Grafana
.
ehlo_identity
在SMTP对话框中作为EHLO客户端身份的名称,默认为< instance_name >
.
startTLS_policy
“投机的starttls”,“强制的starttls”,“NoStartTLS”。默认是空
.
(电子邮件)
welcome_email_on_sign_up
默认是假
.
templates_pattern
输入一个以逗号分隔的模板模式列表。默认是电子邮件/ * . html,邮件/ * . txt
.
content_types
输入一个以逗号分隔的内容类型列表,内容类型应包含在发送的电子邮件中。按优先级降序列出内容类型,例如:text / html、文本/平原
HTML是最受欢迎的。各部分的顺序很重要,因为邮件客户端将使用发件人支持和最喜欢的内容类型。支持的内容类型包括text / html
而且文本/平原
.默认是text / html
.
(日志)
Grafana测井选项。
模式
可选:console、file和syslog。默认为“console”和“file”。使用空格分隔多个模式,例如:控制台文件
.
水平
可选值为debug、info、warn、error和critical。默认是信息
.
过滤器
可选设置,为特定的记录器设置不同的级别。例如:过滤器= sqlstore:调试
(log.console)
中使用“console”时才适用(日志)
模式。
水平
可选值为debug、info、warn、error和critical。默认值从(日志)
的水平。
格式
日志行格式,有效选项为text, console和json。默认是控制台
.
(log.file)
只适用于“文件”使用时(日志)
模式。
水平
可选值为debug、info、warn、error和critical。默认值从(日志)
的水平。
格式
日志行格式,有效选项为text, console和json。默认是文本
.
log_rotate
启用自动日志旋转,有效的选项是假
或真正的
.默认是真正的
.启用时,请使用max_lines
,max_size_shift
,daily_rotate
而且max_days
配置日志旋转的行为。
max_lines
旋转前每个文件最多行数。默认是1000000
.
max_size_shift
文件旋转前的最大大小。默认是28
,这意味着1 << 28
,256 mb
.
daily_rotate
启用每日轮换文件,有效的选项是假
或真正的
.默认是真正的
.
max_days
日志文件保存的最大天数。默认是7
.
(log.syslog)
中使用“syslog”时才适用(日志)
模式。
水平
可选值为debug、info、warn、error和critical。默认值从(日志)
的水平。
格式
日志行格式,有效选项为text、console和json。默认是文本
.
网络和地址
Syslog网络类型和地址。可以是UDP、TCP或UNIX。如果为空,则使用默认的UNIX端点。
设施
Syslog工具。有效选项为user、daemon或local0到local7。默认为空。
标签
Syslog标签。默认情况下,进程的argv [0]
使用。
(log.frontend)
注意:该特性在Grafana 7.4+中可用。
启用
哨兵javascript代理初始化。默认是假
.
提供者
定义要使用的提供程序哨兵
或grafana
.默认是哨兵
sentry_dsn
哨兵DSN如果你想发送事件到哨兵
custom_endpoint
自定义HTTP端点,将哨兵代理捕获的事件发送到。默认情况下,/日志
,将事件记录到标准输出。
sample_rate
之间要报告的事件的比率0
(没有),1
(all, default), float。
log_endpoint_requests_per_second_limit
对于Grafana后端日志摄取端点,每延长一段时间强制执行每秒请求限制,/日志
.默认是3.
.
log_endpoint_burst_limit
Grafana后端日志摄取端点在短时间间隔内接受的最大请求,/日志
.默认是15
.
instrumentations_errors_enabled
打开错误检测。仅影响Grafana Javascript代理。
instrumentations_console_enabled
打开控制台仪表。仅影响Grafana Javascript代理
instrumentations_webvitals_enabled
打开webvital仪表。仅影响Grafana Javascript代理
api_key
如果custom_endpoint
必需的身份验证,您可以在这里设置API密钥。仅与Grafana Javascript代理提供商相关。
(配额)
将配额设置为-1
使无限。
启用
启用使用配额。默认是假
.
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(无限制)。
(unified_alerting)
有关Grafana警报的更多信息,请参阅关于Grafana Alerting.
启用
启用或禁用Grafana告警。如果禁用,您的所有遗留警报数据将再次可用,但您使用Grafana警报创建的数据将被删除。设置force_migration=true,避免删除数据。默认值为真正的
.
从仪表板和面板迁移的警报规则将包括通过注释
.
disabled_orgs
要禁用Grafana 8统一告警的组织id列表,以逗号分隔。
admin_config_poll_interval
指定管理配置更改的轮询频率。默认值为60年代
.
间隔字符串可能是十进制数字的有符号序列,后面跟着一个单位后缀(ms, s, m, h, d),例如30s或1m。
alertmanager_config_poll_interval
指定轮询Alertmanager配置更改的频率。默认值为60年代
.
间隔字符串可能是十进制数字的有符号序列,后面跟着一个单位后缀(ms, s, m, h, d),例如30s或1m。
ha_listen_address
监听IP地址和端口,接收其他Grafana实例的统一告警消息。同时用于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)。然后我们将这个位置与超时相乘,以指示每个实例在发送通知之前应该等待多长时间,以考虑复制延迟。默认值为15秒
.
间隔字符串可能是十进制数字的有符号序列,后面跟着一个单位后缀(ms, s, m, h, d),例如30s或1m。
ha_gossip_interval
发送八卦信息的间隔时间。通过降低该值(更频繁),八卦消息可以更快地在集群中传播,但以增加带宽使用为代价。默认值为200毫秒
.
间隔字符串可能是十进制数字的有符号序列,后面跟着一个单位后缀(ms, s, m, h, d),例如30s或1m。
ha_push_pull_interval
八卦完全状态同步的时间间隔。将此间隔设置得更低(更频繁)将提高较大集群的收敛速度,但以增加带宽使用为代价。默认值为60年代
.
间隔字符串可能是十进制数字的有符号序列,后面跟着一个单位后缀(ms, s, m, h, d),例如30s或1m。
execute_alerts
启用或禁用警报规则执行。默认值为真正的
.警报UI仍然可见。这个选项有一个在警报部分中的遗留版本这是优先考虑的。
evaluation_timeout
设置从数据源获取数据时的警报计算超时。默认值为30年代
.这个选项有一个在警报部分中的遗留版本这是优先考虑的。
超时字符串可能是十进制数字的有符号序列,后面跟着一个单位后缀(ms, s, m, h, d),例如30s或1m。
max_attempts
设置在放弃对警报规则求值之前尝试求值的最大次数。默认值为3.
.这个选项有一个在警报部分中的遗留版本这是优先考虑的。
min_interval
设置在规则计算之间强制执行的最小间隔。默认值为十年代
它等于调度器间隔。如果规则小于此值或不是调度程序间隔(10秒)的倍数,则将对规则进行调整。较高的值有助于资源管理,因为随着时间的推移,我们将安排更少的评估。这个选项有警报部分的旧版本这是优先考虑的。
间隔字符串可能是十进制数字的有符号序列,后面跟着一个单位后缀(ms, s, m, h, d),例如30s或1m。
请注意。此设置优先于每个单独的规则频率。如果规则频率低于此值,则强制执行此值。
(unified_alerting.screenshots)
有关截图的更多信息,请参阅[通知中的图像(//www.tubolov.com/docs/grafana/next/alerting/manage-notifications/images-in-notifications)]。
捕获
在通知中启用截图。此选项需要远程HTTP图像呈现服务。请参阅(呈现)
有关进一步的配置选项。
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 alert引擎添加的保留标签列表,以逗号分隔,应该禁用。
例如:disabled_labels = grafana_folder
(报警)
有关Grafana中遗留仪表板警报功能的更多信息,请参阅遗产Grafana警报.
启用
设置为真正的
来启用遗留仪表板警报.默认值为假
.
execute_alerts
关闭警报规则执行,但是在Grafana UI中仍然可以看到警报。
error_or_timeout
新警报规则的默认设置。默认将错误和超时归类为警报。(keep_state报警)
nodata_or_nullvalues
定义Grafana如何处理警报中的nodata或null值。选项是报警
,no_data
,keep_state
,好吧
.默认是no_data
.
concurrent_render_limit
警报通知可以包含图像,但同时呈现许多图像会使服务器过载。这个限制可以防止服务器渲染过载,并确保通知能够快速发送出去。默认值为5
.
evaluation_timeout_seconds
设置告警计算超时时间。默认值为30.
.
notification_timeout_seconds
设置告警通知超时时间。默认值为30.
.
max_attempts
设置发送警报通知的最大尝试限制。默认值为3.
.
min_interval_seconds
设置规则计算之间的最小间隔。默认值为1
.
请注意。此设置优先于每个单独的规则频率。如果规则频率低于此值,则强制执行此值。
max_annotation_age =
配置警报注释的存储时间。默认值是0,这将永远保存它们。这个设置应该表示为持续时间。例如:6h(小时),10d(天),2w(周),1M(月)。
max_annotations_to_keep =
配置Grafana存储的警报注释的最大数量。默认值为0,保留所有警报注释。
[注释]
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部分。默认是启用
.
(帮助)
配置帮助部分。
启用
启用或禁用帮助部分。默认是启用
.
(概要)
配置Profile部分。
启用
启用或禁用Profile部分。默认是启用
.
(query_history)
在Explore中配置查询历史。
启用
启用或禁用查询历史记录。默认是启用
.
(指标)
有关详细说明,请参阅内部Grafana度量.
启用
启用度量报告。违约事实。可通过HTTP API获取< URL > /指标
.
interval_seconds
将指标发送到外部TSDB时的刷新/写入间隔。默认为10
.
disable_total_stats
如果设置为真正的
,则总统计数据生成(stat_totals_ *
Metrics)已禁用。默认是假
.
Basic_auth_username和basic_auth_password
如果两者都设置了,则需要基本身份验证才能访问度量端点。
(metrics.environment_info)
添加维度到grafana_environment_info
度量,它可以公开关于Grafana实例的更多信息。
;exampleLabel1 = exampleValue1;exampleLabel2 = exampleValue2
(metrics.graphite)
如果您想将内部的Grafana度量发送到Graphite,请使用这些选项。
地址
通过设置地址启用。格式是<主机名或ip>
:端口。
前缀
石墨公制前缀。默认为prod.grafana. % (instance_name)。
(grafana_net)
url
(grafana_com)
url
(tracing.jaeger)
[已弃用-使用trace . opentelementary .jaeger或trace . opentelementary .otlp代替]
为分布式跟踪配置Grafana的Jaeger客户端。
您也可以使用标准JAEGER_ *
环境变量来配置积家。请看后面的表格https://www.jaegertracing.io/docs/1.16/client-features/完整的列表。环境变量将覆盖这里提供的任何设置。
地址
主机:报告范围的端口目的地。(例:localhost: 6831
)
可以用环境变量设置吗JAEGER_AGENT_HOST
而且JAEGER_AGENT_PORT
.
always_included_tag
要包含在所有新span中的逗号分隔的标记列表,例如标签1:value1,标签2:value2
.
可以用环境变量设置吗JAEGER_TAGS
(使用=
而不是:
使用环境变量)。
sampler_type
默认值为常量
.
指定采样器的类型:常量
,概率
,ratelimiting
,或远程
.
指https://www.jaegertracing.io/docs/1.16/sampling/#client-sampling-configuration查看不同跟踪类型的详细信息。
可以用环境变量设置吗JAEGER_SAMPLER_TYPE
.
sampler_param
默认值为1
.
这是采样器配置参数。的值sampler_type
,它可以是0
,1
,或介于两者之间的十进制值。
- 为
常量
取样器,0
或1
为了永远假
/真正的
分别 - 为
概率
抽样器,两者之间的概率0
而且1.0
- 为
rateLimiting
采样器,每秒的跨度数 - 为
远程
采样器,参数与for相同概率
表示从母舰接收到实际采样率之前的初始采样率
可以用环境变量设置吗JAEGER_SAMPLER_PARAM
.
sampling_server_url
sampling_server_url是提供抽样策略的抽样管理器的URL。
zipkin_propagation
默认值为假
.
控制是否使用Zipkin的跨度传播格式(使用x-b3 -
HTTP头信息)。默认情况下,使用Jaeger格式。
可以用环境变量和值设置吗JAEGER_PROPAGATION = b3
.
disable_shared_zipkin_spans
默认值为假
.
将此设置为真正的
关闭共享RPC跨度。当在基础设施的其他地方使用Zipkin时,最常见的设置是让它可用。
(tracing.opentelemetry)
配置OpenTelemetry提供者之间共享的通用参数。
custom_attributes
要包含在所有新span中的属性的逗号分隔列表,例如key1: value1, key2: value2
.
可以用环境变量设置吗OTEL_RESOURCE_ATTRIBUTES
(使用=
而不是:
使用环境变量)。
(tracing.opentelemetry.jaeger)
为分布式跟踪配置Grafana的Jaeger客户端。
地址
主机:报告范围的端口目的地。(例:localhost: 14268 / api /痕迹
)
传播
传播指定文本映射传播格式。(例如:jaeger, w3c)
(tracing.opentelemetry.otlp)
为分布式跟踪配置Grafana的otlp客户端。
地址
主机:报告范围的端口目的地。(例:localhost: 4317
)
传播
传播指定文本映射传播格式。(例如:jaeger, w3c)
(external_image_storage)
这些选项控制图像应该如何公开,以便在Slack或电子邮件信息等服务上共享。
提供者
选项有s3, webdav, gcs, azure_blob, local)。如果为空,则Grafana忽略上传操作。
(external_image_storage.s3)
端点
可选端点URL(主机名或完全限定URI),用于覆盖默认生成的S3端点。如果您想保持默认值,请将其保留为空。您仍然必须提供一个地区
值,如果指定端点。
path_style_access
将此设置为true以强制在S3请求中使用路径样式寻址,例如,http://s3.amazonaws.com/BUCKET/KEY
,而不是默认的虚拟托管桶寻址(http://BUCKET.s3.amazonaws.com/KEY
).
注意:此选项特定于Amazon S3服务。
bucket_url
(为了向后兼容,只在没有配置桶和区域的情况下生效)S3的桶URL。AWS区域可以在URL中指定,或默认为“us-east-1”。
桶
S3的桶名。例如grafana.snapshot。
地区
S3的区域名称。例如“us-east-1”,“cn-north-1”等。
路径
桶内可选的额外路径,用于应用过期策略。
access_key
访问键,例如aaaaaaaaaaaaaaaaaaaaaa。
Access key需要S3 bucket的' S3:PutObject '和' S3:PutObjectAcl '操作的权限。
secret_key
密钥,例如aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa。
(external_image_storage.webdav)
url
Grafana发送带有图片的PUT请求的URL。
用户名
基本认证用户名。
密码
基本认证密码。
public_url
可选的URL发送给用户的通知。如果字符串包含序列$ {file}
时,它被替换为上传的文件名。否则,文件名将被追加到URL的路径部分,而不改变任何查询字符串。
(external_image_storage.gcs)
key_file
用于验证和授权的与谷歌服务帐户关联的JSON密钥文件的可选路径。如果没有提供值,则尝试使用应用程序默认凭据.服务帐户密钥可以创建和下载https://console.developers.google.com/permissions/serviceaccounts.
服务帐户应具有“存储对象写入器”角色。桶的访问控制模型需要为“设置对象级和桶级权限”。当签名url未启用时,Grafana本身将使图像公共可读。
桶
谷歌云存储中的桶名。
路径
桶内可选的额外路径。
enable_signed_urls
如果设置为true, Grafana将创建一个签署的URL为上传到谷歌云存储的图像。
signed_url_expiration
设置签名URL的过期时间,默认为7天。
(external_image_storage.azure_blob)
account_name
存储帐户名称。
account_key
存储帐户密钥
container_name
容器名称,存储随机名称的“Blob”图像。需要预先创建blob容器。仅支持公共容器。
sas_token_expiration_days
SAS令牌有效期的天数。如果指定SAS令牌将附加到图像URL。允许在私有容器中存储图像。
(external_image_storage.local)
该选项不需要任何配置。
(呈现)
配置远程HTTP图像呈现服务的选项,例如使用https://github.com/grafana/grafana-image-renderer.
renderer_token
请注意:在Grafana v9.1.2和Image Renderer v3.6.1或更高版本中可用。
一个认证令牌将被发送给渲染器并由渲染器验证。渲染器将拒绝任何没有与渲染器上配置的认证令牌匹配的请求。
server_url
URL到远程HTTP图像渲染器服务,例如http://localhost:8081/render,将使Grafana通过向外部服务的HTTP请求将面板和仪表板渲染为png图像。
callback_url
如果远程HTTP图像呈现服务运行在与Grafana服务器不同的服务器上,您可能必须将其配置为Grafana可访问的URL。http://grafana.domain/.
concurrent_render_request_limit
当使用/render HTTP端点时,并发呈现请求限制会受到影响。同时呈现许多图像会使服务器过载,此设置可以通过只允许一定数量的并发请求来帮助防止这种情况。默认是30.
.
(板)
enable_alpha
设置为真正的
如果您想测试尚未准备好用于一般用途的alpha面板。默认是假
.
disable_sanitize_html
如果设置为true, Grafana将允许文本面板中的脚本标记。不建议使用,因为这会导致XSS漏洞。默认为false。这个设置是在Grafana v6.0中引入的。
(插件)
enable_alpha
设置为真正的
如果你想测试alpha插件,还没有准备好普遍使用。默认是假
.
allow_loading_unsigned_plugins
输入一个以逗号分隔的插件标识符列表来标识要加载的插件,即使它们是无符号的。修改过签名的插件永远不会被加载。
我们所做的不建议使用此选项。有关更多信息,请参阅插件签名.
plugin_admin_enabled
仅对Grafana管理员可用,允许直接从Grafana UI安装/卸载/更新插件。设置为真正的
默认情况下。设置为假
将隐藏安装/卸载/更新控件。
有关更多信息,请参阅插件目录.
plugin_admin_external_manage_enabled
设置为真正的
如果您想启用插件的外部管理。默认是假
.这只适用于Grafana Cloud用户。
plugin_catalog_url
自定义安装/学习企业插件的更多URL。默认为79bob在线下载 .
plugin_catalog_hidden_plugins
输入一个以逗号分隔的插件标识符列表,隐藏在插件目录中。
(生活)
max_connections
请注意:在Grafana v8.0及以上版本中支持。
的max_connections
选项指定每个Grafana服务器实例到Grafana Live WebSocket端点的最大连接数。默认是One hundred.
.
指Grafana Live配置文档如果您指定的值高于默认值,因为这可能需要进行一些操作系统和基础结构调优。
0禁用Grafana Live, -1表示无限连接。
allowed_origins
请注意:在Grafana v8.0.4及更高版本中可用。
的allowed_origins
选项是一个以逗号分隔的附加源列表(起源
在WebSocket连接建立期间HTTP升级请求的头),将被Grafana Live接受。
如果没有设置(默认),则匹配原点root_url这对于大多数情况来说应该足够了。
起源模式支持通配符符号“*”。
例如:
[live] allowed_origins = "https://*.example.com"
ha_engine
请注意:在Grafana v8.1及更高版本中可用。
实验
Grafana Live的高可用性引擎名称。默认情况下,没有设置。唯一可能的值是redis。
有关更多信息,请参阅配置Grafana Live HA设置.
ha_engine_address
请注意:在Grafana v8.1及更高版本中可用。
实验
所选HA Live引擎地址字符串。对于Redis来说,这是一个主持人:港口
字符串。例子:
[live] ha_engine = redis ha_engine_address = 127.0.0.1:6379
(plugin.grafana-image-renderer)
有关更多信息,请参阅图像呈现.
rendering_timezone
指示无头浏览器实例使用默认时区时,Grafana没有提供,例如,当渲染面板图像的警报。看到icu 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
指示无头浏览器实例在呈现图像时是否捕获和记录详细信息。默认是假
并且只捕获和记录错误消息。
启用后,调试消息也会被捕获和记录。
为了在Grafana服务器日志中包含详细信息,您必须将呈现日志级别调整为调试,配置[log]。Filter =渲染:调试。
rendering_dumpio
指示无头浏览器实例是否将其调试和错误消息输出到远程呈现服务的运行过程中。默认是假
.
将此设置为可能很有用真正的
当故障排除。
rendering_args
要传递给无头浏览器实例的附加参数。默认值是————disable-gpu no-sandbox
.铬标记的清单可在以下网址(https://peter.sh/experiments/chromium-command-line-switches/).用逗号分隔多个参数。
rendering_chrome_bin
您可以配置插件使用不同的浏览器二进制文件,而不是预先打包的Chromium版本。
请注意这是不推荐。如果安装的Chrome/Chromium版本与插件不兼容,可能会遇到问题。
rendering_mode
说明如何创建无头浏览器实例。默认是默认的
并将为每个请求创建一个新的浏览器实例。
模式集群
将确保只有最多的浏览器/隐身页面可以同时执行。
模式可重用的
将有一个浏览器实例,并将在每个请求上创建一个新的隐身页面。
rendering_clustering_mode
当rendering_mode = clustered时,您可以指示可以并发执行多少浏览器或隐身页面。默认是浏览器
并将使用浏览器实例进行集群。
模式上下文
将使用隐身页进行集群。
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
并自动分配一个未使用的端口。
(企业)
有关Grafana Enterprise的更多信息,请参阅Grafana企业.
(feature_toggles)
启用
要启用的alpha功能键,以空格分隔。
(date_formats)
注意:下面的日期格式选项仅在Grafana v7.2+中可用。
本节控制时间范围、图表和日期输入框中使用的日期格式的系统默认值。
格式模式使用Moment.js格式化标记。
full_date
时间范围选择器使用的完整日期格式,以及在呈现完整日期的其他地方使用的格式。
时间间隔
图中使用这些间隔格式仅显示部分日期或时间。例如,如果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
将其设置为真正的
从浏览器位置自动派生日期格式。默认为假
.这是一个实验特性。
default_timezone
用作用户首选项的默认时区。可以是任何一个浏览器
获取浏览器的本地时区或IANA时区数据库中的时区名称,例如UTC
或欧洲/阿姆斯特丹
.
default_week_start
设置默认的星期几,有效值为:周六
,周日
,周一
或浏览器
使用浏览器区域设置定义一周的第一天。默认是浏览器
.
(表达式)
注意:该特性在Grafana v7.4及更高版本中可用。
启用
将其设置为假
禁用表达式并将其隐藏在Grafana UI中。默认是真正的
.
(geomap)
本节控制Geomap Plugin的默认设置。
default_baselayer_config
用于定义默认基本映射的json配置。四个基本地图选项可供选择纸箱包装
,esriXYZTiles
,xyzTiles
,标准
.例如,要将cartoDB light设置为默认基础层:
default_baselayer_config = ' {"type": "xyz", "config": {"attribution": "Open streetmap ", "url": "https://tile.openstreetmap.org/{z}/{x}/{y}.png"}} '
enable_custom_baselayers
将其设置为真正的
禁用加载其他自定义基础地图,并将它们隐藏在Grafana UI中。默认是假
.
(dashboard_previews)
(爬虫)
注意:该特性在Grafana v9.0及更高版本中可用。
thread_count
并行呈现的仪表板数量。默认为6
rendering_timeout
超时传递给图像渲染插件。在一个呈现请求中,它被用于两个不同的地方——在最初导航到仪表板期间,以及在等待所有面板加载时。默认为20秒。
max_crawl_duration
单次抓取的最大持续时间。默认为1h。
scheduler_interval
两个后续调度器运行之间的最小间隔。默认为12h。
请参阅仪表板预览详细说明文档。
(rbac)
指基于角色的访问控制获取更多信息。