kibana/docs/reporting/getting-started.asciidoc
2019-03-28 13:16:28 -04:00

53 lines
1.9 KiB
Plaintext

[role="xpack"]
[[reporting-getting-started]]
== Getting Started
[float]
=== System Setup
{reporting} is automatically enabled in {kib}. The first time Kibana runs, it extracts a custom build for the Chromium web browser, which
runs on the server in headless mode to load Kibana and capture the rendered Kibana charts as images.
Chromium is an open-source project not related to Elastic, but the Chromium binary for Kibana has been custom-built by Elastic to ensure it
works with minimal setup. However, the Kibana server OS might still require additional dependencies for Chromium. See the
<<reporting-troubleshooting-system-dependencies, Reporting Troubleshooting>> section for more information about the system dependencies
for different operating systems.
[float]
=== Generating a Report Manually
. Open {kib} in your web browser and log in. If you are running {kib}
locally, go to `http://localhost:5601`. To access {kib} and generate
reports, you need the `kibana_user` and `reporting_user` roles. For more
information, see <<secure-reporting>>.
. Open the dashboard, visualization, or saved search you want to include
in the report.
. Click *Share* in the {kib} toolbar:
+
--
[role="screenshot"]
image:reporting/images/share-button.png["Reporting Button",link="share-button.png"]
--
. Depending on the {kib} application, choose the appropriate options:
.. If you're on Discover:
... Select *CSV Reports*
... Click the *Generate CSV* button.
.. If you're on Visualize or Dashboard:
... Select *PDF Reports*
... Dashboard only: Choose to enable *Optimize for printing* layout mode. For an explanation of the different layout modes, see <<pdf-layout-modes, PDF Layout Modes>>.
... Click the *Generate PDF* button.
[float]
=== Generating a Report Automatically
If you want to automatically generate reports from a script or with
{watcher}, see <<automating-report-generation, Automating Report Generation>>