Loading

General settings in Kibana

Use these settings to configure general features available in Kibana.

General settings

console.ui.enabled

Supported on:

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.

Datatype: bool

Default: true

execution_context.enabled

Supported on:

Propagate request-specific metadata to Elasticsearch server by way of the x-opaque-id header. It is available in Elastic Cloud 8.1.0 and later versions.

Datatype: bool

newsfeed.enabled

Supported on:

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

Datatype: bool

Default: true

node.roles

Supported on:

Indicates which roles to configure the Kibana process with, which will effectively run Kibana in different modes. Valid options are background_tasks and ui, or * to select all roles.

Datatype: string

Default: *

notifications.connectors.default.email

Supported on:

Choose the default email connector for user notifications. As of 8.6.0, Kibana is shipping with a new notification mechanism that will send email notifications for various user actions, e.g. assigning a Case to a user. To enable notifications, an email connector must be preconfigured in the system via kibana.yml, and the notifications plugin must be configured to point to the ID of that connector.

Datatype: string

ops.interval

Supported on:

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

Datatype: int

Default: 5000

ops.cGroupOverrides.cpuPath

Supported on:

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

Datatype: string

ops.cGroupOverrides.cpuAcctPath

Supported on:

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

Datatype: string

path.data

Supported on:

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

Datatype: string

Default: data

permissionsPolicy.report_to

Supported on:

Add sources for the Permissions Policy report-to directive.

Datatype: string

pid.file

Supported on:

Specifies the path where Kibana creates the process ID file.

Datatype: string

status.allowAnonymous

Supported on:

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

Datatype: bool

Default: false

Content Security Policy (CSP) settings

csp.script_src

Supported on:

Add sources for the Content Security Policy script-src directive.

Datatype: string

csp.disableUnsafeEval

Supported on:

Set this to false to add the unsafe-eval source expression to the script-src directive.

When csp.disableUnsafeEval is set to true, Kibana will use a custom version of the Handlebars template library. Handlebars is used in various locations in the Kibana frontend where custom templates can be supplied by the user when for instance setting up a visualisation. If you experience any issues rendering Handlebars templates, please set this setting to false and open an issue in the Kibana GitHub repository.

Datatype: bool

Default: true

Deprecation details

Deprecated in 8.7.0. Use csp.script_src: ['unsafe-eval'] instead if you wish to enable unsafe-eval. This config option will have no effect in a future version.

csp.worker_src

Supported on:

Add sources for the Content Security Policy worker-src directive.

Datatype: string

csp.style_src

Supported on:

Add sources for the Content Security Policy style-src directive.

Datatype: string

csp.connect_src

Supported on:

Add sources for the Content Security Policy connect-src directive.

Datatype: string

csp.default_src

Supported on:

Add sources for the Content Security Policy default-src directive.

Datatype: string

csp.font_src

Supported on:

Add sources for the Content Security Policy font-src directive.

Datatype: string

csp.frame_src

Supported on:

Add sources for the Content Security Policy frame-src directive.

Datatype: string

csp.img_src

Supported on:

Add sources for the Content Security Policy img-src directive.

Datatype: string

csp.object_src

Supported on:

Add sources for the Content Security Policy object-src directive.

Datatype: string

csp.frame_ancestors

Supported on:

Add sources for the Content Security Policy frame-ancestors directive.

Datatype: string

Note

The frame-ancestors directive can also be configured by using server.securityResponseHeaders.disableEmbedding. In that case, that takes precedence and any values in csp.frame_ancestors are ignored.

csp.report_only.form_action

Supported on:

Add sources for the Content Security Policy form-action directive in reporting mode.

Datatype: string

csp.report_only.object_src

Supported on:

Add sources for the Content Security Policy object-src directive in reporting mode.

Datatype: string

Deprecation details

This setting is deprecated in favor of csp.object_src.

csp.report_uri

Supported on:

Add sources for the Content Security Policy report-uri directive.

Datatype: string

csp.report_to

Supported on:

Add sources for the Content Security Policy report-to directive.

Datatype: string

csp.strict

Supported on:

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.

Datatype: bool

Default: true

csp.warnLegacyBrowsers

Supported on:

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.

Datatype: bool

Default: true

Elasticsearch connection settings

elasticsearch.customHeaders

Supported on:

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

Datatype: string

Default: {}

elasticsearch.hosts

Supported on:

The URLs of the Elasticsearch instances to use for all your queries. All nodes listed here must be on the same cluster.

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

Datatype: string

Default: [ "http://localhost:9200" ]

elasticsearch.publicBaseUrl

Supported on:

The URL through which Elasticsearch is publicly accessible, if any. This will be shown to users in Kibana when they need connection details for your Elasticsearch cluster.

Datatype: string

elasticsearch.pingTimeout

Supported on:

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

Datatype: int

elasticsearch.requestHeadersWhitelist

Supported on:

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.

Datatype: string

Default: [ 'authorization', 'es-client-authentication' ]

elasticsearch.requestTimeout

Supported on:

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

Datatype: int

Default: 30000

elasticsearch.shardTimeout

Supported on:

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

Datatype: int

Default: 30000

elasticsearch.compression

Supported on:

Specifies whether Kibana should use compression for communications with Elasticsearch. It is available in Elastic Cloud 8.3.0 and later versions.

Datatype: bool

Default: false

elasticsearch.sniffInterval

Supported on:

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

Datatype: string

Default: false

elasticsearch.sniffOnStart

Supported on:

Attempt to find other Elasticsearch nodes on startup.

Datatype: bool

Default: false

elasticsearch.sniffOnConnectionFault

Supported on:

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

Datatype: bool

Default: false

elasticsearch.maxSockets

Supported on:

The maximum number of sockets that can be used for communications with Elasticsearch. It is available in Elastic Cloud 8.2.0 and later versions.

Datatype: int

Default: 800

elasticsearch.maxResponseSize

Supported on:

Either false or a byteSize value. When set, responses from Elasticsearch with a size higher than the defined limit will be rejected. This is intended to be used as a circuit-breaker mechanism to avoid memory errors in case of unexpectedly high responses coming from Elasticsearch.

Datatype: string

Default: false

elasticsearch.maxIdleSockets

Supported on:

The maximum number of idle sockets to keep open between Kibana and Elasticsearch. If more sockets become idle, they will be closed.

Datatype: int

Default: 256

elasticsearch.idleSocketTimeout

Supported on:

The timeout for idle sockets kept open between Kibana and Elasticsearch. If the socket is idle for longer than this timeout, it will be closed. If you have a transparent proxy between Kibana and Elasticsearch be sure to set this value lower than or equal to the proxy's timeout.

Datatype: string

Default: 60s

elasticsearch.username

Supported on:

If your Elasticsearch is protected with basic authentication, this setting provides the username 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.

Datatype: string

elasticsearch.password

Supported on:

If your Elasticsearch is protected with basic authentication, this setting provides the 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.

Datatype: string

elasticsearch.serviceAccountToken

Supported on:

If your Elasticsearch is protected with basic authentication, this token provides the credentials that the Kibana server uses to perform maintenance on the Kibana index at startup. This setting is an alternative to elasticsearch.username and elasticsearch.password.

Datatype: string

Elasticsearch SSL settings

elasticsearch.ssl.alwaysPresentCertificate

Supported on:

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.

Datatype: bool

Default: false

Warning

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

Supported on:

Path to a PEM-encoded X.509 client certificate. This is 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.

Datatype: string

Note

This setting cannot be used in conjunction with elasticsearch.ssl.keystore.path.

elasticsearch.ssl.key

Supported on:

Path to the corresponding private key for the PEM-encoded X.509 client certificate specified via elasticsearch.ssl.certificate. 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.

Datatype: string

Note

This setting cannot be used in conjunction with elasticsearch.ssl.keystore.path.

elasticsearch.ssl.certificateAuthorities

Supported on:

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.

Datatype: string

elasticsearch.ssl.keyPassphrase

Supported on:

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.

Datatype: string

elasticsearch.ssl.keystore.path

Supported on:

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.

Datatype: string

Note

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

elasticsearch.ssl.keystore.password

Supported on:

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

Datatype: string

elasticsearch.ssl.truststore.path

Supported on:

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.

Datatype: string

elasticsearch.ssl.truststore.password

Supported on:

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

Datatype: string

elasticsearch.ssl.verificationMode

Supported on:

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.

Datatype: enum

Default: full

Options:

  • full
  • certificate
  • none

Logging settings

logging.root

Supported on:

The root logger is a dedicated logger and is pre-configured. The root logger logs at info level by default. If any other logging configuration is specified, root must also be explicitly configured.

Datatype: string

logging.root.appenders

Supported on:

A list of logging appenders to forward the root level logger instance to. By default root is configured with the default appender that logs to stdout with a pattern layout. This is the configuration that all custom loggers will use unless they're re-configured explicitly. You can override the default behavior by configuring a different appender to apply to root.

Datatype: string

logging.root.level

Supported on:

Level at which a log record should be logged. Supported levels are: all, fatal, error, warn, info, debug, trace, off. Levels are ordered from all (highest) to off and a log record will be logged it its level is higher than or equal to the level of its logger, otherwise the log record is ignored. Use this value to change the overall log level.

Datatype: enum

Default: info

Options:

  • all
  • fatal
  • error
  • warn
  • info
  • debug
  • trace
  • off
Tip

Set to all to log all events, including system usage information and all requests. Set to off to silence all logs. You can also use the logging cli commands to set log level to verbose or silence all logs.

The following example shows a valid verbose logging.root configuration:

logging:
  appenders:
    console_appender:
      type: console
      layout:
        type: pattern
        highlight: true
  root:
    appenders: [console_appender]
    level: all
logging.loggers[]

Supported on:

Allows you to customize a specific logger instance.

Datatype: string

logging.appenders[]

Supported on:

Appenders define how and where log messages are displayed (eg. stdout or console) and stored (eg. file on the disk).

Datatype: string

Map settings

map.includeElasticMapsService

Supported on:

Set to false to disable connections to Elastic Maps Service. When includeElasticMapsService is turned off, only tile layer configured by map.tilemap.url is available in Maps.

Datatype: bool

Default: true

map.emsUrl

Supported on:

Specifies the URL of a self hosted Elastic Maps Server

Datatype: string

map.tilemap.options.attribution

Supported on:

The map attribution string. Provide attributions in markdown and use \| to delimit attributions, for example: "[attribution 1](https://www.attribution1)\|[attribution 2](https://www.attribution2)".

Datatype: string

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

map.tilemap.options.maxZoom

Supported on:

The maximum zoom level.

Datatype: int

Default: 10

map.tilemap.options.minZoom

Supported on:

The minimum zoom level.

Datatype: int

Default: 1

map.tilemap.options.subdomains

Supported on:

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

Datatype: string

map.tilemap.url

Supported on:

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"

Datatype: string

Migrations settings

migrations.batchSize

Supported on:

Defines the number of documents migrated at a time. The higher the value, the faster the Saved Objects migration process performs at the cost of higher memory consumption. If upgrade migrations results in Kibana crashing with an out of memory exception or fails due to an Elasticsearch circuit_breaking_exception, use a smaller batchSize value to reduce the memory pressure.

Datatype: int

Default: 1000

migrations.discardUnknownObjects

Supported on:

Discard saved objects with unknown types during a migration. Must be set to the target version, for example: 8.4.0. Default: undefined. It is available in Elastic Cloud 8.4.0 and later versions.

Datatype: string

migrations.discardCorruptObjects

Supported on:

Discard corrupt saved objects, as well as those that cause transform errors during a migration. Must be set to the target version, for example: 8.4.0. Default: undefined. It is available in Elastic Cloud 8.4.0 and later versions.

Datatype: string

migrations.maxBatchSizeBytes

Supported on:

Defines the maximum payload size for indexing batches of upgraded saved objects to avoid migrations failing due to a 413 Request Entity Too Large response from Elasticsearch. This value should be lower than or equal to your Elasticsearch cluster's http.max_content_length configuration option.

Datatype: string

Default: 100mb

migrations.retryAttempts

Supported on:

The number of times migrations retry temporary failures, such as a network timeout, 503 status code, or snapshot_in_progress_exception. When upgrade migrations frequently fail after exhausting all retry attempts with a message such as Unable to complete the [...] step after 15 attempts, terminating., increase the setting value.

Datatype: int

Default: 15

migrations.useCumulativeLogger

Supported on:

Skip logging migration progress unless there are any errors. Set to false when troubleshooting migration issues and not automatically shown.

Datatype: bool

Default: true

Saved Objects settings

savedObjects.maxImportExportSize

Supported on:

The maximum count of saved objects that can be imported or exported. This setting exists to prevent the Kibana server from running out of memory when handling large numbers of saved objects. It is recommended to only raise this setting if you are confident your server can hold this many objects in memory.

Datatype: int

Default: 10000

savedObjects.maxImportPayloadBytes

Supported on:

The maximum byte size of a saved objects import that the Kibana server will accept. This setting exists to prevent the Kibana server from running out of memory when handling a large import payload. Note that this setting overrides the more general server.maxPayload for saved object imports only.

Datatype: int

Default: 26214400

Search and autocomplete settings

data.autocomplete.valueSuggestions.terminateAfter

Supported on:

Specifies the max number of documents loaded by each shard to generate autocomplete suggestions. Allowed values are between 1 and 10000000.

Datatype: int

Default: 100000

data.autocomplete.valueSuggestions.timeout

Supported on:

Specifies the time in milliseconds to wait for autocomplete suggestions from Elasticsearch. Allowed values are between 1 and 1200000.

Datatype: int

Default: 1000

unifiedSearch.autocomplete.valueSuggestions.timeout

Supported on:

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

Datatype: int

Default: 1000

unifiedSearch.autocomplete.valueSuggestions.terminateAfter

Supported on:

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

Datatype: int

Default: 100000

Note

To reload the logging settings, send a SIGHUP signal to Kibana. For more logging configuration options, see the Configure Logging in Kibana guide.

Server settings

server.basePath

Supported on:

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 (/).

Datatype: string

server.publicBaseUrl

Supported on:

The publicly available URL that end-users access Kibana at. Must include the protocol, hostname, port (if different than the defaults for http and https, 80 and 443 respectively), and the server.basePath (when that setting is configured explicitly). This setting cannot end in a slash (/).

Datatype: string

server.host

Supported on:

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. Use 0.0.0.0 to make Kibana listen on all IPs (public and private).

Datatype: string

Default: "localhost"

server.keepaliveTimeout

Supported on:

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

Datatype: int

Default: 120000

server.maxPayload

Supported on:

The maximum payload size in bytes for incoming server requests.

Datatype: int

Default: 1048576

server.name

Supported on:

A human-readable display name that identifies this Kibana instance.

Datatype: string

Default: "your-hostname"

server.port

Supported on:

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

Datatype: int

Default: 5601

server.protocol

Supported on:

The HTTP protocol to use, either http1 or http2. Set to http1 to opt out of HTTP/2 support when TLS is enabled. Use of http1 may impact browser loading performance especially for dashboards with many panels. Default is http2 if TLS is enabled, otherwise http1.

Datatype: enum

Options:

  • http1
  • http2
Note

By default, enabling http2 requires a valid h2c configuration, meaning that TLS must be enabled via server.ssl.enabled and server.ssl.supportedprotocols, if specified, must contain at least TLSv1.2 or TLSv1.3. Strict validation of the h2c setup can be disabled by adding server.http2.allowUnsecure: true to the configuration.

server.shutdownTimeout

Supported on:

Sets the grace period for Kibana to attempt to resolve any ongoing HTTP requests after receiving a SIGTERM/SIGINT signal, and before shutting down. Any new HTTP requests received during this period are rejected, because the incoming socket is closed without further processing.

Datatype: string

Default: 30s

server.socketTimeout

Supported on:

The number of milliseconds to wait before closing an inactive socket.

Datatype: int

Default: 120000

server.payloadTimeout

Supported on:

Sets the maximum time allowed for the client to transmit the request payload (body) before giving up and responding with a Request Timeout (408) error response.

Datatype: int

Default: 20000

server.customResponseHeaders

Supported on:

Header names and values to send on all responses to the client from the Kibana server.

Datatype: string

Default: {}

server.requestId.allowFromAnyIp

Supported on:

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.

Datatype: bool

server.requestId.ipAllowlist

Supported on:

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.

Datatype: string

server.rewriteBasePath

Supported on:

Specifies whether Kibana should rewrite requests that are prefixed with server.basePath or require that they are rewritten by your reverse proxy.

Datatype: bool

Default: false

server.uuid

Supported on:

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.

Datatype: string

Server compression settings

server.compression.enabled

Supported on:

Set to false to disable HTTP compression for all responses.

Datatype: bool

Default: true

server.compression.referrerWhitelist

Supported on:

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.

Datatype: string

server.compression.brotli.enabled

Supported on:

Set to true to enable brotli (br) compression format. Browsers not supporting brotli compression will fallback to using gzip instead. This setting may not be used when server.compression.enabled is set to false. It is available in Elastic Cloud 8.6.0 and later versions.

Datatype: bool

Default: false

Server CORS settings

server.cors.enabled

Supported on:

Set to true to allow cross-origin API calls.

Datatype: bool

Default: false

server.cors.allowCredentials

Supported on:

Set to true to allow browser code to access response body whenever request performed with user credentials.

Datatype: bool

Default: false

server.cors.allowOrigin

Supported on:

List of origins permitted to access resources. You must specify explicit hostnames and not use server.cors.allowOrigin: ["*"] when server.cors.allowCredentials: true.

Datatype: string

Default: ["*"]

Server rate limiter settings

server.rateLimiter.enabled

Supported on:

Enables rate-limiting of requests to the Kibana server based on Node.js' Event Loop Utilization. If the average event loop utilization for the specified term exceeds the configured threshold, the server will respond with a 429 Too Many Requests status code.

This functionality should be used carefully as it may impact the server's availability. The configuration options vary per environment, so it is recommended to enable this option in a testing environment first, adjust the rate-limiter configuration, and then roll it out to production.

Datatype: bool

Default: false

server.rateLimiter.elu

Supported on:

The Event Loop Utilization (ELU) threshold for rate-limiting requests to the Kibana server. The ELU is a value between 0 and 1, representing the average event loop utilization over the specified term. If the average ELU exceeds this threshold, the server will respond with a 429 Too Many Requests status code.

In a multi-instance environment with autoscaling, this value is usually between 0.6 and 0.8 to give the autoscaler enough time to react. This value can be higher in a single-instance environment but should not exceed 1.0. In general, the lower the value, the more aggressive the rate limiting. And the highest possible option should be used to prevent the Kibana server from being terminated.

Datatype: float

server.rateLimiter.term

Supported on:

This value is one of short, medium, or long, representing the term over which the average event loop utilization is calculated. It uses exponential moving averages (EMA) to smooth out the utilization values. Each term corresponds to 15s, 30s, and 60s, respectively.

The term value also changes the way the rate limiter sees the trend in the load:

  • short: elu.short > server.rateLimiter.term;
  • medium: elu.short > server.rateLimiter.elu AND elu.medium > server.rateLimiter.elu;
  • long: elu.short > server.rateLimiter.elu AND elu.medium > server.rateLimiter.elu AND elu.long > server.rateLimiter.elu.

This behavior prevents requests from being throttled if the load starts decreasing. In general, the shorter the term, the more aggressive the rate limiting. In the multi-instance environment, the medium term makes the most sense as it gives the Kibana server enough time to spin up a new instance and prevents the existing instances from being terminated.

Datatype: enum

Options:

  • short
  • medium
  • long

Server security response headers

server.securityResponseHeaders.strictTransportSecurity

Supported on:

Controls whether the Strict-Transport-Security header is used in all responses to the client from the Kibana server, and specifies what value is used. Allowed values are any text value or null. To disable, set to null.

Datatype: string

Default: null

server.securityResponseHeaders.xContentTypeOptions

Supported on:

Controls whether the X-Content-Type-Options header is used in all responses to the client from the Kibana server, and specifies what value is used. Allowed values are nosniff or null. To disable, set to null.

Datatype: string

Default: "nosniff"

server.securityResponseHeaders.referrerPolicy

Supported on:

Controls whether the Referrer-Policy header is used in all responses to the client from the Kibana server, and specifies what value is used. Allowed values are no-referrer, no-referrer-when-downgrade, origin, origin-when-cross-origin, same-origin, strict-origin, strict-origin-when-cross-origin, unsafe-url, or null. To disable, set to null.

Datatype: string

Default: "strict-origin-when-cross-origin"

server.securityResponseHeaders.permissionsPolicy

Supported on:

Controls whether the Permissions-Policy header is used in all responses to the client from the Kibana server, and specifies what value is used. Allowed values are any text value or null. Refer to the Permissions-Policy documentation for defined directives, values, and text format. To disable, set to null.

Datatype: string

Default: camera=(), display-capture=(), fullscreen=(self), geolocation=(), microphone=(), web-share=()

server.securityResponseHeaders.permissionsPolicyReportOnly

Supported on:

Controls whether the Permissions-Policy-Report-Only header is used in all responses to the client from the Kibana server, and specifies what value is used. Allowed values are any text value or null. Refer to the Permissions-Policy documentation for defined directives, values, and text format.

Datatype: string

server.securityResponseHeaders.disableEmbedding

Supported on:

Controls whether the Content-Security-Policy and X-Frame-Options headers are configured to disable embedding Kibana in other webpages using iframes. When set to true, secure headers are used to disable embedding, which adds the frame-ancestors: 'self' directive to the Content-Security-Policy response header and adds the X-Frame-Options: SAMEORIGIN response header.

Datatype: bool

Default: false

server.securityResponseHeaders.crossOriginOpenerPolicy

Supported on:

Controls whether the Cross-Origin-Opener-Policy header is used in all responses to the client from the Kibana server, and specifies what value is used. Allowed values are unsafe-none, same-origin-allow-popups, same-origin, or null. To disable, set to null. It is available in Elastic Cloud 8.7.0 and later versions.

Datatype: enum

Default: "same-origin"

Options:

  • unsafe-none
  • same-origin-allow-popups
  • same-origin
  • null

Server SSL settings

server.ssl.certificate

Supported on:

Path to a PEM-encoded X.509 server certificate. This is used by Kibana to establish trust when receiving inbound SSL/TLS connections from users.

Datatype: string

Note

This setting cannot be used in conjunction with server.ssl.keystore.path.

server.ssl.key

Supported on:

Path to the corresponding private key for the PEM-encoded X.509 server certificate specified via server.ssl.certificate. This is used by Kibana to establish trust when receiving inbound SSL/TLS connections from users.

Datatype: string

Note

This setting cannot be used in conjunction with server.ssl.keystore.path.

server.ssl.certificateAuthorities

Supported on:

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.

Datatype: string

server.ssl.cipherSuites

Supported on:

Details on the format, and the valid options, are available via the OpenSSL cipher list format documentation.

Datatype: string

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

Supported on:

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.

Datatype: enum

Default: "none"

Options:

  • required
  • optional
  • none
server.ssl.enabled

Supported on:

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.

Datatype: bool

Default: false

server.ssl.keyPassphrase

Supported on:

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.

Datatype: string

server.ssl.keystore.path

Supported on:

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.

Datatype: string

Note

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

server.ssl.keystore.password

Supported on:

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

Datatype: string

server.ssl.truststore.path

Supported on:

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.

Datatype: string

server.ssl.truststore.password

Supported on:

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

Datatype: string

server.ssl.redirectHttpFromPort

Supported on:

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

Datatype: int

server.ssl.supportedProtocols

Supported on:

An array of supported protocols with versions. Valid protocols: TLSv1, TLSv1.1, TLSv1.2, TLSv1.3. Enabling TLSv1.1 would require both setting the --tls-min-1.1 option in the node.options configuration and adding TLSv1.1 to server.ssl.supportedProtocols. HTTP/2 requires the use of minimum TLSv1.2 for secure connections.

Datatype: string

Default: TLSv1.2, TLSv1.3

Server XSRF settings

server.xsrf.allowlist

Supported on:

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

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

It is available in Elastic Cloud 8.0.0 and later versions.

Datatype: string

Default: []

server.xsrf.disableProtection

Supported on:

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

Datatype: bool

Default: false

Telemetry settings

telemetry.allowChangingOptInStatus

Supported on:

When false, users cannot change the opt-in status through Advanced Settings, and Kibana only looks at the value of telemetry.optIn to determine whether to send telemetry data or not.

Datatype: bool

Default: true

telemetry.optIn

Supported on:

Set to false to stop sending any telemetry data to Elastic. Reporting your cluster statistics helps us improve your user experience. When false, the telemetry data is never sent to Elastic.

This setting can be changed at any time in Advanced Settings. To prevent users from changing it, set telemetry.allowChangingOptInStatus to false.

Datatype: bool

Default: true

UI and visualization settings

uiSettings.globalOverrides.hideAnnouncements

Supported on:

Set to true to stop showing messages and tours that highlight new features.

Datatype: bool

Default: false

uiSettings.globalOverrides.hideFeedback

Supported on:

Set to true to stop showing elements requesting user feedback.

Datatype: bool

Default: false

vis_type_table.legacyVisEnabled

Supported on:

Starting from version 7.11, a new datatable visualization is used. Set to true to enable the legacy version. In version 8.0 and later, the old implementation is removed and this setting is no longer supported.

Datatype: bool

vis_type_vega.enable

Supported on:

For 7.7 version and later, set to false to disable Vega vizualizations.

Datatype: bool

Default: true

vega.enableExternalUrls

Supported on:

Set to true to allow Vega vizualizations to use data from sources other than the linked Elasticsearch cluster. In version 8.0 and later, the vega.enableExternalUrls is not supported. Use vis_type_vega.enableExternalUrls instead.

Datatype: bool

Deprecation details

In version 8.0 and later, this setting is not supported. Use vis_type_vega.enableExternalUrls instead.

vis_type_vega.enableExternalUrls

Supported on:

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.

Datatype: bool

Default: false

Feature and plugin settings

xpack.ccr.ui.enabled

Supported on:

Set this value to false to disable the Cross-Cluster Replication UI.

Datatype: bool

Default: true

xpack.discoverEnhanced.actions.exploreDataInContextMenu.enabled

Supported on:

Enables the Explore underlying data option that allows you to open Discover from a dashboard panel and view the panel data.

When you create visualizations using the Lens drag-and-drop editor, you can use the toolbar to open and explore your data in Discover. For more information, check out Explore the data in Discover.

Datatype: bool

Default: false

xpack.discoverEnhanced.actions.exploreDataInChart.enabled

Supported on:

Enables you to view the underlying documents in a data series from a dashboard panel.

Datatype: bool

Default: false

xpack.ilm.ui.enabled

Supported on:

Set this value to false to disable the Index Lifecycle Policies UI.

Datatype: bool

Default: true

xpack.index_management.ui.enabled

Supported on:

Set this value to false to disable the Index Management UI.

Datatype: bool

Default: true

xpack.license_management.ui.enabled

Supported on:

Set this value to false to disable the License Management UI.

Datatype: bool

Default: true

xpack.remote_clusters.ui.enabled

Supported on:

Set this value to false to disable the Remote Clusters UI.

Datatype: bool

Default: true

xpack.rollup.ui.enabled

Supported on:

Set this value to false to disable the Rollup Jobs UI.

Datatype: bool

Default: true

Deprecation details

Rollups are deprecated and will be removed in a future version. Use downsampling instead.

xpack.securitySolution.maxUploadResponseActionFileBytes

Supported on:

Allow to configure the max file upload size for use with the Upload File Response action available with the Defend Integration. To learn more, check Endpoint Response actions. It is available in Elastic Cloud 8.9.0 and later versions.

Datatype: string

xpack.securitySolution.disableEndpointRuleAutoInstall

Supported on:

Set to true to disable the automatic installation of Elastic Defend SIEM rules when a new Endpoint integration policy is created. Introduced with v9.2.4.

Datatype: bool

Default: false

xpack.securitySolution.maxEndpointScriptFileSize

Supported on:

The maximum file size in bytes for scripts uploaded to the Elastic Defend script library. Default is 26214400 (25MB).

Datatype: bool

Default: 26214400

xpack.snapshot_restore.ui.enabled

Supported on:

Set this value to false to disable the Snapshot and Restore UI.

Datatype: bool

Default: true

xpack.upgrade_assistant.ui.enabled

Supported on:

Set this value to false to disable the Upgrade Assistant UI.

Datatype: bool

Default: true