Configuring Kibana
editConfiguring Kibana
editThe 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 whether to always present the certificate specified by
|
|
Optional settings that provide the paths to the PEM-format SSL certificate and key files.
These files are used to verify the identity of Kibana to Elasticsearch and are required when
|
|
Optional setting that enables you to specify a list of paths to the PEM file for the certificate authority for your Elasticsearch instance. |
|
The password that decrypts the private key that is specified
via |
|
Controls the verification of certificates presented by 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: |
|
The default application to load. Default: |
|
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 |
|
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. Supported on Elastic Cloud Enterprise. Each layer object points to an external vector file that contains a geojson FeatureCollection. The file must use the WGS84 coordinate reference system 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. Supported on Elastic Cloud Enterprise. 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. Supported on Elastic Cloud Enterprise. |
|
Mandatory. Each layer can contain multiple fields to indicate what properties from the geojson features you wish to expose. Supported on Elastic Cloud Enterprise. 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. Supported on Elastic Cloud Enterprise. |
|
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. Supported on Elastic Cloud Enterprise. |
|
Mandatory. The location of the geojson file as provided by a webserver. Supported on Elastic Cloud Enterprise. |
|
The map attribution string. Supported on Elastic Cloud Enterprise.
Default: |
|
The maximum zoom level. Supported on Elastic Cloud Enterprise. Default: |
|
The minimum zoom level. Supported on Elastic Cloud Enterprise. 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. Supported on Elastic Cloud Enterprise. 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:
|
|
|
Set the interval in milliseconds to sample
system and process performance metrics. The minimum value is 100. Default: |
|
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. |
|
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 the PEM-format SSL certificate and SSL key files. |
|
Paths to one or more PEM-encoded certificate files that should be trusted. |
|
Details on the format, and the valid options, are available via the
OpenSSL cipher list format documentation.
Default: |
|
Controls the server’s behavior in regard to requesting a certificate from client
connections. Valid values are |
|
Enables SSL/TLS for inbound connections to Kibana. When set to |
|
The passphras that decrypts the private key. This value is optional, as the key may not be encrypted. |
|
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. Set to
|
|
Set this value to |
|
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: |