Configuring 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.

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:

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

cpuacct.cgroup.path.override:

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

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.preserveHost:

When the value is true, Kibana uses the hostname specified in the server.host setting. When the value is false, Kibana uses the hostname of the host that connects to this Kibana instance. Default: true

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 whether to always present the certificate specified by elasticsearch.ssl.certificate when requested. This applies to all requests to Elasticsearch, including requests that are proxied for users. Setting to true when Elasticsearch is using certificates to authentication users can lead to proxied requests for users being executed as the identity tied to the configured certificate. Default: false

elasticsearch.ssl.certificate: and elasticsearch.ssl.key:

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 xpack.ssl.verification_mode in Elasticsearch is set to certificate or full.

elasticsearch.ssl.certificateAuthorities:

Optional setting that enables you to specify a list of paths to the PEM file for the certificate authority for your Elasticsearch instance.

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.verificationMode:

Controls the verification of certificates presented by 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.startupTimeout:

Time in milliseconds to wait for Elasticsearch at Kibana startup before retrying. Default: 5000

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.

interpreter.enableInVisualize

Enables use of interpreter in Visualize. Default: true

kibana.defaultAppId:

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" + When running multiple tenants of Kibana by changing the kibana.index in your kibana.yml, you cannot use the kibana_user or kibana_dashboard_only_user roles to grant access to Kibana. You must create roles that authorize the user for the specific tenant. Although multi-tenant installations are supported, the recommended approach to securing access to Kibana segments is to grant users access to specific spaces.

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"

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.silent:

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

logging.timezone

Set to the canonical timezone ID (for example, America/Los_Angeles) to log events using that timezone. For a list of timezones, refer to https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. Default: UTC

logging.verbose:

Set to true to log all events, including system usage information and all requests. Supported on Elastic Cloud Enterprise. 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, Coordinate maps, and Region maps. Default: true

map.proxyElasticMapsServiceInMaps:

Set to true to proxy all Maps application Elastic Maps Service requests through the Kibana server. This setting does not impact Coordinate maps and Region maps. Default: false

map.regionmap:

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"

map.includeElasticMapsService:

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 true. This also affects whether tile-service from the Elastic Maps Service will be available.

map.regionmap.layers[].attribution:

Optional. References the originating source of the geojson file. Supported on Elastic Cloud Enterprise.

map.regionmap.layers[].fields[]:

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"

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

Mandatory. The human readable text that is shown under the Options tab when building the Region Map visualization. Supported on Elastic Cloud Enterprise.

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. Supported on Elastic Cloud Enterprise.

map.regionmap.layers[].name:

Mandatory. A description of the map being provided. Supported on Elastic Cloud Enterprise.

map.regionmap.layers[].url:

Mandatory. The location of the geojson file as provided by a webserver. Supported on Elastic Cloud Enterprise.

map.tilemap.options.attribution:

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

map.tilemap.options.maxZoom:

The maximum zoom level. Supported on Elastic Cloud Enterprise. Default: 10

map.tilemap.options.minZoom:

The minimum zoom level. Supported on Elastic Cloud Enterprise. 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}. Supported on Elastic Cloud Enterprise.

map.tilemap.url:

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: "https://tiles.elastic.co/v2/default/{z}/{x}/{y}.png?elastic_tile_service_tos=agree&my_app_name=kibana"

ops.interval:

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

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.

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.maxPayloadBytes:

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.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 the PEM-format SSL certificate and SSL key files.

server.ssl.certificateAuthorities:

Paths to one or more PEM-encoded certificate files that should be trusted.

server.ssl.cipherSuites:

Details on the format, and the valid options, are available via the OpenSSL cipher list format documentation. Default: 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 server’s behavior in regard to requesting a certificate from client connections. Valid values are required, optional, and none. Using required forces a client to present certificate, while optional requests a client certificate, but the client is not required to present one. 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 passphras that decrypts the private key. This value is optional, as the key may not be encrypted.

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. Default: TLSv1.1, TLSv1.2

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.

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. Your data is never shared with anyone. Set to false to disable telemetry capabilities entirely. You can alternatively opt out through Advanced Settings. Default: true

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