Skip to content

Commit ad01a54

Browse files
[Monitoring] Update docs based on config change (#63860) (#64316)
* Update a bunch of docs * PR feedback Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
1 parent 30f6b60 commit ad01a54

File tree

11 files changed

+46
-39
lines changed

11 files changed

+46
-39
lines changed

docs/setup/docker.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ Some example translations are shown here:
9494
**Environment Variable**:: **Kibana Setting**
9595
`SERVER_NAME`:: `server.name`
9696
`KIBANA_DEFAULTAPPID`:: `kibana.defaultAppId`
97-
`XPACK_MONITORING_ENABLED`:: `xpack.monitoring.enabled`
97+
`MONITORING_ENABLED`:: `monitoring.enabled`
9898

9999
In general, any setting listed in <<settings>> can be
100100
configured with this technique.
@@ -125,9 +125,9 @@ images:
125125
`server.name`:: `kibana`
126126
`server.host`:: `"0"`
127127
`elasticsearch.hosts`:: `http://elasticsearch:9200`
128-
`xpack.monitoring.ui.container.elasticsearch.enabled`:: `true`
128+
`monitoring.ui.container.elasticsearch.enabled`:: `true`
129129

130-
NOTE: The setting `xpack.monitoring.ui.container.elasticsearch.enabled` is not
130+
NOTE: The setting `monitoring.ui.container.elasticsearch.enabled` is not
131131
defined in the `-oss` image.
132132

133133
These settings are defined in the default `kibana.yml`. They can be overridden

docs/user/monitoring/cluster-alerts.asciidoc

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,16 @@ To receive email notifications for the Cluster Alerts:
4848

4949
1. Configure an email account as described in
5050
{ref}/actions-email.html#configuring-email[Configuring email accounts].
51-
2. Configure the `xpack.monitoring.cluster_alerts.email_notifications.email_address` setting in `kibana.yml` with your email address.
51+
2. Configure the
52+
`monitoring.cluster_alerts.email_notifications.email_address` setting in
53+
`kibana.yml` with your email address.
54+
+
55+
--
56+
TIP: If you have separate production and monitoring clusters and separate {kib}
57+
instances for those clusters, you must put the
58+
`monitoring.cluster_alerts.email_notifications.email_address` setting in
59+
the {kib} instance that is associated with the production cluster.
60+
61+
--
5262

5363
Email notifications are sent only when Cluster Alerts are triggered and resolved.

docs/user/monitoring/elasticsearch-details.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,4 +164,4 @@ image::user/monitoring/images/monitoring-elasticsearch-logs.jpg["Recent {es} log
164164

165165
TIP: By default, up to 10 log entries are shown. You can show up to 50 log
166166
entries by changing the
167-
<<monitoring-ui-settings,`xpack.monitoring.elasticsearch.logFetchCount` setting>>.
167+
<<monitoring-ui-settings,`monitoring.ui.elasticsearch.logFetchCount` setting>>.

docs/user/monitoring/monitoring-kibana.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@ For more information, see {ref}/monitoring-settings.html[Monitoring settings in
6161
and {ref}/cluster-update-settings.html[Cluster update settings].
6262
--
6363

64-
. Verify that `xpack.monitoring.enabled` and
65-
`xpack.monitoring.kibana.collection.enabled` are set to `true` in the
64+
. Verify that `monitoring.enabled` and
65+
`monitoring.kibana.collection.enabled` are set to `true` in the
6666
`kibana.yml` file. These are the default values. For
6767
more information, see <<monitoring-settings-kb,Monitoring settings in {kib}>>.
6868

docs/user/monitoring/monitoring-metricbeat.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ Add the following setting in the {kib} configuration file (`kibana.yml`):
2525

2626
[source,yaml]
2727
----------------------------------
28-
xpack.monitoring.kibana.collection.enabled: false
28+
monitoring.kibana.collection.enabled: false
2929
----------------------------------
3030

31-
Leave the `xpack.monitoring.enabled` set to its default value (`true`).
31+
Leave the `monitoring.enabled` set to its default value (`true`).
3232
// end::disable-kibana-collection[]
3333
For more information, see
3434
<<monitoring-settings-kb,Monitoring settings in {kib}>>.

docs/user/monitoring/monitoring-troubleshooting.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ https://github.com/elastic/kibana/issues/34357
4040
. Confirm that {kib} is seeking monitoring data from the appropriate {es} URL.
4141
By default, data is retrieved from the cluster specified in the
4242
`elasticsearch.hosts` setting in the `kibana.yml` file. If you want to retrieve it
43-
from a different monitoring cluster, set `xpack.monitoring.elasticsearch.hosts`.
43+
from a different monitoring cluster, set `monitoring.ui.elasticsearch.hosts`.
4444
See <<monitoring-settings-kb>>.
4545

4646
. Confirm that there is monitoring data available at that URL. It is stored in

docs/user/monitoring/viewing-metrics.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@ cluster and view them all through the same instance of {kib}.
2626

2727
By default, data is retrieved from the cluster specified in the
2828
`elasticsearch.hosts` value in the `kibana.yml` file. If you want to retrieve it
29-
from a different cluster, set `xpack.monitoring.elasticsearch.hosts`.
29+
from a different cluster, set `monitoring.ui.elasticsearch.hosts`.
3030

3131
To learn more about typical monitoring architectures,
3232
see {ref}/how-monitoring-works.html[How monitoring works] and
3333
{ref}/monitoring-production.html[Monitoring in a production environment].
3434
--
3535

36-
. Verify that `xpack.monitoring.ui.enabled` is set to `true`, which is the
36+
. Verify that `monitoring.ui.enabled` is set to `true`, which is the
3737
default value, in the `kibana.yml` file. For more information, see
3838
<<monitoring-settings-kb>>.
3939

@@ -43,8 +43,8 @@ must provide a user ID and password so {kib} can retrieve the data.
4343
.. Create a user that has the `monitoring_user`
4444
{ref}/built-in-roles.html[built-in role] on the monitoring cluster.
4545

46-
.. Add the `xpack.monitoring.elasticsearch.username` and
47-
`xpack.monitoring.elasticsearch.password` settings in the `kibana.yml` file.
46+
.. Add the `monitoring.ui.elasticsearch.username` and
47+
`monitoring.ui.elasticsearch.password` settings in the `kibana.yml` file.
4848
If these settings are omitted, {kib} uses the `elasticsearch.username` and
4949
`elasticsearch.password` setting values. For more
5050
information, see {kibana-ref}/using-kibana-with-security.html[Configuring security in {kib}].

docs/user/security/securing-communications/index.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -188,5 +188,5 @@ verification. For more information about this setting, see <<settings,{kib} conf
188188
--
189189

190190
If the Elastic {monitor-features} are enabled and you have set up a separate {es} monitoring cluster, you can also configure {kib} to
191-
connect to the monitoring cluster via HTTPS. The steps are the same, but each setting is prefixed by `xpack.monitoring.`. For
192-
example, `xpack.monitoring.elasticsearch.hosts`, `xpack.monitoring.elasticsearch.ssl.truststore.path`, etc.
191+
connect to the monitoring cluster via HTTPS. The steps are the same, but each setting is prefixed by `monitoring.`. For
192+
example, `monitoring.ui.elasticsearch.hosts`, `monitoring.ui.elasticsearch.ssl.truststore.path`, etc.

src/dev/build/tasks/os_packages/docker_generator/resources/bin/kibana-docker

Lines changed: 16 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,22 @@ kibana_vars=(
7272
map.tilemap.options.minZoom
7373
map.tilemap.options.subdomains
7474
map.tilemap.url
75+
monitoring.cluster_alerts.email_notifications.email_address
76+
monitoring.enabled
77+
monitoring.kibana.collection.enabled
78+
monitoring.kibana.collection.interval
79+
monitoring.ui.container.elasticsearch.enabled
80+
monitoring.ui.container.logstash.enabled
81+
monitoring.ui.elasticsearch.password
82+
monitoring.ui.elasticsearch.pingTimeout
83+
monitoring.ui.elasticsearch.hosts
84+
monitoring.ui.elasticsearch.username
85+
monitoring.ui.elasticsearch.logFetchCount
86+
monitoring.ui.elasticsearch.ssl.certificateAuthorities
87+
monitoring.ui.elasticsearch.ssl.verificationMode
88+
monitoring.ui.enabled
89+
monitoring.ui.max_bucket_size
90+
monitoring.ui.min_interval_seconds
7591
newsfeed.enabled
7692
ops.interval
7793
path.data
@@ -160,25 +176,6 @@ kibana_vars=(
160176
xpack.infra.sources.default.metricAlias
161177
xpack.license_management.enabled
162178
xpack.ml.enabled
163-
xpack.monitoring.cluster_alerts.email_notifications.email_address
164-
xpack.monitoring.elasticsearch.password
165-
xpack.monitoring.elasticsearch.pingTimeout
166-
xpack.monitoring.elasticsearch.hosts
167-
xpack.monitoring.elasticsearch.username
168-
xpack.monitoring.elasticsearch.logFetchCount
169-
xpack.monitoring.elasticsearch.ssl.certificateAuthorities
170-
xpack.monitoring.elasticsearch.ssl.verificationMode
171-
xpack.monitoring.enabled
172-
xpack.monitoring.kibana.collection.enabled
173-
xpack.monitoring.kibana.collection.interval
174-
xpack.monitoring.max_bucket_size
175-
xpack.monitoring.min_interval_seconds
176-
xpack.monitoring.node_resolver
177-
xpack.monitoring.report_stats
178-
xpack.monitoring.elasticsearch.pingTimeout
179-
xpack.monitoring.ui.container.elasticsearch.enabled
180-
xpack.monitoring.ui.container.logstash.enabled
181-
xpack.monitoring.ui.enabled
182179
xpack.reporting.capture.browser.autoDownload
183180
xpack.reporting.capture.browser.chromium.disableSandbox
184181
xpack.reporting.capture.browser.chromium.inspect

src/dev/build/tasks/os_packages/docker_generator/templates/kibana_yml.template.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ function generator({ imageFlavor }) {
2424
#
2525
# ** THIS IS AN AUTO-GENERATED FILE **
2626
#
27-
27+
2828
# Default Kibana configuration for docker target
2929
server.name: kibana
3030
server.host: "0"
3131
elasticsearch.hosts: [ "http://elasticsearch:9200" ]
32-
${!imageFlavor ? 'xpack.monitoring.ui.container.elasticsearch.enabled: true' : ''}
32+
${!imageFlavor ? 'monitoring.ui.container.elasticsearch.enabled: true' : ''}
3333
`);
3434
}
3535

0 commit comments

Comments
 (0)