General Reporting Settingsedit
- Set to
falseto disable X-Pack reporting.
- Set to any text string. By default, Kibana generates a random key when it starts, which causes any 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, it just works out of the box. However, if you use a proxy in your stack or otherwise change how you access Kibana, you might need to configure the following settings.
- The root path used to access Kibana, defaults to
- The port used to access Kibana, if different than the
- The protocol used to access Kibana, typically
- The hostname used to access Kibana, if different than 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 may need to change some of 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 constant
heavy load, you might need to increase this timeout. Specified in milliseconds.
Reporting works by capturing screenshots from Kibana. These settings are used to control various aspects of the capturing process.
- The number of concurrent capture processes to run. Note that jobs are CPU bound, and exceeding the number of cores available on the machine will likely be very slow and might cause issues. Defaults to the number of cores on the machine.
- When visualizations are not evented, this is the amount of time to before
taking a screenshot. All visualizations that ship with Kibana are evented, so this
setting shouldn’t have much effect. If you are seeing empty images instead of
visualizations in your reports, try increasing this value.
- When visualizations are evented, this is the amount of time to wait for their rendering
to settle. If visualizations in your PDF are smaller than they should be, try increasing
- The maximum amount of time to wait for things to render in Kibana when capturing
screenshots. Defaults to
- The maximum size that a CSV may reach before being truncated. This exists to prevent
unintentionally 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 will be created automatically if it does not already exist.
- Specifies the roles in addition to superusers that are allowed to access reporting.
[ "reporting_user" ]