Kibana 用戶指南（配置Kibana）

配置Kibana

Kibana服務在啓動時從Kibana.yml文件讀取屬性，這個文件的位置取決於你如何安裝Kibana。例如，若是從歸檔發行版（.tar.gz或.zip）安裝Kibana，默認狀況下是$KIBANA_HOME/config。默認狀況下，對於包發行版（Debian或RPM），它在/etc/kibana中。

默認設置將Kibana配置爲在localhost:5601上運行，要更改主機或端口號，或鏈接到運行在另外一臺機器上的Elasticsearch，你須要更新kibana.yml文件。還能夠啓用SSL並設置各類其餘選項，最後，可使用${MY_ENV_VAR}語法將環境變量注入配置。

Kibana配置設置

console.enabled：

• 默認：true
• 設置爲false以禁用控制檯，切換這個將致使服務器在下一次啓動時從新生成資源，這可能會致使在頁面在開始服務以前出現延遲。

cpu.cgroup.path.override：

• 當掛載的方式與/proc/self/cgroup不一致時，覆蓋cgroup cpu路徑。

cpuacct.cgroup.path.override：

• 當掛載的方式與/proc/self/cgroup不一致時，覆蓋cgroup cpuacct路徑。

elasticsearch.customHeaders：

• 默認：{}
• 發送給Elasticsearch的Header名稱和值，任何自定義的頭都不能被客戶端的header覆蓋，無論elasticsearch.requestHeadersWhitelist的配置。

elasticsearch.logQueries：

• 默認：false
• 日誌查詢發送到Elasticsearch，要求將logging.verbose設置爲true，這對於查看當前沒有監控面板的應用程序生成的查詢DSL很是有用，例如Timelion和Monitoring。

elasticsearch.pingTimeout：

• 默認：elasticsearch.requestTimeout設置的值。
• 等待Elasticsearch響應ping的時間（毫秒）。

elasticsearch.preserveHost：

• 默認：true
• 當此設置的值爲true時，Kibana使用server.host中指定的主機名的設置，當此設置的值爲false時，Kibana使用鏈接到此Kibana實例的主機的主機名。

elasticsearch.requestHeadersWhitelist：

• 默認：[ 'authorization' ]
• 送到Elasticsearch的Kibana客戶端headers列表，要發送無客戶端headers，請將此值設置爲[]（空列表）。

elasticsearch.requestTimeout：

• 默認：30000
• 等待來自後端或Elasticsearch的響應的毫秒數，這個值必須是正整數。

elasticsearch.shardTimeout：

• 默認：30000
• Elasticsearch等待碎片響應的毫秒數，設置爲0禁用。

elasticsearch.ssl.certificate和elasticsearch.ssl.key：

• 可選設置，提供pem格式的SSL證書和密鑰文件的路徑，這些文件用於驗證Kibana到Elasticsearch的身份，當在Elasticsearch中xpack.ssl.verification_mode被設置爲certificate或full時須要這些文件。

elasticsearch.ssl.certificateAuthorities：

• 可選設置，使你可以爲你的Elasticsearch實例的證書頒發機構指定PEM文件的路徑列表。

elasticsearch.ssl.keyPassphrase：

• 用於解密私鑰的密碼，此值是可選的，由於密鑰可能沒有加密。

elasticsearch.ssl.verificationMode：

• 默認：full
• 控制Elasticsearch所提供證書的驗證，有效值爲none、certificate和full，full執行主機名驗證，而certificate不執行。

elasticsearch.startupTimeout：

• 默認：5000
• 在Kibana啓動前等待Elasticsearch的毫秒時間。

elasticsearch.url：

• 默認："http://localhost:9200"
• 用於全部查詢的Elasticsearch實例的URL。

elasticsearch.username和elasticsearch.password：

• 若是你的Elasticsearch受到基自己份驗證的保護，這些設置將提供Kibana服務器在啓動時用於對Kibana索引進行維護的用戶名和密碼，你的Kibana用戶仍然須要使用Elasticsearch進行身份驗證，這是經過Kibana服務器進行的。

elasticsearch.tribe.customHeaders：

• 默認：{}
• 發送給Elasticsearch的Header名稱和值，任何自定義headers都不能被客戶端標headers覆蓋，無論elasticsearch.tribe.requestHeadersWhitelist配置。

elasticsearch.tribe.pingTimeout：

• 默認：elasticsearch.tribe.requestTimeout設置的值
• 等待Elasticsearch響應ping的時間（毫秒）。

elasticsearch.tribe.requestHeadersWhitelist：

• 默認：[ 'authorization' ]
• 發送到Elasticsearch的Kibana客戶端headers列表，要發送無客戶端headers，請將此值設置爲[]（空列表）。

elasticsearch.tribe.requestTimeout：

• 默認：30000
• 等待後端或Elasticsearch響應的時間（以毫秒爲單位），這個值必須是一個正整數。

elasticsearch.tribe.ssl.certificate和elasticsearch.tribe.ssl.key：

• 可選設置，提供pem格式的SSL證書和密鑰文件的路徑，這些文件驗證你的Elasticsearch後端使用相同的密鑰文件。

elasticsearch.tribe.ssl.certificateAuthorities：

• 可選設置，使你可以爲你的tribe Elasticsearch實例的證書頒發機構指定PEM文件的路徑。

elasticsearch.tribe.ssl.keyPassphrase：

• 用於解密私鑰的密碼，此值是可選的，由於密鑰可能沒有加密。

elasticsearch.tribe.ssl.verificationMode：

• 默認：full
• 控制證書的驗證，有效值爲none、certificate和full，full執行主機名驗證，而certificate不執行。

elasticsearch.tribe.url：

• 可供全部查詢使用的Elasticsearch tribe實例的可選的URL。

elasticsearch.tribe.username和elasticsearch.tribe.password：

• 若是你的Elasticsearch受到基自己份驗證的保護，這些設置將提供Kibana服務器在啓動時用於對Kibana索引進行維護的用戶名和密碼，你的Kibana用戶仍然須要使用Elasticsearch進行身份驗證，這是經過Kibana服務器進行的。

kibana.defaultAppId：

• 默認："discover"
• 要加載的默認應用程序。

kibana.index：

• 默認：".kibana"
• Kibana使用Elasticsearch中的索引來存儲保存的搜索、可視化和儀表盤，若是索引不存在，Kibana會建立一個新的索引。

logging.dest：

• 默認：stdout
• 容許你指定一個文件存儲Kibana日誌輸出。

logging.quiet：

• 默認：false
• 將此設置的值設置爲true，以抑制除錯誤消息以外的全部日誌輸出。

logging.silent：

• 默認：false
• 將此設置的值設置爲true以抑制全部日誌輸出。

logging.verbose：

• 默認：false
• 將此設置的值設置爲true，以記錄全部事件，包括系統使用信息和全部請求，在Elastic Cloud Enterprise上支持。

logging.useUTC：

• 默認：true
• 將此設置的值設置爲false，以便使用服務器的時區（而不是UTC）記錄事件。

map.includeElasticMapsService：

• 默認：true
• 打開或關閉Elastic Maps服務的層是否應該包含在矢量和平鋪層選項列表中，經過關閉這個選項，只包含在這裏配置的層。

path.data：

• 默認：data
• Kibana存儲持久數據的路徑，不存儲在Elasticsearch。

pid.file：

• 指定Kibana建立進程ID文件的路徑。

ops.interval：

• 默認：5000
• 設置以毫秒爲單位的間隔，以採樣系統和處理性能指標，最小值是100。

regionmap：

• 指定用於區域地圖可視化的其餘矢量層，每一個層對象指向一個包含geojson特徵集的外部向量文件，該文件必須使用WGS84座標參考系統，而且只包括多邊形，若是文件駐留在與Kibana分離的域中，則服務器須要啓用內核，以便Kibana能夠下載該文件，下面的示例顯示了有效的regionmap配置。

regionmap:
  includeElasticMapsService: false
  layers:
     - name: "Departments of France"
       url: "http://my.cors.enabled.server.org/france_departements.geojson"
       attribution: "INRAP"
       fields:
          - name: "department"
            description: "Full department name"
          - name: "INSEE"
            description: "INSEE numeric identifier"

regionmap.layers[].name：

• 強制性的，提供的地圖的描述，在Elastic Cloud Enterprise上支持。

regionmap.layers[].url：

• 強制性的，由webserver提供的geojson文件的位置，在Elastic Cloud Enterprise上支持。

regionmap.layers[].attribution：

• 可選的，引用geojson文件的源文件，在Elastic Cloud Enterprise上支持。

regionmap.layers[].fields[]：

• 強制性的，每一個層能夠包含多個字段，以指示你但願公開的geojson特性的哪些屬性，上面的示例展現瞭如何定義多個屬性，在Elastic Cloud Enterprise上支持。

regionmap.layers[].fields[].name：

• 強制性的，這個值用於在存儲在Elasticsearch中的文檔和geojson文件之間進行內部鏈接，例如，若是geojson中的字段被稱爲Location，而且具備城市名稱，那麼Elasticsearch中的字段必須具備與Kibana用於查找geoshape數據相同的值，在Elastic Cloud Enterprise上支持。

regionmap.layers[].fields[]. description：

• 強制性的，在構建區域地圖可視化時，在Options選項卡下顯示的可讀文本，在Elastic Cloud Enterprise上支持。

regionmap.includeElasticMapsService：

• 打開或關閉Elastic映射服務的層是否應該包含在向量層選項列表中，在Elastic Cloud Enterprise上支持，經過關閉它，將只包括這裏配置的層，默認爲true。

server.basePath：

• 容許你指定掛載Kibana的路徑，若是你運行在代理後面，使用server.rewriteBasePath設置告訴Kibana是否應該從接收到的請求中刪除basePath，並防止在啓動時發出棄用警告，此設置不能以斜槓（/）結束。

server.rewriteBasePath：

• 默認：false
• 指定Kibana是應該重寫以server.basePath爲前綴的請求，仍是須要經過反向代理重寫請求，在Kibana 6.3以前，這個設置實際上老是爲false，而且開始在Kibana 7.0中默認爲true。

server.customResponseHeaders：

• 默認：{}
• Header名稱和值，用於將全部響應從Kibana服務器發送到客戶端。

server.defaultRoute：

• 默認："/app/kibana"
• 此設置指定在打開Kibana時的默認路由，在打開Kibana時，可使用此設置修改登陸頁面。

server.host：

• 默認："localhost"
• 此設置指定後端服務器的主機。

server.maxPayloadBytes：

• 默認：1048576
• 傳入服務器請求的最大有效負載大小（以字節爲單位）。

server.name：

• 默認："your-hostname"
• 標識這個Kibana實例的可讀顯示名稱。

server.port：

• 默認：5601
• Kibana由後端服務器提供，此設置指定要使用的端口。

server.ssl.enabled：

• 默認：false
• 爲從Kibana服務器發送到瀏覽器的請求啓用SSL，當設置爲true時，server.ssl.certificate和server.ssl.key是必需的。

server.ssl.certificate和server.ssl.key：

• 分別指向PEM格式SSL證書和SSL密鑰文件的路徑。

server.ssl.certificateAuthorities：

• 應該受信任的PEM編碼證書文件路徑列表。

server.ssl.cipherSuites：

• 默認：ECDHE-RSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-ECDSA-AES256-GCM-SHA384, DHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES128-SHA256, DHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, DHE-RSA-AES256-SHA384, ECDHE-RSA-AES256-SHA256, DHE-RSA-AES256-SHA256, HIGH,!aNULL, !eNULL, !EXPORT, !DES, !RC4, !MD5, !PSK, !SRP, !CAMELLIA。
• 有關格式和有效選項的詳細信息能夠經過OpenSSL密碼列表格式文檔得到。

server.ssl.keyPassphrase：

• 用於解密私鑰的密碼，這個值是可選的，由於密鑰可能沒有被加密。

server.ssl.redirectHttpFromPort：

• Kibana將綁定到這個端口，並經過配置爲server.port的端口將全部http請求重定向到https。

server.ssl.supportedProtocols：

• 默認：TLSv1，TLSv1.1，TLSv1.2。
• 帶有版本的受支持協議數組，有效協議：TLSv1、TLSv1.1、TLSv1.2。

status.allowAnonymous：

• 默認：false。
• 若是啓用了身份驗證，將其設置爲true將容許未經身份驗證的用戶訪問Kibana服務器狀態API和狀態頁面。

tilemap.options.attribution：

• 默認：©，Elastic Maps Service"。
• map屬性字符串，在Elastic Cloud Enterprise上支持。

tilemap.options.maxZoom：

• 默認：10
• 最大縮放級別，在Elastic Cloud Enterprise上支持。

tilemap.options.minZoom：

• 默認：1
• 最小縮放級別，在Elastic Cloud Enterprise上支持。

tilemap.options.subdomains：

• 默認：false
• 由tile服務使用的子域數組，在Elastic Cloud Enterprise上支持，使用令牌{s}指定子域的位置URL。

tilemap.url：

• Kibana用於在tilemap可視化中顯示地圖塊的tileservice的URL，默認狀況下，Kibana從外部元數據服務讀取這個url，可是用戶仍然能夠覆蓋這個參數來使用他們本身的Tile Map服務，例如："https://tiles.elastic.co/v2/default/{z}/{x}/{y}.png?elastic_tile_service_tos=agree&my_app_name=kibana"

vega.enableExternalUrls：

• 默認：false
• 將此值設置爲true，容許Vega使用任何URL訪問外部數據源和圖像，若是爲false，Vega只能從Elasticsearch得到數據。

安全設置

有些設置是敏感的，僅依靠文件系統權限來保護它們的值是不夠的，對於這個用例，Kibana提供了一個keystore，以及用於管理keystore中的設置的kibana-keystore工具。

這裏的全部命令都應該做爲運行Kibana的用戶運行。

建立keystore

要建立kibana.keystore，使用create命令：

bin/kibana-keystore create

文件kibana.keystore將在path.data配置設置定義的目錄中建立。

列出keystore中的設置

使用list命令能夠得到keystore中的設置列表：

bin/kibana-keystore list

添加字符串設置

敏感字符串設置，如Elasticsearch的身份驗證憑證，可使用add命令添加：

bin/kibana-keystore add the.setting.name.to.set

一旦添加到keystore，這些設置將在啓動時自動應用到Kibana實例，舉個例子：

bin/kibana-keystore add elasticsearch.username

將提示你提供elasticsearch.username的值，你的輸入將顯示爲星號。

該工具將提示設置的值，要經過stdin傳遞值，使用--stdin標誌：

cat /file/containing/setting/value | bin/kibana-keystore add the.setting.name.to.set --stdin

移除設置

要從keystore中移除設置，請使用remove命令：

bin/kibana-keystore remove the.setting.name.to.remove

---

上一篇：啓動和中止Kibana