Configure Kibana
The Kibana server reads properties from the kibana.yml
file on startup. The location of this file differs depending on how you installed Kibana. For example, if you installed Kibana from an archive distribution (.tar.gz
or .zip
), by default it is in $KIBANA_HOME/config
. By default, with package distributions (Debian or RPM), it is in /etc/kibana
.
The default host and port settings configure Kibana to run on localhost:5601
. To change this behavior and allow remote users to connect, you’ll need to update your kibana.yml
file. You can also enable SSL and set a variety of other options. Finally, environment variables can be injected into configuration using ${MY_ENV_VAR}
syntax.
| Toggling this causes the server to regenerate assets on the next startup, which may cause a delay before pages start being served. Set to |
| Override for cgroup cpu path when mounted in a manner that is inconsistent with |
| Override for cgroup cpuacct path when mounted in a manner that is inconsistent with |
| A content-security-policy template that disables certain unnecessary and potentially insecure capabilities in the browser. It is strongly recommended that you keep the default CSP rules that ship with Kibana. |
Blocks Kibana access to any browser that does not enforce even rudimentary CSP rules. In practice, this disables support for older, less safe browsers like Internet Explorer. For more information, refer to Content Security Policy. Default: | |
| Shows a warning message after loading Kibana to any browser that does not enforce even rudimentary CSP rules, though Kibana is still accessible. This configuration is effectively ignored when |
| Header names and values to send to Elasticsearch. Any custom headers cannot be overwritten by client-side headers, regardless of the |
The URLs of the Elasticsearch instances to use for all your queries. All nodes listed here must be on the same cluster. Default: | |
| Log queries sent to Elasticsearch. Requires |
Time in milliseconds to wait for Elasticsearch to respond to pings. Default: the value of the | |
| When the value is |
List of Kibana client-side headers to send to Elasticsearch. To send no client-side headers, set this value to [] (an empty list). Removing the | |
Time in milliseconds to wait for responses from the back end or Elasticsearch. This value must be a positive integer. Default: | |
| Time in milliseconds for Elasticsearch to wait for responses from shards. Set to 0 to disable. Default: |
| Time in milliseconds between requests to check Elasticsearch for an updated list of nodes. Default: |
| Attempt to find other Elasticsearch nodes on startup. Default: |
| Update the list of Elasticsearch nodes immediately following a connection fault. Default: |
Controls Kibana behavior in regard to presenting a client certificate when requested by Elasticsearch. This setting applies to all outbound SSL/TLS connections to Elasticsearch, including requests that are proxied for end users. Default: |
When Elasticsearch uses certificates to authenticate end users with a PKI realm and elasticsearch.ssl.alwaysPresentCertificate
is true
, proxied requests may be executed as the identity that is tied to the Kibana server.
Paths to a PEM-encoded X.509 client certificate and its corresponding private key. These are used by Kibana to authenticate itself when making outbound SSL/TLS connections to Elasticsearch. For this setting to take effect, the |
These settings cannot be used in conjunction with elasticsearch.ssl.keystore.path
.
Paths to one or more PEM-encoded X.509 certificate authority (CA) certificates, which make up a trusted certificate chain for Elasticsearch. This chain is used by Kibana to establish trust when making outbound SSL/TLS connections to Elasticsearch. + In addition to this setting, trusted certificates may be specified via | |
| The password that decrypts the private key that is specified via |
Path to a PKCS#12 keystore that contains an X.509 client certificate and it’s corresponding private key. These are used by Kibana to authenticate itself when making outbound SSL/TLS connections to Elasticsearch. For this setting, you must also set the |
This setting cannot be used in conjunction with elasticsearch.ssl.certificate
or elasticsearch.ssl.key
.
| The password that decrypts the keystore specified via |
Path to a PKCS#12 trust store that contains one or more X.509 certificate authority (CA) certificates, which make up a trusted certificate chain for Elasticsearch. This chain is used by Kibana to establish trust when making outbound SSL/TLS connections to Elasticsearch. + In addition to this setting, trusted certificates may be specified via | |
| The password that decrypts the trust store specified via |
| Controls the verification of the server certificate that Kibana receives when making an outbound SSL/TLS connection to Elasticsearch. Valid values are |
| Time in milliseconds to wait for Elasticsearch at Kibana startup before retrying. Default: |
If your Elasticsearch is protected with basic authentication, these settings provide the username and password that the Kibana server uses to perform maintenance on the Kibana index at startup. Kibana users still need to authenticate with Elasticsearch, which is proxied through the Kibana server. | |
| Enables use of interpreter in Visualize. Default: |
| deprecated This setting is deprecated and will get removed in Kibana 8.0. Please use the |
Kibana uses an index in Elasticsearch to store saved searches, visualizations, and dashboards. Kibana creates a new index if the index doesn’t already exist. If you configure a custom index, the name must be lowercase, and conform to the Elasticsearch index name limitations. Default: | |
Time in milliseconds to wait for autocomplete suggestions from Elasticsearch. This value must be a whole number greater than zero. Default: | |
Maximum number of documents loaded by each shard to generate autocomplete suggestions. This value must be a whole number greater than zero. Default: | |
Enables you to specify a file where Kibana stores log output. Default: | |
| Logs output as JSON. When set to |
| Set the value of this setting to |
| [experimental] This functionality is experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features. Specifies the options for the logging rotate feature. When not defined, all the sub options defaults would be applied. The following example shows a valid logging rotate configuration: |
logging.rotate:
enabled: true
everyBytes: 10485760
keepFiles: 10
| [experimental] This functionality is experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features. Set the value of this setting to |
| [experimental] This functionality is experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features. The maximum size of a log file (that is |
| [experimental] This functionality is experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features. The number of most recent rotated log files to keep on disk. Older files are deleted during log rotation. The default value is 7. The |
| [experimental] This functionality is experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features. The number of milliseconds for the polling strategy in case the |
[experimental] This functionality is experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features. By default we try to understand the best way to monitoring the log file and warning about it. Please be aware there are some systems where watch api is not accurate. In those cases, in order to get the feature working, the | |
| Set the value of this setting to |
| Set to the canonical timezone ID (for example, |
Set to | |
Set to | |
| Set to |
Specifies additional vector layers for use in Maps visualizations. Each layer object points to an external vector file that contains a geojson FeatureCollection. The file must use the WGS84 coordinate reference system (ESPG:4326) and only include polygons. If the file is hosted on a separate domain from Kibana, the server needs to be CORS-enabled so Kibana can download the file. The following example shows a valid region map configuration. |
map.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"
Turns on or off whether layers from the Elastic Maps Service should be included in the vector layer option list. By turning this off, only the layers that are configured here will be included. The default is | |
Optional. References the originating source of the geojson file. | |
Mandatory. Each layer can contain multiple fields to indicate what properties from the geojson features you wish to expose. The following shows how to define multiple properties: |
map.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"
Mandatory. The human readable text that is shown under the Options tab when building the Region Map visualization. | |
Mandatory. This value is used to do an inner-join between the document stored in Elasticsearch and the geojson file. For example, if the field in the geojson is called | |
Mandatory. A description of the map being provided. | |
Mandatory. The location of the geojson file as provided by a webserver. | |
The map attribution string. Default: | |
The maximum zoom level. Default: | |
The minimum zoom level. Default: | |
An array of subdomains used by the tile service. Specify the position of the subdomain the URL with the token | |
The URL to the tileservice that Kibana uses to display map tiles in tilemap visualizations. By default, Kibana reads this URL from an external metadata service, but users can override this parameter to use their own Tile Map Service. For example: | |
| Controls whether to enable the newsfeed system for the Kibana UI notification center. Set to |
The path where Kibana stores persistent data not saved in Elasticsearch. Default: | |
| Specifies the path where Kibana creates the process ID file. |
| Set the interval in milliseconds to sample system and process performance metrics. The minimum value is 100. Default: |
Enables you to specify a path to mount Kibana at if you are running behind a proxy. Use the | |
Set to | |
| Specifies an array of trusted hostnames, such as the Kibana host, or a reverse proxy sitting in front of it. This determines whether HTTP compression may be used for responses, based on the request |
Header names and values to send on all responses to the client from the Kibana server. Default: | |
This setting specifies the host of the back end server. To allow remote users to connect, set the value to the IP address or DNS name of the Kibana server. Default: | |
| The number of milliseconds to wait for additional data before restarting the |
| The maximum payload size in bytes for incoming server requests. Default: |
| A human-readable display name that identifies this Kibana instance. Default: |
Kibana is served by a back end server. This setting specifies the port to use. Default: | |
Specifies whether Kibana should rewrite requests that are prefixed with | |
The number of milliseconds to wait before closing an inactive socket. Default: | |
Paths to a PEM-encoded X.509 server certificate and its corresponding private key. These are used by Kibana to establish trust when receiving inbound SSL/TLS connections from users. |
These settings cannot be used in conjunction with server.ssl.keystore.path
.
Paths to one or more PEM-encoded X.509 certificate authority (CA) certificates which make up a trusted certificate chain for Kibana. This chain is used by Kibana to establish trust when receiving inbound SSL/TLS connections from end users. If PKI authentication is enabled, this chain is also used by Kibana to verify client certificates from end users. + In addition to this setting, trusted certificates may be specified via | |
| Details on the format, and the valid options, are available via the OpenSSL cipher list format documentation. Default: |
| Controls the behavior in Kibana for requesting a certificate from client connections. Valid values are |
Enables SSL/TLS for inbound connections to Kibana. When set to | |
| The password that decrypts the private key that is specified via |
Path to a PKCS#12 keystore that contains an X.509 server certificate and its corresponding private key. If the keystore contains any additional certificates, those will be used as a trusted certificate chain for Kibana. All of these are used by Kibana to establish trust when receiving inbound SSL/TLS connections from end users. The certificate chain is also used by Kibana to verify client certificates from end users when PKI authentication is enabled. + In addition to this setting, trusted certificates may be specified via |
This setting cannot be used in conjunction with server.ssl.certificate
or server.ssl.key
| The password that will be used to decrypt the keystore specified via |
Path to a PKCS#12 trust store that contains one or more X.509 certificate authority (CA) certificates which make up a trusted certificate chain for Kibana. This chain is used by Kibana to establish trust when receiving inbound SSL/TLS connections from end users. If PKI authentication is enabled, this chain is also used by Kibana to verify client certificates from end users. + In addition to this setting, trusted certificates may be specified via | |
| The password that will be used to decrypt the trust store specified via |
| Kibana binds to this port and redirects all http requests to https over the port configured as |
| An array of supported protocols with versions. Valid protocols: |
It is not recommended to disable protections for arbitrary API endpoints. Instead, supply the |
*Default: [ ]* An array of API endpoints which should be exempt from Cross-Site Request Forgery ("XSRF") protections.
Setting this to | |
| If authentication is enabled, setting this to |
When | |
When | |
| Reporting your cluster statistics helps us improve your user experience. Your data is never shared with anyone. Set to |
Set this value to true to allow Vega to use any URL to access external data sources and images. When false, Vega can only get data from Elasticsearch. Default: | |
| Set this value to false to disable the License Management UI. Default: |
| Set this value to false to disable the Rollup UI. Default: true |
Set this value to change the Kibana interface language. Valid locales are: |