[DOCS] Update links in X-Pack Reference for Reporting info (elastic/x-pack-elasticsearch#1584)
* [DOCS] Update links to Reporting docs * [DOCS] Fix incomplete link Original commit: elastic/x-pack-elasticsearch@c3ccafb191
This commit is contained in:
parent
fe0c5cd3dc
commit
1b3b7f2944
|
@ -7,14 +7,13 @@ response to user actions in Kibana.
|
|||
To use Reporting with {security} enabled, you need to <<kibana, set up Kibana
|
||||
to work with {security}>>. If you are automatically generating reports with
|
||||
<<xpack-alerting, {watcher}>>, you also need to configure {watcher} to trust the
|
||||
Kibana server's certificate. For more information, see <<securing-reporting,
|
||||
Securing Reporting>>.
|
||||
Kibana server's certificate. For more information, see {kibana-ref}/securing-reporting.html[Securing Reporting].
|
||||
|
||||
[[reporting-app-users]]
|
||||
To enable users to generate reports, assign them the built in `reporting_user`
|
||||
and `kibana_user` roles:
|
||||
|
||||
* If you're using the `native` realm, you can assign roles through
|
||||
* If you're using the `native` realm, you can assign roles through
|
||||
**Management / Users** UI in Kibana or with the `user` API. For example,
|
||||
the following request creates a `reporter` user that has the
|
||||
`reporting_user` and `kibana_user` roles:
|
||||
|
@ -23,8 +22,8 @@ the following request creates a `reporter` user that has the
|
|||
---------------------------------------------------------------
|
||||
POST /_xpack/security/user/reporter
|
||||
{
|
||||
"password" : "changeme",
|
||||
"roles" : ["kibana_user", "reporting_user"],
|
||||
"password" : "changeme",
|
||||
"roles" : ["kibana_user", "reporting_user"],
|
||||
"full_name" : "Reporting User"
|
||||
}
|
||||
---------------------------------------------------------------
|
||||
|
@ -41,4 +40,4 @@ kibana_user:
|
|||
- "cn=Bill Murray,dc=example,dc=com"
|
||||
reporting_user:
|
||||
- "cn=Bill Murray,dc=example,dc=com"
|
||||
--------------------------------------------------------------------------------
|
||||
--------------------------------------------------------------------------------
|
||||
|
|
|
@ -15,7 +15,7 @@ configuration files.
|
|||
//{kib-ref}/settings-xpack-kb.html[Yes]
|
||||
|Monitoring |<<monitoring-settings,Yes>> |<<monitoring-settings,Yes>> |<<monitoring-settings,Yes>>
|
||||
//{ref}/settings-xpack.html[Yes] {kib-ref}/settings-xpack-kb.html[Yes]
|
||||
|Reporting |No |<<reporting-settings,Yes>> |No
|
||||
|Reporting |No |Yes |No
|
||||
//{kib-ref}/settings-xpack-kb.html[Yes]
|
||||
|Security |<<security-settings,Yes>> |<<security-settings,Yes>> |No
|
||||
//{ref}/settings-xpack.html[Yes] {kib-ref}/settings-xpack-kb.html[Yes]
|
||||
|
@ -29,5 +29,5 @@ include::security-settings.asciidoc[]
|
|||
include::monitoring-settings.asciidoc[]
|
||||
include::graph-settings.asciidoc[]
|
||||
include::notification-settings.asciidoc[]
|
||||
include::reporting-settings.asciidoc[]
|
||||
//include::reporting-settings.asciidoc[]
|
||||
//include::ml-settings.asciidoc[]
|
||||
|
|
|
@ -1,98 +0,0 @@
|
|||
[[reporting-settings]]
|
||||
== Reporting Settings
|
||||
|
||||
You configure `xpack.reporting` settings in `kibana.yml` to
|
||||
control how {reporting} <<reporting-kibana-server-settings, communicates
|
||||
with the Kibana server>>, <<reporting-job-queue-settings, manages background
|
||||
jobs>>, and <<reporting-capture-settings, captures screenshots>>.
|
||||
|
||||
[float]
|
||||
[[general-reporting-settings]]
|
||||
=== General Reporting Settings
|
||||
`xpack.reporting.enabled`::
|
||||
Set to `false` to disable {reporting}.
|
||||
|
||||
`xpack.reporting.encryptionKey`::
|
||||
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.
|
||||
|
||||
[float]
|
||||
[[reporting-kibana-server-settings]]
|
||||
=== Kibana Server Settings
|
||||
|
||||
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.
|
||||
|
||||
`xpack.reporting.kibanaApp`::
|
||||
The root path used to access Kibana, defaults to `/app/kibana`.
|
||||
|
||||
`xpack.reporting.kibanaServer.port`::
|
||||
The port used to access Kibana, if different than the `server.port` value.
|
||||
|
||||
`xpack.reporting.kibanaServer.protocol`::
|
||||
The protocol used to access Kibana, typically `http` or `https`.
|
||||
|
||||
`xpack.reporting.kibanaServer.hostname`::
|
||||
The hostname used to access Kibana, if different than the `server.name` value.
|
||||
|
||||
[float]
|
||||
[[reporting-job-queue-settings]]
|
||||
=== Background Job Settings
|
||||
|
||||
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.
|
||||
|
||||
`xpack.reporting.queue.indexInterval`::
|
||||
How often the index that stores reporting jobs rolls over to a new index.
|
||||
Valid values are `year`, `month`, `week`, `day`, and `hour`. Defaults to `week`.
|
||||
|
||||
`xpack.reporting.queue.pollInterval`::
|
||||
How often idle workers poll the index for pending jobs. Defaults to `3000` (3 seconds).
|
||||
|
||||
`xpack.reporting.queue.timeout`::
|
||||
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.
|
||||
Defaults to `30000` (30 seconds).
|
||||
|
||||
[float]
|
||||
[[reporting-capture-settings]]
|
||||
=== Capture Settings
|
||||
|
||||
Reporting works by capturing screenshots from Kibana. These settings are used to
|
||||
control various aspects of the capturing process.
|
||||
|
||||
`xpack.reporting.capture.concurrency`::
|
||||
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.
|
||||
|
||||
`xpack.reporting.capture.loadDelay`::
|
||||
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.
|
||||
Defaults to `3000` (3 seconds).
|
||||
|
||||
`xpack.reporting.capture.settleTime`::
|
||||
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
|
||||
this value.
|
||||
Defaults to `1000` (1 second).
|
||||
|
||||
`xpack.reporting.capture.timeout`::
|
||||
The maximum amount of time to wait for things to render in Kibana when capturing
|
||||
screenshots. Defaults to `6000` (6 seconds).
|
||||
|
||||
[float]
|
||||
[[reporting-advanced-settings]]
|
||||
=== Advanced Settings
|
||||
|
||||
`xpack.reporting.index`::
|
||||
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.
|
||||
Defaults to `.reporting`
|
|
@ -158,8 +158,8 @@ include::{xkb-repo-dir}/reporting/watch-example.asciidoc[]
|
|||
|
||||
include::{xkb-repo-dir}/reporting/report-intervals.asciidoc[]
|
||||
|
||||
For more information, see <<automating-report-generation,
|
||||
Automating Report Generation>>.
|
||||
For more information, see
|
||||
{kibana-ref}/automating-report-generation.html[Automating Report Generation].
|
||||
|
||||
[[email-action-attributes]]
|
||||
==== Email Action Attributes
|
||||
|
|
Loading…
Reference in New Issue