IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Install Kibana on macOS with Homebrew Alerting and action settings in Kibana »

› ›

Configure Kibana

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Configure Kibana

edit

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.

console.enabled

Toggling this causes the server to regenerate assets on the next startup, which may cause a delay before pages start being served. Set to false to disable Console. Default: true

cpu.cgroup.path.override

deprecated This setting has been renamed to ops.cGroupOverrides.cpuPath and the old name will no longer be supported as of 8.0.

cpuacct.cgroup.path.override

deprecated This setting has been renamed to ops.cGroupOverrides.cpuAcctPath and the old name will no longer be supported as of 8.0.

csp.rules

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.

csp.strict

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: true

csp.warnLegacyBrowsers

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 csp.strict is enabled. Default: true

elasticsearch.customHeaders

Header names and values to send to Elasticsearch. Any custom headers cannot be overwritten by client-side headers, regardless of the elasticsearch.requestHeadersWhitelist configuration. Default: {}

elasticsearch.hosts:

The URLs of the Elasticsearch instances to use for all your queries. All nodes listed here must be on the same cluster. Default: [ "http://localhost:9200" ]

To enable SSL/TLS for outbound connections to Elasticsearch, use the https protocol in this setting.

elasticsearch.logQueries

Log queries sent to Elasticsearch. Requires logging.verbose set to true. This is useful for seeing the query DSL generated by applications that currently do not have an inspector, for example Timelion and Monitoring. Default: false

elasticsearch.pingTimeout

Time in milliseconds to wait for Elasticsearch to respond to pings. Default: the value of the elasticsearch.requestTimeout setting

elasticsearch.requestHeadersWhitelist

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 authorization header from being whitelisted means that you cannot use basic authentication in Kibana. Default: [ 'authorization' ]

elasticsearch.requestTimeout

Time in milliseconds to wait for responses from the back end or Elasticsearch. This value must be a positive integer. Default: 30000

elasticsearch.shardTimeout

Time in milliseconds for Elasticsearch to wait for responses from shards. Set to 0 to disable. Default: 30000

elasticsearch.sniffInterval

Time in milliseconds between requests to check Elasticsearch for an updated list of nodes. Default: false

elasticsearch.sniffOnStart

Attempt to find other Elasticsearch nodes on startup. Default: false

elasticsearch.sniffOnConnectionFault

Update the list of Elasticsearch nodes immediately following a connection fault. Default: false

elasticsearch.ssl.alwaysPresentCertificate

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: false

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.

elasticsearch.ssl.certificate and elasticsearch.ssl.key

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 xpack.security.http.ssl.client_authentication setting in Elasticsearch must be also be set to "required" or "optional" to request a client certificate from Kibana.

These settings cannot be used in conjunction with elasticsearch.ssl.keystore.path.

elasticsearch.ssl.certificateAuthorities

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 elasticsearch.ssl.keystore.path and/or elasticsearch.ssl.truststore.path.

elasticsearch.ssl.keyPassphrase

The password that decrypts the private key that is specified via elasticsearch.ssl.key. This value is optional, as the key may not be encrypted.

elasticsearch.ssl.keystore.path

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 xpack.security.http.ssl.client_authentication setting in Elasticsearch to "required" or "optional" to request a client certificate from Kibana.

If the keystore contains any additional certificates, they are used as 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 elasticsearch.ssl.certificateAuthorities and/or elasticsearch.ssl.truststore.path.

This setting cannot be used in conjunction with elasticsearch.ssl.certificate or elasticsearch.ssl.key.

elasticsearch.ssl.keystore.password

The password that decrypts the keystore specified via elasticsearch.ssl.keystore.path. If the keystore has no password, leave this as blank. If the keystore has an empty password, set this to "".

elasticsearch.ssl.truststore.path

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 elasticsearch.ssl.certificateAuthorities and/or elasticsearch.ssl.keystore.path.

elasticsearch.ssl.truststore.password

The password that decrypts the trust store specified via elasticsearch.ssl.truststore.path. If the trust store has no password, leave this as blank. If the trust store has an empty password, set this to "".

elasticsearch.ssl.verificationMode

Controls the verification of the server certificate that Kibana receives when making an outbound SSL/TLS connection to Elasticsearch. Valid values are "full", "certificate", and "none". Using "full" performs hostname verification, using "certificate" skips hostname verification, and using "none" skips verification entirely. Default: "full"

elasticsearch.username and elasticsearch.password

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.

enterpriseSearch.host

The URL of your Enterprise Search instance

interpreter.enableInVisualize

Enables use of interpreter in Visualize. Default: true

kibana.defaultAppId

deprecated This setting is deprecated and will get removed in Kibana 8.0. Please use the defaultRoute advanced setting instead. The default application to load. Default: "home"

kibana.index

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: ".kibana"

kibana.autocompleteTimeout

Time in milliseconds to wait for autocomplete suggestions from Elasticsearch. This value must be a whole number greater than zero. Default: "1000"

kibana.autocompleteTerminateAfter

Maximum number of documents loaded by each shard to generate autocomplete suggestions. This value must be a whole number greater than zero. Default: "100000"

To reload the logging settings, send a SIGHUP signal to Kibana.

logging.dest

Enables you to specify a file where Kibana stores log output. Default: stdout

logging.json

Logs output as JSON. When set to true, the logs are formatted as JSON strings that include timestamp, log level, context, message text, and any other metadata that may be associated with the log message. When logging.dest.stdout is set, and there is no interactive terminal ("TTY"), this setting defaults to true. Default: false

logging.quiet

Set the value of this setting to true to suppress all logging output other than error messages. Default: false

logging.rotate

[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview 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

logging.rotate.enabled

[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Set the value of this setting to true to enable log rotation. If you do not have a logging.dest set that is different from stdout that feature would not take any effect. Default: false

logging.rotate.everyBytes

[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. The maximum size of a log file (that is not an exact limit). After the limit is reached, a new log file is generated. The default size limit is 10485760 (10 MB) and this option should be in the range of 1048576 (1 MB) to 1073741824 (1 GB). Default: 10485760

logging.rotate.keepFiles

[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview 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 logging.rotate.keepFiles option has to be in the range of 2 to 1024 files. Default: 7

logging.rotate.pollingInterval

[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. The number of milliseconds for the polling strategy in case the logging.rotate.usePolling is enabled. logging.rotate.usePolling must be in the 5000 to 3600000 millisecond range. Default: 10000

logging.rotate.usePolling

[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview 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 polling method could be used enabling that option. Default: false

logging.silent

Set the value of this setting to true to suppress all logging output. Default: false

logging.timezone

Set to the canonical time zone ID (for example, America/Los_Angeles) to log events using that time zone. For possible values, refer to database time zones. Default: UTC

logging.verbose

Set to true to log all events, including system usage information and all requests. Default: false

map.includeElasticMapsService

Set to false to disable connections to Elastic Maps Service. When includeElasticMapsService is turned off, only the vector layers configured by map.regionmap and the tile layer configured by map.tilemap.url are available in Maps. Default: true

map.proxyElasticMapsServiceInMaps

Set to true to proxy all Maps application Elastic Maps Service requests through the Kibana server. Default: false

map.regionmap

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"

map.regionmap.layers[].attribution

Optional. References the originating source of the geojson file.

map.regionmap.layers[].fields[]

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"

map.regionmap.layers[].fields[].description

Mandatory. The human readable text that is shown under the Options tab when building the Region Map visualization.

map.regionmap.layers[].fields[].name

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 Location and has city names, there must be a field in Elasticsearch that holds the same values that Kibana can then use to lookup for the geoshape data.

map.regionmap.layers[].name

Mandatory. A description of the map being provided.

map.regionmap.layers[].url

Mandatory. The location of the geojson file as provided by a webserver.

map.tilemap.options.attribution

The map attribution string. Default: "© [Elastic Maps Service](https://www.elastic.co/elastic-maps-service)"

map.tilemap.options.maxZoom

The maximum zoom level. Default: 10

map.tilemap.options.minZoom

The minimum zoom level. Default: 1

map.tilemap.options.subdomains

An array of subdomains used by the tile service. Specify the position of the subdomain the URL with the token {s}.

map.tilemap.url

The URL to the service that Kibana uses as the default basemap in maps and vega maps. By default, Kibana sets a basemap from the Elastic Maps Service, but users can point to their own Tile Map Service. For example: "https://tiles.elastic.co/v2/default/{z}/{x}/{y}.png?elastic_tile_service_tos=agree&my_app_name=kibana"

newsfeed.enabled

Controls whether to enable the newsfeed system for the Kibana UI notification center. Set to false to disable the newsfeed system. Default: true

path.data

The path where Kibana stores persistent data not saved in Elasticsearch. Default: data

pid.file

Specifies the path where Kibana creates the process ID file.

ops.interval

Set the interval in milliseconds to sample system and process performance metrics. The minimum value is 100. Default: 5000

ops.cGroupOverrides.cpuPath

Override for cgroup cpu path when mounted in a manner that is inconsistent with /proc/self/cgroup.

ops.cGroupOverrides.cpuAcctPath

Override for cgroup cpuacct path when mounted in a manner that is inconsistent with /proc/self/cgroup.

server.basePath

Enables you to specify a path to mount Kibana at if you are running behind a proxy. Use the server.rewriteBasePath setting to tell Kibana if it should remove the basePath from requests it receives, and to prevent a deprecation warning at startup. This setting cannot end in a slash (/).

server.compression.enabled

Set to false to disable HTTP compression for all responses. Default: true

server.compression.referrerWhitelist

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 Referer header. This setting may not be used when server.compression.enabled is set to false. Default: none

server.customResponseHeaders

Header names and values to send on all responses to the client from the Kibana server. Default: {}

server.host

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: "localhost"

server.keepaliveTimeout

The number of milliseconds to wait for additional data before restarting the server.socketTimeout counter. Default: "120000"

server.maxPayload

The maximum payload size in bytes for incoming server requests. Default: 1048576

server.name

A human-readable display name that identifies this Kibana instance. Default: "your-hostname"

server.port

Kibana is served by a back end server. This setting specifies the port to use. Default: 5601

server.requestId.allowFromAnyIp

Sets whether or not the X-Opaque-Id header should be trusted from any IP address for identifying requests in logs and forwarded to Elasticsearch.

server.requestId.ipAllowlist

A list of IPv4 and IPv6 address which the X-Opaque-Id header should be trusted from. Normally this would be set to the IP addresses of the load balancers or reverse-proxy that end users use to access Kibana. If any are set, server.requestId.allowFromAnyIp must also be set to false.

server.rewriteBasePath

Specifies whether Kibana should rewrite requests that are prefixed with server.basePath or require that they are rewritten by your reverse proxy. In Kibana 6.3 and earlier, the default is false. In Kibana 7.x, the setting is deprecated. In Kibana 8.0 and later, the default is true. Default: deprecated

server.socketTimeout

The number of milliseconds to wait before closing an inactive socket. Default: "120000"

server.ssl.certificate and server.ssl.key

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.

server.ssl.certificateAuthorities

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 server.ssl.keystore.path and/or server.ssl.truststore.path.

server.ssl.cipherSuites

Details on the format, and the valid options, are available via the OpenSSL cipher list format documentation. Default: TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_AES_128_GCM_SHA256 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.

server.ssl.clientAuthentication

Controls the behavior in Kibana for requesting a certificate from client connections. Valid values are "required", "optional", and "none". Using "required" will refuse to establish the connection unless a client presents a certificate, using "optional" will allow a client to present a certificate if it has one, and using "none" will prevent a client from presenting a certificate. Default: "none"

server.ssl.enabled

| Enables SSL/TLS for inbound connections to Kibana. When set to true, a certificate and its corresponding private key must be provided. These can be specified via server.ssl.keystore.path or the combination of server.ssl.certificate and server.ssl.key. Default: false

server.ssl.keyPassphrase

The password that decrypts the private key that is specified via server.ssl.key. This value is optional, as the key may not be encrypted.

server.ssl.keystore.path

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 server.ssl.certificateAuthorities and/or server.ssl.truststore.path.

This setting cannot be used in conjunction with server.ssl.certificate or server.ssl.key

server.ssl.keystore.password

The password that will be used to decrypt the keystore specified via server.ssl.keystore.path. If the keystore has no password, leave this unset. If the keystore has an empty password, set this to "".

server.ssl.truststore.path

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 server.ssl.certificateAuthorities and/or server.ssl.keystore.path.

server.ssl.truststore.password

The password that will be used to decrypt the trust store specified via server.ssl.truststore.path. If the trust store has no password, leave this unset. If the trust store has an empty password, set this to "".

server.ssl.redirectHttpFromPort

Kibana binds to this port and redirects all http requests to https over the port configured as server.port.

server.ssl.supportedProtocols

An array of supported protocols with versions. Valid protocols: TLSv1, TLSv1.1, TLSv1.2, TLSv1.3. Default: TLSv1.1, TLSv1.2, TLSv1.3

server.uuid

The unique identifier for this Kibana instance. It must be a valid UUIDv4. It gets automatically generated on the first startup if not specified and persisted in the data path.

server.xsrf.whitelist

It is not recommended to disable protections for arbitrary API endpoints. Instead, supply the kbn-xsrf header. The server.xsrf.whitelist setting requires the following format:

*Default: [ ]* An array of API endpoints which should be exempt from Cross-Site Request Forgery ("XSRF") protections.

server.xsrf.disableProtection

Setting this to true will completely disable Cross-site request forgery protection in Kibana. This is not recommended. Default: false

status.allowAnonymous

If authentication is enabled, setting this to true enables unauthenticated users to access the Kibana server status API and status page. Default: false

telemetry.allowChangingOptInStatus

When true, users are able to change the telemetry setting at a later time in Advanced Settings. When false, Kibana looks at the value of telemetry.optIn to determine whether to send telemetry data or not. telemetry.allowChangingOptInStatus and telemetry.optIn cannot be false at the same time. Default: true.

telemetry.optIn

When true, telemetry data is sent to Elastic. When false, collection of telemetry data is disabled. To enable telemetry and prevent users from disabling it, set telemetry.allowChangingOptInStatus to false and telemetry.optIn to true. Default: true

telemetry.enabled

Reporting your cluster statistics helps us improve your user experience. Set to false to disable telemetry capabilities entirely. You can alternatively opt out through Advanced Settings. Default: true

vis_type_vega.enableExternalUrls

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: false

xpack.license_management.enabled

Set this value to false to disable the License Management UI. Default: true

xpack.rollup.enabled

Set this value to false to disable the Rollup UI. Default: true

i18n.locale

Set this value to change the Kibana interface language. Valid locales are: en, zh-CN, ja-JP. Default: en

« Install Kibana on macOS with Homebrew Alerting and action settings in Kibana »