WARNING: Version 6.2 of Kibana has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
You can configure
xpack.reporting settings in your
General Reporting Settingsedit
falseto disable X-Pack reporting.
- Set to any text string. By default, Kibana generates a random key when it starts, which causes pending reports to fail on restart. Configure this setting to use the same key across restarts.
Kibana Server Settingsedit
Reporting uses the Kibana interface to generate reports. In most cases, you don’t need to configure Reporting to communicate with Kibana. However, if you use a reverse-proxy to access Kibana, you must set the proxy port, protocol, and hostname.
The root path used to access Kibana, defaults to
The port for accessing Kibana, if different from the
The protocol for accessing Kibana, typically
The hostname for accessing Kibana, if different from the
Background Job Settingsedit
Reporting generates reports in the background and jobs are coordinated using documents in Elasticsearch. Depending on how often you generate reports and the overall number of reports, you might need to change the following settings.
How often the index that stores reporting jobs rolls over to a new index.
Valid values are
hour. Defaults to
How often idle workers poll the index for pending jobs. Defaults to
How long each worker has to produce a report. If your machine is slow or under
heavy load, you might need to increase this timeout. Specified in milliseconds.
Reporting works by capturing screenshots from Kibana. The following settings control the capturing process.
When visualizations are not evented, this is the amount of time before
taking a screenshot. All visualizations that ship with Kibana are evented, so this
setting should not have much effect. If you are seeing empty images instead of
visualizations, try increasing this value.
Specifies the browser to use to capture screenshots. Valid options are
chromiumis set, the settings specified in the Chromium settings are respected. Defaults to
xpack.reporting.capture.browser.type is set to
chromium you can also specify the following settings.
- Chromium uses sandboxing techniques that are built on top of operating system provided security mechanisms. The Linux sandbox depends on user namespaces, which were introduced with the 3.8 Linux kernel. However, many distrobutions don’t have user namespaces enabled by default, or they require the CAP_SYS_ADMIN capability.
Elastic recommends that you research the feasibility of enabling unprivileged user namespaces before disabling the sandbox. An exception
is if you are running Kibana in Docker because the container runs in a user namespace with seccomp-bpf filters and AppArmor profiles.
Enables the proxy for Chromium to use. When set to
true, you must also specify the
xpack.reporting.capture.browser.chromium.proxy.serversetting. Defaults to
- The uri for the proxy server. Providing the username and password for the proxy server via the uri is not supported.
- An array of hosts that should not go through the proxy server and should use a direct connection instead. Examples of valid entries are "elastic.co", "*.elastic.co", ".elastic.co", ".elastic.co:5601"
The maximum size of a CSV file before being truncated. This setting exists to prevent
large exports from causing performance and storage issues.
Reporting uses a weekly index in Elasticsearch to store the reporting job and the report
content. The index is automatically created if it does not already exist.
Specifies the roles in addition to superusers that are allowed to access reporting.
[ "reporting_user" ]