Skip to content

Commit 165752b

Browse files
authored
[DOCS] Add monitoring.ui.logs.index (#75830)
1 parent ebfba81 commit 165752b

File tree

1 file changed

+24
-19
lines changed

1 file changed

+24
-19
lines changed

docs/settings/monitoring-settings.asciidoc

Lines changed: 24 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
<titleabbrev>Monitoring settings</titleabbrev>
66
++++
77

8-
By default, the Monitoring application is enabled, but data collection
9-
is disabled. When you first start {kib} monitoring, you are prompted to
10-
enable data collection. If you are using {stack-security-features}, you must be
11-
signed in as a user with the `cluster:manage` privilege to enable
12-
data collection. The built-in `superuser` role has this privilege and the
13-
built-in `elastic` user has this role.
8+
By default, *{stack-monitor-app}* is enabled, but data collection is disabled.
9+
When you first start {kib} monitoring, you are prompted to enable data
10+
collection. If you are using {stack-security-features}, you must be signed in as
11+
a user with the `cluster:manage` privilege to enable data collection. The
12+
built-in `superuser` role has this privilege and the built-in `elastic` user has
13+
this role.
1414

1515
You can adjust how monitoring data is
1616
collected from {kib} and displayed in {kib} by configuring settings in the
@@ -49,7 +49,7 @@ For more information, see
4949
in {kib} to the {es} monitoring cluster and to verify licensing status on the {es}
5050
monitoring cluster. +
5151
+
52-
Every other request performed by the Stack Monitoring UI to the monitoring {es}
52+
Every other request performed by *{stack-monitor-app}* to the monitoring {es}
5353
cluster uses the authenticated user's credentials, which must be the same on
5454
both the {es} monitoring cluster and the {es} production cluster. +
5555
+
@@ -60,7 +60,7 @@ For more information, see
6060
in {kib} to the {es} monitoring cluster and to verify licensing status on the {es}
6161
monitoring cluster. +
6262
+
63-
Every other request performed by the Stack Monitoring UI to the monitoring {es}
63+
Every other request performed by *{stack-monitor-app}* to the monitoring {es}
6464
cluster uses the authenticated user's credentials, which must be the same on
6565
both the {es} monitoring cluster and the {es} production cluster. +
6666
+
@@ -83,7 +83,7 @@ These settings control how data is collected from {kib}.
8383
|===
8484
| `monitoring.kibana.collection.enabled`
8585
| Set to `true` (default) to enable data collection from the {kib} NodeJS server
86-
for {kib} Dashboards to be featured in the Monitoring.
86+
for {kib} dashboards to be featured in *{stack-monitor-app}*.
8787

8888
| `monitoring.kibana.collection.interval`
8989
| 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}.
9696
[[monitoring-ui-settings]]
9797
==== Monitoring UI settings
9898

99-
These settings adjust how the {kib} Monitoring page displays monitoring data.
99+
These settings adjust how *{stack-monitor-app}* displays monitoring data.
100100
However, the defaults work best in most circumstances. For more information
101101
about configuring {kib}, see
102-
{kibana-ref}/settings.html[Setting Kibana Server Properties].
102+
{kibana-ref}/settings.html[Setting {kib} server properties].
103103

104104
[cols="2*<"]
105105
|===
106106
| `monitoring.ui.elasticsearch.logFetchCount`
107-
| Specifies the number of log entries to display in the Monitoring UI. Defaults to
108-
`10`. The maximum value is `50`.
107+
| Specifies the number of log entries to display in *{stack-monitor-app}*.
108+
Defaults to `10`. The maximum value is `50`.
109+
110+
| `monitoring.ui.enabled`
111+
| Set to `false` to hide *{stack-monitor-app}*. The monitoring back-end
112+
continues to run as an agent for sending {kib} stats to the monitoring
113+
cluster. Defaults to `true`.
114+
115+
| `monitoring.ui.logs.index`
116+
| Specifies the name of the indices that are shown on the
117+
<<logs-monitor-page,*Logs*>> page in *{stack-monitor-app}*. The default value
118+
is `filebeat-*`.
109119

110120
| `monitoring.ui.max_bucket_size`
111121
| Specifies the number of term buckets to return out of the overall terms list when
@@ -120,18 +130,13 @@ about configuring {kib}, see
120130
`monitoring.ui.collection.interval` in `elasticsearch.yml`, use the same
121131
value in this setting.
122132

123-
| `monitoring.ui.enabled`
124-
| Set to `false` to hide the Monitoring UI in {kib}. The monitoring back-end
125-
continues to run as an agent for sending {kib} stats to the monitoring
126-
cluster. Defaults to `true`.
127-
128133
|===
129134

130135
[float]
131136
[[monitoring-ui-cgroup-settings]]
132137
===== Monitoring UI container settings
133138

134-
The Monitoring UI exposes the Cgroup statistics that we collect for you to make
139+
*{stack-monitor-app}* exposes the Cgroup statistics that we collect for you to make
135140
better decisions about your container performance, rather than guessing based on
136141
the overall machine performance. If you are not running your applications in a
137142
container, then Cgroup statistics are not useful.

0 commit comments

Comments
 (0)