Grafana
Grafana是每個數據庫的開源分析和監控解決方案
特點
認證方式
LDAP,Google Auth,Grafana.com,Github。無論您的公司處理的是auth,Grafana都能使其輕松地與您現有的工作流程一起使用。
組織機構
Grafana支持多租戶。設置多個組織,每個組織可以擁有自己的管理員,定義自己的數據源,儀表板和用戶。
用戶首選項
Grafana包括高級用戶首選項,其中包括從深色或白色主題中選擇,設置家庭儀表板,更改時區等選項。
可視化
快速靈活的客戶端圖,具有多種選擇。面板插件以多種方式可視化指標和日志。
動態儀表盤
使用模板變量創建動態且可重用的儀表板,這些模板變量顯示在儀表板頂部。
探索指標
通過臨時查詢和動態明細瀏覽數據。拆分視圖並排比較不同的時間范圍,查詢和數據源。
探索日志
體驗使用保留標簽過濾器從指標切換到日志的魔力。快速搜索所有日志或實時流式傳輸。與Loki數據源配合使用效果最佳,但很快就會提供更多支持。
警示
直觀地定義最重要指標的警報規則。Grafana將不斷評估並向Slack,PagerDuty,VictorOps和OpsGenie等系統發送通知。
混合數據源
在同一張圖中混合使用不同的數據源!您可以基於每個查詢指定數據源。這甚至適用於自定義數據源。
注解
使用來自不同數據源的豐富事件對圖形進行注釋。將鼠標懸停在事件上會顯示完整的事件元數據和標簽。
臨時過濾器
使用臨時過濾器,您可以即時創建新的鍵/值過濾器,這些過濾器會自動應用於使用該數據源的所有查詢。
Install Grafana
1.下載並安裝
您可以使用我們的官方APT存儲庫,下載.deb
軟件包或下載二進制.tar.gz
文件來安裝Grafana 。
從APT存儲庫安裝
如果從APT信息庫安裝,則每次運行Grafana都會自動更新apt-get update
。
Grafana版本 | 包 | 資料庫 |
---|---|---|
Grafana OSS | 格拉那 | https://packages.grafana.com/oss/deb stable main |
Grafana OSS(測試版) | 格拉那 | https://packages.grafana.com/oss/deb beta main |
格拉法納企業 | 企業 | https://packages.grafana.com/enterprise/deb stable main |
Grafana Enterprise(測試版) | 企業 | https://packages.grafana.com/enterprise/deb beta main |
我們建議所有用戶安裝Grafana企業版,該版本可通過Grafana Enterprise 訂閱進行無縫升級。
要安裝最新的企業版:
sudo apt-get install -y apt-transport-https sudo apt-get install -y software-properties-common wget wget -q -O - https://packages.grafana.com/gpg.key | sudo apt-key add - # Alternatively you can add the beta repository, see in the table above sudo add-apt-repository "deb https://packages.grafana.com/enterprise/deb stable main" sudo apt-get update sudo apt-get install grafana-enterprise
要安裝最新的OSS版本:
sudo apt-get install -y apt-transport-https sudo apt-get install -y software-properties-common wget wget -q -O - https://packages.grafana.com/gpg.key | sudo apt-key add - # Alternatively you can add the beta repository, see in the table above sudo add-apt-repository "deb https://packages.grafana.com/oss/deb stable main" sudo apt-get update sudo apt-get install grafana
設置ARM的存儲庫
如果您在使用時遇到問題add-apt-repository
,則可以不使用它來設置存儲庫。
添加此存儲庫以獲得穩定版本:
echo "deb https://packages.grafana.com/oss/deb stable main" | sudo tee -a /etc/apt/sources.list.d/grafana.list
如果您想要Beta版本,請添加此存儲庫:
echo "deb https://packages.grafana.com/oss/deb beta main" | sudo tee -a /etc/apt/sources.list.d/grafana.list
安裝.deb軟件包
如果安裝.deb
軟件包,則需要為每個新版本手動更新Grafana。
- 在Grafana下載頁面上,選擇要安裝的Grafana版本。
- 默認情況下,會選擇最新的Grafana版本。
- “ 版本”字段僅顯示完成的版本。如果要安裝Beta版本,請單擊Nightly Builds,然后選擇一個版本。
- 選擇一個版本。
- 企業版 -推薦下載。在功能上與開源版本相同,但包括一些功能,您可以選擇使用許可證進行解鎖。
- 開源 -在功能上與企業版相同,但是如果需要企業功能,則需要下載企業版。
- 根據運行的系統,單擊Linux或ARM。
- 將安裝頁面中的代碼復制並粘貼到命令行中並運行。它遵循以下所示的模式。
sudo apt-get install -y adduser libfontconfig1 wget <.deb package url> sudo dpkg -i grafana<edition>_<version>_amd64.deb
從二進制.tar.gz文件安裝
下載最新.tar.gz
文件並解壓縮。文件解壓縮到以您下載的Grafana版本命名的文件夾中。該文件夾包含運行Grafana所需的所有文件。該軟件包中沒有初始化腳本或安裝腳本。
wget <tar.gz package url> sudo tar -zxvf <tar.gz package>
2.啟動服務器
這grafana-server
將以grafana
用戶身份啟動該過程,該過程是在軟件包安裝期間創建的。
如果安裝了APT存儲庫或.deb
軟件包,則可以使用systemd
或啟動服務器init.d
。如果安裝了二進制.tar.gz
文件,則需要執行二進制文件。
用systemd啟動服務器
要啟動服務並驗證服務已啟動:
sudo systemctl daemon-reload sudo systemctl start grafana-server sudo systemctl status grafana-server
配置Grafana服務器以在啟動時啟動:
sudo systemctl enable grafana-server.service
用init.d啟動服務器
要啟動服務並驗證服務已啟動:
sudo service grafana-server start sudo service grafana-server status
配置Grafana服務器以在啟動時啟動:
sudo update-rc.d grafana-server defaults
執行二進制
該grafana-server
二進制名為.tar.gz需要工作目錄是根安裝目錄,其中二進制文件以及public
文件夾的位置。
通過運行以下命令啟動Grafana:
./bin/grafana-server web
包裝細節
- 將二進制文件安裝到
/usr/sbin/grafana-server
- 將Init.d腳本安裝到
/etc/init.d/grafana-server
- 創建默認文件(環境變量)以
/etc/default/grafana-server
- 將配置文件安裝到
/etc/grafana/grafana.ini
- 安裝systemd服務(如果有systemd可用)名稱
grafana-server.service
- 默認配置將日志文件設置為
/var/log/grafana/grafana.log
- 默認配置在以下位置指定sqlite3 db
/var/lib/grafana/grafana.db
- 在以下位置安裝HTML / JS / CSS和其他Grafana文件
/usr/share/grafana
入門
本指南將幫助您入門並熟悉Grafana。
安裝Grafana
此步驟因您的計算機操作系統而異。有關說明,請參閱“ 安裝”部分中有關您的操作系統的說明。
首次登錄
- 打開您的Web瀏覽器,然后轉到http:// localhost:3000 /。
3000
如果未配置其他端口,則是Grafana偵聽的默認HTTP端口。 - 在登錄頁面上,輸入
admin
用戶名和密碼。 - 更改您的密碼。
注意:我們強烈建議您遵循Grafana最佳做法並更改默認管理員密碼。不要忘記記錄您的憑據!
創建一個儀表板
- 點擊新建信息中心。
- 點擊添加查詢。Grafana使用Random Walk場景創建一個基本的圖形面板。
- 保存儀表板。點擊屏幕右上角的保存信息中心圖標。
恭喜,您已經開始使用Grafana!您有一個儀表板並正在顯示結果。隨意嘗試自己構建的內容,繼續添加其他數據源,或探索下一步。
添加一個數據源
在創建第一個真實儀表板之前,需要添加數據源。
首先將光標移到側面菜單上的齒輪上,這將向您顯示配置菜單。如果看不到側面菜單,請單擊左上角的Grafana圖標。配置菜單上的第一項是數據源,單擊它,您將被帶到“數據源”頁面,您可以在其中添加和編輯數據源。您也可以簡單地單擊齒輪。
單擊添加數據源,您將進入新數據源的設置頁面。
首先,為數據源命名,然后選擇要創建的數據類型,請參閱支持的數據源以獲取更多信息以及如何配置數據源。
配置數據源后,就可以保存和測試了。
配置
Grafana有許多配置選項,您可以在.ini
配置文件中指定或使用環境變量指定。
注意:必須重新啟動Grafana才能使所有配置更改生效。
配置文件位置
不要改變defaults.ini
!Grafana默認值存儲在此文件中。根據您的操作系統,在custom.ini
或中進行所有配置更改grafana.ini
。
- 默認配置來自
$WORKING_DIR/conf/defaults.ini
- 來自的自定義配置
$WORKING_DIR/conf/custom.ini
- 可以使用
--config
參數覆蓋自定義配置文件路徑
Linux的
如果使用deb
或rpm
軟件包安裝了Grafana ,則您的配置文件位於,/etc/grafana/grafana.ini
並且custom.ini
不使用單獨的文件。此路徑在Grafana init.d腳本中使用--config
file參數指定。
泊塢窗
請參閱配置Grafana Docker映像,以獲取有關環境變量,持久存儲和構建自定義Docker映像的信息。
窗口
sample.ini
與所在的目錄相同,defaults.ini
並且包含所有注釋掉的設置。復制sample.ini
並命名custom.ini
。
MacOS的
默認情況下,配置文件位於/usr/local/etc/grafana/grafana.ini
。要配置Grafana,請custom.ini
在conf
文件夾中添加一個名為的配置文件,以覆蓋中定義的任何設置conf/defaults.ini
。
評論在.ini文件
分號(;
字符)是注釋.ini
文件中各行的標准方法。如果要更改設置,則必須先刪除;
設置前面的分號(),然后才能起作用。
例
# The http port to use
;http_port = 3000
一個常見的問題是忘記對custom.ini
(或grafana.ini
)文件中的一行取消注釋,這會導致忽略配置選項。
使用環境變量進行配置
可以使用以下語法使用環境變量來覆蓋配置文件中的所有選項:
GF_<SectionName>_<KeyName>
其中部分名稱是方括號內的文本。一切都應為大寫,.
應以代替_
。例如,如果您具有以下配置設置:
# default section instance_name = ${HOSTNAME} [security] admin_user = admin [auth.google] client_secret = 0ldS3cretKey
您可以使用以下命令在Linux計算機上覆蓋它們:
export GF_DEFAULT_INSTANCE_NAME=my-instance export GF_SECURITY_ADMIN_USER=owner export GF_AUTH_GOOGLE_CLIENT_SECRET=newS3cretKey
為了使對任何更改
conf/grafana.ini
(或相應的環境變量)生效,必須重新啟動Grafana才能使更改生效。
INSTANCE_NAME
設置grafana服務器實例的名稱。用於日志記錄和內部指標以及群集信息。默認值為:${HOSTNAME}
,將用環境變量替換HOSTNAME
,如果該變量為空或不存在,則Grafana將嘗試使用系統調用來獲取計算機名稱。
[路徑]
數據
Grafana存儲sqlite3數據庫(如果使用),基於文件的會話(如果使用)和其他數據的路徑。通常通過init.d腳本或systemd服務文件中的命令行指定此路徑。
macOS:默認的SQLite數據庫位於/usr/local/var/lib/grafana
temp_data_lifetime
data
目錄中的臨時映像應保留多長時間。默認值為:24h
。支持改性劑:h
(小時), m
(分鍾),例如:168h
,30m
,10h30m
。使用0
從不清理臨時文件。
日志
Grafana將存儲日志的路徑。通常通過init.d腳本或systemd服務文件中的命令行指定此路徑。您可以在配置文件或默認環境變量文件中覆蓋它。但是,請注意,通過覆蓋此默認日志路徑將臨時使用,直到Grafana完全初始化/啟動為止。
使用命令行參數覆蓋日志路徑cfg:default.paths.log
:
./grafana-server --config /custom/config.ini --homepath /custom/homepath cfg:default.paths.logs=/custom/path
macOS:默認情況下,日志文件應位於/usr/local/var/log/grafana/grafana.log
。
插件
Grafana將自動掃描並查找插件的目錄。在此處手動或自動安裝任何插件。
macOS:默認情況下,Mac插件位置為:/usr/local/var/lib/grafana/plugins
。
設置
文件夾包含置備配置文件grafana將應用在啟動時。json文件更改時,儀表板將重新加載
[服務器]
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
另一種方法是將像Nginx或Apache這樣的Web服務器放在Grafana前面,並讓它們向Grafana代理請求。
協議
http
,https
,h2
或者socket
注意:早於3.0的Grafana版本易受POODLE攻擊。因此,我們強烈建議升級到3.x或使用反向代理進行ssl終止。
套接字
時應在其中創建套接字的路徑protocol=socket
。請確保Grafana具有適當的權限。
域
此設置僅用作root_url
設置的一部分(請參閱下文)。如果您使用GitHub或Google OAuth,則非常重要。
執行域
如果主機頭不匹配域,則重定向到正確的域。防止DNS重新綁定攻擊。默認值為false
。
root_url
這是用於從Web瀏覽器訪問Grafana的完整URL。如果您使用Google或GitHub OAuth身份驗證(對於正確的回調URL),這一點很重要。
注意:如果您在Grafana前面有一個反向代理通過子路徑將其公開,則此設置也很重要。在這種情況下,請將子路徑添加到此URL設置的末尾。
serve_from_sub_path
6.3及更高版本可用
從root_url
設置中指定的子路徑服務Grafana 。默認情況下,false
出於兼容性原因將其設置為。
通過啟用此設置並使用root_url
上面的子路徑,例如 root_url = http://localhost:3000/grafana
,可以在上訪問Grafana http://localhost:3000/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
)。
router_logging
設置true
為Grafana記錄所有HTTP請求(不僅是錯誤)。這些作為信息級別事件記錄到grafana日志中。
[數據庫]
Grafana需要一個數據庫來存儲用戶和儀表板(和其他東西)。默認情況下,它配置為使用sqlite3
哪個是嵌入式數據庫(包含在主Grafana二進制文件中)。
網址
使用URL或下面的其他字段來配置數據庫示例: mysql://user:secret@host:port/database
類型
要么mysql
,postgres
或者sqlite3
,它是你的選擇。
路徑
僅適用於sqlite3
數據庫。數據庫將存儲的文件路徑。
主機
僅適用於MySQL或Postgres。包括IP或主機名和端口,或者在Unix套接字的情況下包括其路徑。例如,對於與Grafana:host = 127.0.0.1:3306
或Unix套接字運行在同一主機上的MySQL :host = /var/run/mysqld/mysqld.sock
名字
Grafana數據庫的名稱。將其設置為grafana
或其他名稱。
用戶
數據庫用戶(不適用於sqlite3
)。
密碼
數據庫用戶的密碼(不適用於sqlite3
)。如果密碼包含#
或;
必須用三引號引起來。例如"""#password;"""
ssl_mode
對於Postgres的,使用disable
,require
或verify-full
。對於MySQL,使用true
,false
或skip-verify
。
ca_cert_path
要使用的CA證書的路徑。在許多Linux系統上,可以在中找到證書/etc/ssl/certs
。
client_key_path
客戶端密鑰的路徑。僅當服務器需要客戶端身份驗證時。
client_cert_path
客戶端證書的路徑。僅當服務器需要客戶端身份驗證時。
server_cert_name
mysql
或postgres
服務器使用的證書的通用名稱字段。如果ssl_mode
設置為,則不需要skip-verify
。
max_idle_conn
空閑連接池中的最大連接數。
max_open_conn
與數據庫的最大打開連接數。
conn_max_lifetime
設置可以重用連接的最長時間。默認值為14400(表示14400秒或4小時)。對於MySQL,此設置應短於wait_timeout
變量。
log_queries
設置為true
記錄sql調用和執行時間。
cache_mode
僅適用於“ sqlite3”。用於連接數據庫的共享緩存設置。(私有,共享)默認為private
。
[remote_cache]
類型
要么redis
,memcached
或database
。默認為database
connstr
遠程緩存連接字符串。格式取決於type
遠程緩存的格式。
數據庫
使用時保留為空,database
因為它將使用主數據庫。
Redis
Example connstr: addr=127.0.0.1:6379,pool_size=100,db=0,ssl=false
addr
is the host:
port of the redis server.pool_size
(optional) is the number of underlying connections that can be made to redis.db
(optional) is the number indentifer of the redis database you want to use.ssl
(optional) is if SSL should be used to connect to redis server. The value may betrue
,false
, orinsecure
. Setting the value toinsecure
skips verification of the certificate chain and hostname when making the connection.
Memcache
Example connstr: 127.0.0.1:11211
[security]
disable_initial_admin_creation
Only available in Grafana v6.5+.
Disable creation of admin user on first start of grafana.
admin_user
The name of the default Grafana admin user (who has full permissions). Defaults to admin
.
admin_password
The password of the default Grafana admin. Set once on first-run. Defaults to admin
.
login_remember_days
The number of days the keep me logged in / remember me cookie lasts.
secret_key
Used for signing some data source settings like secrets and passwords, the encryption format used is AES-256 in CFB mode. Cannot be changed without requiring an update to data source settings to re-encode them.
disable_gravatar
Set to true
to disable the use of Gravatar for user profile images. Default is false
.
data_source_proxy_whitelist
Define a whitelist of allowed IP addresses or domains, with ports, to be used in data source URLs with the Grafana data source proxy. Format: ip_or_domain:port
separated by spaces. PostgreSQL, MySQL, and MSSQL data sources do not use the proxy and are therefore unaffected by this setting.
cookie_secure
Set to true
if you host Grafana behind HTTPS. Default is false
.
cookie_samesite
Sets the SameSite
cookie attribute and prevents the browser from sending this cookie along with cross-site requests. The main goal is to mitigate the risk of cross-origin information leakage. This setting also provides some protection against cross-site request forgery attacks (CSRF), read more about SameSite here. Valid values are lax
, strict
, none
, and disabled
. Default is lax
. Using value disabled
does not add any SameSite
attribute to cookies.
allow_embedding
When false
, the HTTP header X-Frame-Options: deny
will be set in Grafana HTTP responses which will instruct browsers to not allow rendering Grafana in a <frame>
, <iframe>
, <embed>
or <object>
. The main goal is to mitigate the risk of Clickjacking. Default is false
.
strict_transport_security
Set to true
if you want to enable HTTP Strict-Transport-Security
(HSTS) response header. This is only sent when HTTPS is enabled in this configuration. HSTS tells browsers that the site should only be accessed using HTTPS. The default value is false
until the next minor release, 6.3
.
strict_transport_security_max_age_seconds
設置瀏覽器應在幾秒鍾內緩存HSTS的時間。僅在啟用strict_transport_security時應用。默認值為86400
。
strict_transport_security_preload
設置為true
是否啟用HSTS preloading
選項。僅在啟用strict_transport_security時應用。默認值為false
。
strict_transport_security_subdomains
設置為true
是否啟用HSTS includeSubDomains選項。僅在啟用strict_transport_security時應用。默認值為false
。
x_content_type_options
設置為true
啟用X-Content-Type-Options響應標頭。X-Content-Type-Options響應HTTP標頭是服務器使用的標記,用於指示不應更改和遵循Content-Type標頭中通告的MIME類型。默認值為false
直到下一個次要發行版6.3
。
x_xss_protection
設置為false
禁用X-XSS-Protection標頭,該標頭指示瀏覽器在檢測到反射的跨站點腳本(XSS)攻擊時停止加載頁面。默認值為false
直到下一個次要發行版6.3
。
[用戶]
allow_sign_up
設置為false
禁止用戶能夠注冊/創建用戶帳戶。默認為false
。管理員用戶仍然可以從Grafana管理員頁面創建用戶
allow_org_create
設置為false
禁止用戶創建新組織。默認為false
。
auto_assign_org
設置為true
自動將新用戶添加到主要組織(標識1)。設置為時false
,新用戶將自動導致為該新用戶創建一個新組織。
auto_assign_org_id
設置此值可將新用戶自動添加到提供的組織中。這需要auto_assign_org
設置為true
。請確保該組織已經存在。
auto_assign_org_role
將為主要組織分配新用戶的角色(如果上述設置設置為true)。默認為Viewer
,其他有效選項為Admin
和Editor
。例如:
auto_assign_org_role = Viewer
viewers_can_edit
查看者可以在瀏覽器中編輯/檢查儀表板設置,但不能保存儀表板。默認為false
。
editors_can_admin
編輯者可以管理他們創建的儀表板,文件夾和團隊。默認為false
。
login_hint
在登錄頁面上用作占位符文本的文本,用於輸入登錄名/用戶名。
password_hint
在登錄頁面上用作占位符文本的文本,用於輸入密碼。
[認證]
Grafana提供了多種驗證用戶身份的方法。身份驗證文檔已分為以下許多不同的頁面。
- 身份驗證概述(匿名訪問選項,隱藏登錄名等)
- Google OAuth(auth.google)
- GitHub OAuth(auth.github)
- Gitlab OAuth(auth.gitlab)
- 通用OAuth(auth.generic_oauth,okta2,auth0,bitbucket,azure)
- 基本身份驗證(auth.basic)
- LDAP驗證(auth.ldap)
- 身份驗證代理(auth.proxy)
[dataproxy]
記錄
這將啟用數據代理日志記錄,默認值為false
。
超時
數據代理在超時之前應等待多長時間。默認值為30
(秒)
send_user_header
如果啟用並且用戶不是匿名用戶,則數據代理會將帶有用戶名的X-Grafana-User標頭添加到請求中。默認值為false
。
[分析]
reporting_enabled
啟用后,Grafana會將匿名使用情況統計信息發送到 stats.grafana.org
。沒有跟蹤IP地址,只有簡單的計數器可以跟蹤正在運行的實例,版本,儀表板和錯誤計數。這對我們非常有幫助,因此請啟用此功能。計數器每24小時發送一次。默認值為true
。
google_analytics_ua_id
如果您想通過Google Analytics(分析)跟蹤Grafana的使用情況,請在此處指定您的 Universal Analytics ID。默認情況下,此功能處於禁用狀態。
check_for_updates
設置為false可禁用對https://grafana.com的所有已安裝插件的新版本的檢查,以及對Grafana GitHub存儲庫的檢查,以檢查是否有較新版本的Grafana。在某些UI視圖中使用版本信息來通知存在新的Grafana更新或插件更新。此選項不會導致任何自動更新,也不會發送任何敏感信息。該檢查每10分鍾運行一次。
[儀表板]
versions_to_keep
編號要保留的儀表板版本(每個儀表板)。默認值:20
,最小值:1
。
min_refresh_interval
僅在Grafana v6.7 +中可用。
設置后,這將限制用戶將儀表板的刷新間隔設置為低於給定間隔。默認情況下,未設置/不限制此設置。間隔字符串是可能帶符號的十進制數字序列,后跟一個單位后綴(ms,s,m,h,d),例如30s
或1m
。
[dashboards.json]
在5.0+中已將其替換為儀表板配置
啟用
true
或false
。默認情況下處於禁用狀態。
路徑
包含json儀表板的目錄的完整路徑。
[smtp]
電子郵件服務器設置。
啟用
默認為 false
主機
默認為 localhost:25
用戶
如果是SMTP身份驗證,則默認為 empty
密碼
如果是SMTP身份驗證,則默認為 empty
cert_file中
證書文件的文件路徑,默認為 empty
KEY_FILE
密鑰文件的文件路徑,默認為 empty
skip_verify
驗證SSL的SSL服務器?默認為false
FROM_ADDRESS
發送電子郵件時使用的地址,默認為 admin@grafana.localhost
FROM_NAME
發送電子郵件時使用的名稱,默認為 Grafana
ehlo_identity
在SMTP對話框中用作EHLO客戶端身份的名稱,默認為instance_name。
[日志]
模式
“控制台”,“文件”,“系統日志”。默認值為“控制台”和“文件”。使用空格分隔多個模式,例如console file
級別
“調試”,“信息”,“警告”,“錯誤”,“嚴重”中的任何一個,默認值為info
。
過濾器
可選設置,可為特定記錄器設置不同級別。例如filters = sqlstore:debug
。
[log.console]
僅在[log]
模式下使用“控制台”時適用。
級別
默認情況下,“調試”,“信息”,“警告”,“錯誤”,“嚴重”都是從[log]
級別繼承的。
格式
日志行格式,有效選項為text,console和json。默認值為console
。
[log.file]
僅在[log]
模式下使用“文件”時適用。
級別
默認情況下,“調試”,“信息”,“警告”,“錯誤”,“嚴重”都是從[log]
級別繼承的。
格式
日志行格式,有效選項為text,console和json。默認值為console
。
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”時適用。
級別
默認情況下,“調試”,“信息”,“警告”,“錯誤”,“嚴重”都是從[log]
級別繼承的。
格式
日志行格式,有效選項為text,console和json。默認值為console
。
網絡和地址
Syslog網絡類型和地址。可以是udp,tcp或unix。如果留為空白,將使用默認的unix端點。
設施
Syslog工具。有效選項是user,daemon或local0到local7。默認為空。
標簽
Syslog標簽。默認情況下,使用進程的argv[0]
。
[指標]
啟用
啟用指標報告。默認為true。可通過HTTP API獲得/metrics
。
basic_auth_username
如果設置,則將用戶名配置為用於度量標准端點上的基本身份驗證。
basic_auth_password
如果設置,則配置密碼以用於度量標准端點上的基本身份驗證。
disable_total_stats
如果設置為true
,則stat_totals_*
禁用總統計信息生成(指標)。默認值為false
。
interval_seconds這些
將指標發送到外部TSDB時的刷新/寫入間隔。默認為10秒。
[metrics.graphite]
如果要將內部Grafana指標發送到Graphite,請包括此部分。
地址
格式<Hostname or ip>
:端口
前綴
石墨度量標准前綴。默認為prod.grafana.%(instance_name)s.
[快照]
external_enabled
設置為false
禁用外部快照發布端點(默認true
)
external_snapshot_url
將根URL設置為要在其中發布外部快照的Grafana實例(默認為https://snapshots-origin.raintank.io)
external_snapshot_name
設置外部快照按鈕的名稱。默認為Publish to snapshot.raintank.io
snapshot_remove_expired
啟用以自動刪除過期的快照
[external_image_storage]
這些選項控制應如何公開圖像,以便可以在諸如松弛之類的服務上共享圖像。
提供者
您可以選擇(s3,webdav,gcs,azure_blob,本地)。如果保留為空,則Grafana將忽略上傳操作。
[external_image_storage.s3]
端點
可選的端點URL(主機名或標准URI),以覆蓋默認生成的S3端點。如果要保留默認值,則將其保留為空。region
如果指定端點,則仍必須提供一個值。
path_style_access
將此值設置為true可在S3請求中強制使用路徑樣式尋址,即http://s3.amazonaws.com/BUCKET/KEY
,而不是默認值,即在可能的情況下使用虛擬托管存儲區尋址(http://BUCKET.s3.amazonaws.com/KEY
)。
注意:此選項特定於Amazon S3服務。
桶
S3的存儲桶名稱。例如grafana.snapshot。
區域
S3的區域名稱。例如'us-east-1','cn-north-1'等。
路徑
值區中的可選額外路徑,適用於應用到期策略。
bucket_url
(為了向后兼容,僅在未配置存儲桶或區域的情況下才有效)S3的存儲桶URL。可以在URL中指定AWS區域,或默認為'us-east-1',例如-http : //grafana.s3.amazonaws.com/-https : //grafana.s3-ap-southeast-2.amazonaws.com /
access_key
訪問密鑰,例如AAAAAAAAAAAAAAAAAAAAAAA。
訪問密鑰需要對“ s3:PutObject”和“ s3:PutObjectAcl”操作具有S3存儲桶的權限。
SECRET_KEY
密鑰,例如AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA。
[external_image_storage.webdav]
網址
Grafana將發送帶有圖像的PUT請求的URL
public_url
可選參數。在通知中發送給用戶的URL。如果字符串包含序列$ {file},它將被上載的文件名替換。否則,文件名將附加到URL的路徑部分,而所有查詢字符串均保持不變。
用戶名
基本身份驗證用戶名
密碼
基本身份驗證密碼
[external_image_storage.gcs]
KEY_FILE
與要認證和授權的Google服務帳戶關聯的JSON密鑰文件的路徑。可以從https://console.developers.google.com/permissions/serviceaccounts創建和下載服務帳戶密鑰。
服務帳戶應具有“存儲對象編寫器”角色。存儲桶的訪問控制模型需要為“設置對象級別和存儲桶級別權限”。Grafana本身將使圖像公開可讀。
桶
Google Cloud Storage上的存儲桶名稱。
路徑
鏟斗內可選的額外路徑
[external_image_storage.azure_blob]
ACCOUNT_NAME
儲存帳號名稱
account_key
存儲帳戶密鑰
CONTAINER_NAME
容器名稱,用於存儲帶有隨機名稱的“ Blob”圖像。需要預先創建Blob容器。僅支持公共容器。
[警告]
啟用
默認為true
。設置為false
禁用警報引擎並從UI隱藏警報。
execute_alerts
使關閉警報規則執行成為可能。
error_or_timeout
5.3及更高版本中可用
新警報規則的默認設置。默認將錯誤和超時分類為警報。(更改,保持狀態)
nodata_or_nullvalues
5.3及更高版本中可用
Grafana如何處理警報中的無數據或空值的默認設置。(提示,no_data,keep_state,確定)
concurrent_render_limit
5.3及更高版本中可用
警報通知可以包含圖像,但是同時渲染許多圖像可能會使服務器超載。此限制將保護服務器免受渲染過載的影響,並確保快速發送通知。默認值為5
。
evaluation_timeout_seconds
警報計算超時的默認設置。默認值為30
notification_timeout_seconds
警報通知超時的默認設置。默認值為30
MAX_ATTEMPTS次
最大嘗試發送警報通知的默認設置。默認值為3
min_interval_seconds
規則評估之間的最小間隔的默認設置。默認值為1
注意。此設置優先於每個單獨的規則頻率。因此,如果規則頻率低於此值,則將強制執行此值。
[渲染]
用於配置遠程HTTP圖像呈現服務的選項,例如,使用https://github.com/grafana/grafana-image-renderer。
SERVER_URL
遠程HTTP圖像渲染器服務的URL,例如http:// localhost:8081 / render,將使Grafana能夠使用對外部服務的HTTP請求將面板和儀表板渲染為PNG圖像。
callback_url
如果遠程HTTP圖像渲染器服務在與Grafana服務器不同的服務器上運行,則可能必須將其配置為可訪問Grafana的URL,例如http://grafana.domain/。
[面板]
disable_sanitize_html
如果設置為true,則Grafana將允許文本面板中的腳本標簽。不建議使用它,因為它啟用了XSS漏洞。默認為false。此設置在Grafana v6.0中引入。
[插件]
enable_alpha
如果您要測試尚不適合常規使用的Alpha插件,請設置為true。
[feature_toggles]
啟用
要啟用的Alpha功能鍵,以空格分隔。可用的alpha功能包括:transformations
[tracing.jaeger]
配置Grafana的Jaeger客戶端以進行分布式跟蹤。
您還可以使用標准JAEGER_*
環境變量來配置Jaeger。有關 完整列表,請參見https://www.jaegertracing.io/docs/1.16/client-features/末尾的表。環境變量將覆蓋此處提供的任何設置。
地址
報告跨度的host:port目標。(例如:localhost:6381
)
可以使用環境變量JAEGER_AGENT_HOST
和設置JAEGER_AGENT_PORT
。
always_included_tag
以逗號分隔的標簽列表,包括在所有新范圍中,例如tag1:value1,tag2:value2
。
可以使用環境變量進行設置JAEGER_TAGS
(=
代替環境變量使用:
)。
sampler_type
默認值為const
。
指定采樣類型:const
,probabilistic
,ratelimiting
,或remote
。
有關不同跟蹤類型的詳細信息,請參見https://www.jaegertracing.io/docs/1.16/sampling/#client-sampling-configuration。
可以使用環境變量進行設置JAEGER_SAMPLER_TYPE
。
sampler_param
默認值為1
。
這是采樣器配置參數。取決於的值sampler_type
,它可以是0
,1
,或在之間的十進制值。
- 對於
const
采樣器,0
或1
用於總是false
/true
分別 - 對於
probabilistic
采樣器,介於0
和之間的概率1.0
- 對於
rateLimiting
采樣器,每秒的跨度數 - 對於
remote
采樣器,參數與for相同probabilistic
,表示從母艦收到實際采樣率之前的初始采樣率
可以使用環境變量設置JAEGER_SAMPLER_PARAM
。
zipkin_propagation
默認值為false
。
控制是否使用Zipkin的跨度傳播格式(帶有x-b3-
HTTP標頭)。默認情況下,使用Jaeger格式。
可以設置環境變量和值JAEGER_PROPAGATION=b3
。
disable_shared_zipkin_spans
默認值為false
。
設置為true
關閉共享的RPC范圍。在基礎架構中其他位置使用Zipkin時,最常使用此設置。
刪除的選項
請注意,這些選項已被刪除。
[會話]
從Grafana v6.2開始刪除。請改用remote_cache選項。
提供者
有效值為memory
,file
,mysql
,postgres
,memcache
或redis
。默認值為file
。
provider_config
根據您配置的會話提供程序的類型,應該對此選項進行不同的配置。
- 文件:會話文件路徑,例如
data/sessions
- mysql: go-sql-driver / mysql dsn配置字符串,例如
user:password@tcp(127.0.0.1:3306)/database_name
- postgres:例如:
user=a password=b host=localhost port=5432 dbname=c sslmode=verify-full
- 內存緩存:例如:
127.0.0.1:11211
- redis:例如:
addr=127.0.0.1:6379,pool_size=100,prefix=grafana
。對於Unix套接字,請使用例如:network=unix,addr=/var/run/redis/redis.sock,pool_size=100,db=grafana
Postgres的有效的sslmode
是disable
,require
,verify-ca
,和verify-full
(默認值)。
cookie_name
Grafana會話cookie的名稱。
cookie_secure
如果僅在HTTPS之后托管Grafana,則設置為true。默認為false
。
session_life_time
會話持續多長時間(以秒為單位)。默認為86400
(24小時)。
配置Grafana Docker鏡像
如果在Docker映像中運行Grafana,則可以使用環境變量配置Grafana,而不是直接編輯配置文件。如果要保存數據,則還需要為Grafana容器指定永久性存儲或綁定裝載。
保存您的Grafana數據
如果您未指定信息存儲位置,則停止圖像后,所有Grafana數據都會消失。要保存數據,您需要為容器設置永久性存儲或綁定裝載。
使用永久存儲運行Grafana容器(推薦)
# create a persistent volume for your data in /var/lib/grafana (database and plugins) docker volume create grafana-storage # start grafana docker run -d -p 3000:3000 --name=grafana -v grafana-storage:/var/lib/grafana grafana/grafana
使用綁定掛載運行Grafana容器
您可能想在Docker中運行Grafana,但將主機上的文件夾用於數據庫或配置。這樣做時,請能夠訪問並寫入您映射到容器中的文件夾的用戶啟動容器非常重要。
mkdir data # creates a folder for your data ID=$(id -u) # saves your user id in the ID variable # starts grafana with your user id and using the data folder docker run -d --user $ID --volume "$PWD/data:/var/lib/grafana" -p 3000:3000 grafana/grafana:5.1.0
默認路徑
在啟動Grafana Docker容器時,以下設置是硬編碼的,並且只能使用環境變量而不是在中進行覆蓋conf/grafana.ini
。
設置 | 默認值 |
---|---|
GF_PATHS_CONFIG | /etc/grafana/grafana.ini |
GF_PATHS_DATA | / var / lib / grafana |
GF_PATHS_HOME | / usr / share / grafana |
GF_PATHS_LOGS | / var / log / grafana |
GF_PATHS_PLUGINS | / var / lib / grafana / plugins |
GF_PATHS_PROVISIONING | / etc / grafana / provisioning |
配置Grafana與碼頭工人秘密
僅在Grafana v5.2和更高版本中可用。
可以通過文件為Grafana提供配置。這與Docker Secrets配合得很好,因為默認情況下,這些機密會映射到/run/secrets/<name of secret>
容器中。
您可以使用conf / grafana.ini中的任何配置選項來執行此操作,方法是將其設置GF_<SectionName>_<KeyName>__FILE
為包含密鑰的文件的路徑。
例如,您可以通過以下方式設置管理員密碼:
- 管理員密碼機密:
/run/secrets/admin_password
- 環境變量:
GF_SECURITY_ADMIN_PASSWORD__FILE=/run/secrets/admin_password
為CloudWatch支持配置AWS憑證
docker run -d \
-p 3000:3000 \
--name=grafana \ -e "GF_AWS_PROFILES=default" \ -e "GF_AWS_default_ACCESS_KEY_ID=YOUR_ACCESS_KEY" \ -e "GF_AWS_default_SECRET_ACCESS_KEY=YOUR_SECRET_KEY" \ -e "GF_AWS_default_REGION=us-east-1" \ grafana/grafana
您也可以指定多個配置文件GF_AWS_PROFILES
(例如 GF_AWS_PROFILES=default another
)。
支持的變量:
GF_AWS_${profile}_ACCESS_KEY_ID
:AWS訪問密鑰ID(必需)。GF_AWS_${profile}_SECRET_ACCESS_KEY
:AWS秘密訪問密鑰(必需)。GF_AWS_${profile}_REGION
:AWS區域(可選)。
安全
如果您在Grafana服務器上或其本地網絡中運行非Grafana Web服務,則它們可能容易受到Grafana數據源代理或其他方法的利用。
為防止發生這種類型的利用,我們建議您采用下面列出的一項或多項預防措施。
限制數據源URL的IP地址/主機名
您可以將Grafana配置為僅允許將某些IP地址或主機名用作數據源URL,並通過Grafana數據源代理進行代理。有關使用說明,請參考data_source_proxy_whitelist。
防火牆規則
配置防火牆以限制Grafana向敏感的內部Web服務發出網絡請求。
有許多可用的防火牆工具,請參閱特定安全工具的文檔。例如,Linux用戶可以使用iptables。
代理服務器
要求Grafana發出的所有網絡請求都必須通過代理服務器。
限制查看器查詢權限
與瀏覽器角色的用戶可以進入任何可能的查詢中任何的現有數據源組織,而不僅僅是那些對用戶具有查看權限的儀表板定義的查詢。
例如:在具有一個數據源,一個儀表板和一個定義了一個查詢的面板的Grafana實例中,您可能假定查看者只能看到在該面板中定義的查詢結果。實際上,查看器有權將任何查詢發送到數據源。使用curl這樣的命令行工具(有很多用於此目的的工具),查看器可以對數據源進行自己的查詢,並有可能訪問敏感數據。
要解決此漏洞,您可以通過以下方式限制數據源查詢訪問:
- 創建多個數據源,並在數據源配置中添加一些限制訪問權限的限制(例如數據庫名稱或憑據)。然后,使用“ 數據源權限企業”功能來限制用戶訪問Grafana中的數據源。
- 創建一個單獨的Grafana組織,然后在該組織中創建一個單獨的數據源。確保數據源具有某些選項/用戶/憑證設置,以限制對數據子集的訪問。並非所有數據源都有限制訪問的選項。
用戶認證概述¶
Grafana提供了多種驗證用戶身份的方法。一些身份驗證集成還可以同步用戶權限和組織成員身份。
OAuth集成
- Google OAuth
- GitHub OAuth
- 亞搏體育app OAuth
- 通用OAuth(Okta2,BitBucket,Azure,OneLogin,Auth0)
LDAP集成
- LDAP驗證(OpenLDAP,ActiveDirectory等)
身份驗證代理
- 身份驗證代理如果要使用反向代理在Grafana之外處理身份驗證。
Grafana身份驗證
當然,Grafana具有內置的用戶身份驗證系統,默認情況下啟用了密碼身份驗證。您可以通過啟用匿名訪問來禁用身份驗證。您還可以隱藏登錄表單,僅允許通過身份驗證提供程序(上面列出)登錄。還有允許自我注冊的選項。
登錄和短暫令牌
當使用Grafana的內置用戶身份驗證,LDAP(無Auth代理)或OAuth集成時,以下內容適用。
Grafana正在使用短期令牌作為驗證經過身份驗證的用戶的機制。這些短暫的令牌token_rotation_interval_minutes
針對有效的經過身份驗證的用戶進行輪換。
一個有效的經過身份驗證的用戶(使其獲得令牌旋轉)將延長login_maximum_inactive_lifetime_days
Grafana從“現在”起記住該用戶的時間。這意味着用戶可以關閉其瀏覽器,然后再次訪問now + login_maximum_inactive_lifetime_days
並仍然通過身份驗證。只要自用戶登錄以來的時間少於,便是如此login_maximum_lifetime_days
。
遠程登出
您可以通過從個人資料頁面底部刪除登錄會話來從其他設備注銷。如果您是Grafana管理員用戶,則還可以從“服務器管理員” /“編輯用戶”視圖對任何用戶執行相同的操作。
設置
例:
[auth] # Login cookie name login_cookie_name = grafana_session # The lifetime (days) an authenticated user can be inactive before being required to login at next visit. Default is 7 days. login_maximum_inactive_lifetime_days = 7 # The maximum lifetime (days) an authenticated user can be logged in since login time before being required to login. Default is 30 days. login_maximum_lifetime_days = 30 # How often should auth tokens be rotated for authenticated users when being active. The default is each 10 minutes. token_rotation_interval_minutes = 10 # The maximum lifetime (seconds) an api key can be used. If it is set all the api keys should have limited lifetime that is lower than this value. api_key_max_seconds_to_live = -1
匿名身份驗證
通過在配置文件中啟用匿名訪問,可以使Grafana無需任何登錄即可訪問。
例:
[auth.anonymous] enabled = true # Organization name that should be used for unauthenticated users org_name = Main Org. # Role for unauthenticated users, other valid values are `Editor` and `Admin` org_role = Viewer
如果您在Grafana UI中更改組織名稱,則需要更新此設置以匹配新名稱。
基本身份驗證
默認情況下,基本身份驗證已啟用,並與內置的Grafana用戶密碼身份驗證系統和LDAP身份驗證集成一起使用。
要禁用基本身份驗證:
[auth.basic] enabled = false
禁用登錄表單
您可以使用以下配置設置隱藏Grafana登錄表單。
[auth] disable_login_form = true
自動OAuth登錄
設置為true可自動嘗試使用OAuth登錄,並跳過登錄屏幕。如果配置了多個OAuth提供程序,則忽略此設置。默認為false
。
[auth] oauth_auto_login = true
隱藏退出菜單
將下面詳述的選項設置為true,以隱藏退出菜單鏈接。如果您使用身份驗證代理,則很有用。
[auth] disable_signout_menu = true
注銷后URL重定向
從Grafana注銷后將用戶重定向到的URL。例如,這可以用於啟用從oauth提供者的注銷。
[auth] signout_redirect_url =
權限概述
Grafana用戶擁有的權限取決於他們:
- 組織角色(管理員,編輯者,查看者)
- 通過已為團隊分配特定權限的團隊成員資格。
- 通過直接分配給用戶的權限(在文件夾,儀表板,數據源上)
- Grafana Admin(即Super Admin)用戶標志。
用戶
一個用戶在Grafana指定帳戶。用戶可以屬於一個或多個組織,並且可以通過角色分配不同級別的特權。
Grafana支持用戶使用多種內部和外部方式進行身份驗證。這些包括來自其自己的集成數據庫,來自外部SQL Server或來自外部LDAP服務器的信息。
Grafana管理員
此admin標志使用戶成為Super Admin
。這意味着他們可以訪問Server Admin
可以管理所有用戶和組織的視圖。
組織角色
用戶可以屬於一個或多個組織。用戶的組織成員資格與定義允許用戶在該組織中執行的操作的角色相關聯。Grafana支持多個組織,以支持多種部署模型,包括使用單個Grafana實例向多個可能不受信任的組織提供服務。
在大多數情況下,Grafana部署在單個組織中。
每個組織可以有一個或多個數據源。
所有儀表板均歸特定組織所有。
注意:大多數度量標准數據庫不提供按用戶系列的身份驗證。這意味着組織數據源和儀表板可用於特定組織中的所有用戶。
有關更多信息,請參考組織角色。
儀表板和文件夾權限
儀表板和文件夾權限允許您刪除編輯者和查看者的默認基於角色的權限,並將權限分配給特定的用戶和團隊。了解有關儀表板和文件夾權限的更多信息。
數據源權限
默認情況下,組織中的任何用戶都可以查詢組織中的數據源。例如,具有Viewer
角色的用戶仍然可以對數據源發出任何可能的查詢,而不僅僅是存在於他/她有權訪問的儀表板上的那些查詢。
數據源權限允許您更改數據源的默認權限,並將查詢權限限制為特定的用戶和團隊。閱讀有關數據源權限的更多信息。
Grafana CLI ¶
Grafana CLI是與Grafana服務器捆綁在一起的小型可執行文件,應該在運行Grafana服務器的同一台計算機上執行。
Grafana CLI具有plugins
和admin
命令以及全局選項。
列出所有命令和選項:
grafana-cli -h
Linux用戶 某些命令(例如安裝或刪除插件)sudo
才能運行。
Windows用戶 一些命令(例如,安裝或刪除插件)要求您以管理員身份運行Windows PowerShell。
輸入命令之前,請進入cd
Grafana bin目錄。默認路徑是:
cd "C:\Program Files\GrafanaLabs\grafana\bin"
Grafana CLI命令語法
Grafana CLI中命令的常規語法為:
grafana-cli [global options] command [command options] [arguments...]
全局選項
Grafana CLI允許您臨時覆蓋某些Grafana默認設置。除--help
和之外--version
,大多數全局選項僅由開發人員使用。
每個全局選項僅適用於使用該命令的命令。例如,--pluginsDir value
不會永久更改Grafana保存插件的位置。它僅在應用該選項的命令中對其進行更改。
顯示Grafana CLI幫助
--help
或-h
顯示幫助,包括默認路徑和Docker配置信息。
例:
grafana-cli -h
顯示Grafana CLI版本
--version
或-v
打印當前正在運行的Grafana CLI的版本。
例:
grafana-cli -v
覆蓋默認插件目錄
--pluginsDir value
覆蓋本地Grafana實例存儲插件的路徑。如果要在默認目錄(“ / var / lib / grafana / plugins”)[$ GF_PLUGIN_DIR]之外的其他位置安裝,更新或刪除插件,請使用此選項。
例:
grafana-cli --pluginsDir "/var/lib/grafana/devplugins" plugins install <plugin-id>
覆蓋默認插件庫
--repo value
允許您從默認Grafana存儲庫以外的資源庫中下載和安裝或更新插件。
例:
grafana-cli --repo "https://example.com/plugins" plugins install <plugin-id>
覆蓋默認插件.zip
--pluginUrl value
允許您從本地URL下載包含插件的.zip文件,而不是從默認的Grafana源下載它。
例:
grafana-cli --pluginUrl https://company.com/grafana/plugins/<plugin-id>-<plugin-version>.zip plugins install <plugin-id>
覆蓋傳輸層安全
警告:關閉TLS是嚴重的安全風險。我們不建議使用此選項。
--insecure
允許您關閉傳輸層安全性(TLS)驗證(不安全)。如果要從非默認來源下載插件,則可能需要執行此操作。
例:
grafana-cli --insecure --pluginUrl https://company.com/grafana/plugins/<plugin-id>-<plugin-version>.zip plugins install <plugin-id>
啟用調試日志記錄
--debug
或-d
啟用調試日志記錄。返回調試輸出,並在終端中顯示。
例:
grafana-cli --debug plugins install <plugin-id>
重寫配置設置
--configOverrides
是一個命令行參數,其作用類似於環境變量覆蓋。
例如,您可以使用它來將日志記錄重定向到另一個文件(例如,將日志記錄安裝在Hosted Grafana之類的服務中),或者在重置管理員密碼時,對於某些重要的配置值(例如數據庫所在的位置),您可以使用非默認值位於)。
例:
grafana-cli --configOverrides cfg:default.paths.log=/dev/null plugins install <plugin-id>
覆蓋HOMEPATH值
設置Grafana安裝/主目錄路徑,默認為工作目錄。如果使用CLI時位於Grafana安裝目錄中,則無需使用此選項。
例:
grafana-cli --homepath "c:\Program Files\grafana" admin reset-admin-password mynewpassword
覆蓋配置文件
--config value
覆蓋Grafana期望配置文件的默認位置。有關配置Grafana和默認配置文件位置的更多信息,請參考配置。
例:
grafana-cli admin reset-admin-password --config "/etc/configuration/" mynewpassword
插件命令
Grafana CLI允許您安裝,升級和管理Grafana插件。有關安裝插件的更多信息,請參閱插件頁面。
所有列出的命令均適用於Grafana默認存儲庫和目錄。您可以使用Global Options覆蓋默認值。
列出可用的插件
grafana-cli plugins list-remote
安裝最新版本的插件
grafana-cli plugins install <plugin-id>
安裝特定版本的插件
grafana-cli plugins install <plugin-id> <version>
列出已安裝的插件
grafana-cli plugins ls
更新所有已安裝的插件
grafana-cli plugins update-all
更新一個插件
grafana-cli plugins update <plugin-id>
刪除一個插件
grafana-cli plugins remove <plugin-id>
管理員命令
管理員命令僅在Grafana 4.1及更高版本中可用。
顯示所有管理命令
grafana-cli admin
重置管理員密碼
grafana-cli admin reset-admin-password <new password>
使用CLI重置admin用戶的密碼。如果您丟失了管理員密碼,則可能需要執行此操作。
如果有兩個標志用於設置本地路徑和配置文件路徑,則運行命令將返回此錯誤:
找不到配置默認值,請確保設置了homepath命令行參數或工作目錄為homepath
要更正此問題,請使用--homepath
global選項為此命令指定Grafana默認的默認路徑:
grafana-cli --homepath "/usr/share/grafana" admin reset-admin-password <new password>
如果您尚未丟失管理員密碼,建議您在“用戶首選項”或“服務器管理”>“用戶”選項卡中更改用戶密碼。
如果需要在腳本中設置密碼,則可以使用Grafana User API。
遷移數據並加密密碼
data-migration
運行用於遷移或清除數據庫中數據的腳本。
encrypt-datasource-passwords
將密碼從不安全的字段遷移到secure_json_data字段。ok
除非有錯誤,否則返回。可以安全執行多次。
例:
grafana-cli admin data-migration encrypt-datasource-passwords
更多參考官方文檔