NOTE: You are looking at documentation for an older release. 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 will generate a random key when it starts, which will cause pending reports to fail after restart. Configure this setting to preserve the same key across multiple restarts and multiple instances of Kibana.
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 port for accessing Kibana, if different from the
The protocol for accessing Kibana, typically
The hostname for accessing Kibana, if different from the
xpack.reporting.kibanaServer settings to point to a
proxy host requires that the Kibana server has network access to the proxy.
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
true(default) to enable the Kibana instance to to poll the index for pending jobs and claim them for execution. Setting this to
falseallows the Kibana instance to only add new jobs to the reporting queue, list jobs, and provide the downloads to completed report through the UI.
Running multiple instances of Kibana in a cluster for load balancing of
reporting requires identical values for
xpack.reporting.encryptionKey and, if
security is enabled,
Specifies the number of milliseconds that idle workers wait between polling 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
Starting in 7.0, Phantom support will be removed from Kibana, and
will be the only valid option for the
xpack.reporting.capture.browser.type is set to
chromium (default) you can also specify the following settings.
- Elastic recommends that you research the feasibility of enabling unprivileged user namespaces. See Chromium Sandbox for additional information. Defaults to false for all operating systems except Debian, Red Hat Linux, and CentOS which use true
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. Configure this to a unique value, beginning with
.reporting-, for every Kibana instance that has a unique
kibana.indexsetting. Defaults to
Specifies the roles in addition to superusers that can use reporting. Defaults to
[ "reporting_user" ]
Each user has access to only their own reports.