github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 17:59:23 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] Add monitoring.ui.logs.index (#75830)

Browse source
This commit is contained in:
Lisa Cawley 2020-08-27 10:39:44 -07:00 • committed by GitHub
parent ebfba81ba5
commit 165752b05f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

43
docs/settings/monitoring-settings.asciidoc
View file

@ -5,12 +5,12 @@
<titleabbrev>Monitoring settings</titleabbrev>
++++
By default, the Monitoring application is enabled, but data collection
is disabled. When you first start {kib} monitoring, you are prompted to
enable data collection. If you are using {stack-security-features}, you must be
signed in as a user with the `cluster:manage` privilege to enable
data collection. The built-in `superuser` role has this privilege and the
built-in `elastic` user has this role.
By default, *{stack-monitor-app}* is enabled, but data collection is disabled.
When you first start {kib} monitoring, you are prompted to enable data
collection. If you are using {stack-security-features}, you must be signed in as
a user with the `cluster:manage` privilege to enable data collection. The
built-in `superuser` role has this privilege and the built-in `elastic` user has
this role.
You can adjust how monitoring data is
collected from {kib} and displayed in {kib} by configuring settings in the
@ -49,7 +49,7 @@ For more information, see
in {kib} to the {es} monitoring cluster and to verify licensing status on the {es}
monitoring cluster. +
+
Every other request performed by the Stack Monitoring UI to the monitoring {es}
Every other request performed by *{stack-monitor-app}* to the monitoring {es}
cluster uses the authenticated user's credentials, which must be the same on
both the {es} monitoring cluster and the {es} production cluster. +
+
@ -60,7 +60,7 @@ For more information, see
in {kib} to the {es} monitoring cluster and to verify licensing status on the {es}
monitoring cluster. +
+
Every other request performed by the Stack Monitoring UI to the monitoring {es}
Every other request performed by *{stack-monitor-app}* to the monitoring {es}
cluster uses the authenticated user's credentials, which must be the same on
both the {es} monitoring cluster and the {es} production cluster. +
+
@ -83,7 +83,7 @@ These settings control how data is collected from {kib}.
|===
| `monitoring.kibana.collection.enabled`
| Set to `true` (default) to enable data collection from the {kib} NodeJS server
for {kib} Dashboards to be featured in the Monitoring.
for {kib} dashboards to be featured in *{stack-monitor-app}*.
| `monitoring.kibana.collection.interval`
| Specifies the number of milliseconds to wait in between data sampling on the
@ -96,16 +96,26 @@ These settings control how data is collected from {kib}.
[[monitoring-ui-settings]]
==== Monitoring UI settings
These settings adjust how the {kib} Monitoring page displays monitoring data.
These settings adjust how *{stack-monitor-app}* displays monitoring data.
However, the defaults work best in most circumstances. For more information
about configuring {kib}, see
{kibana-ref}/settings.html[Setting Kibana Server Properties].
{kibana-ref}/settings.html[Setting {kib} server properties].
[cols="2*<"]
|===
| `monitoring.ui.elasticsearch.logFetchCount`
| Specifies the number of log entries to display in the Monitoring UI. Defaults to
`10`. The maximum value is `50`.
| Specifies the number of log entries to display in *{stack-monitor-app}*.
Defaults to `10`. The maximum value is `50`.
| `monitoring.ui.enabled`
| Set to `false` to hide *{stack-monitor-app}*. The monitoring back-end
continues to run as an agent for sending {kib} stats to the monitoring
cluster. Defaults to `true`.
| `monitoring.ui.logs.index`
| Specifies the name of the indices that are shown on the
<<logs-monitor-page,*Logs*>> page in *{stack-monitor-app}*. The default value
is `filebeat-*`.
| `monitoring.ui.max_bucket_size`
| Specifies the number of term buckets to return out of the overall terms list when
@ -120,18 +130,13 @@ about configuring {kib}, see
`monitoring.ui.collection.interval` in `elasticsearch.yml`, use the same
value in this setting.
| `monitoring.ui.enabled`
| Set to `false` to hide the Monitoring UI in {kib}. The monitoring back-end
continues to run as an agent for sending {kib} stats to the monitoring
cluster. Defaults to `true`.
|===
[float]
[[monitoring-ui-cgroup-settings]]
===== Monitoring UI container settings
The Monitoring UI exposes the Cgroup statistics that we collect for you to make
*{stack-monitor-app}* exposes the Cgroup statistics that we collect for you to make
better decisions about your container performance, rather than guessing based on
the overall machine performance. If you are not running your applications in a
container, then Cgroup statistics are not useful.