[Monitoring] Update docs based on config change (#63860)
* Update a bunch of docs * PR feedback Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
This commit is contained in:
parent
51479fda9b
commit
23fbf7d67d
|
@ -94,7 +94,7 @@ Some example translations are shown here:
|
||||||
**Environment Variable**:: **Kibana Setting**
|
**Environment Variable**:: **Kibana Setting**
|
||||||
`SERVER_NAME`:: `server.name`
|
`SERVER_NAME`:: `server.name`
|
||||||
`KIBANA_DEFAULTAPPID`:: `kibana.defaultAppId`
|
`KIBANA_DEFAULTAPPID`:: `kibana.defaultAppId`
|
||||||
`XPACK_MONITORING_ENABLED`:: `xpack.monitoring.enabled`
|
`MONITORING_ENABLED`:: `monitoring.enabled`
|
||||||
|
|
||||||
In general, any setting listed in <<settings>> can be
|
In general, any setting listed in <<settings>> can be
|
||||||
configured with this technique.
|
configured with this technique.
|
||||||
|
@ -125,9 +125,9 @@ images:
|
||||||
`server.name`:: `kibana`
|
`server.name`:: `kibana`
|
||||||
`server.host`:: `"0"`
|
`server.host`:: `"0"`
|
||||||
`elasticsearch.hosts`:: `http://elasticsearch:9200`
|
`elasticsearch.hosts`:: `http://elasticsearch:9200`
|
||||||
`xpack.monitoring.ui.container.elasticsearch.enabled`:: `true`
|
`monitoring.ui.container.elasticsearch.enabled`:: `true`
|
||||||
|
|
||||||
NOTE: The setting `xpack.monitoring.ui.container.elasticsearch.enabled` is not
|
NOTE: The setting `monitoring.ui.container.elasticsearch.enabled` is not
|
||||||
defined in the `-oss` image.
|
defined in the `-oss` image.
|
||||||
|
|
||||||
These settings are defined in the default `kibana.yml`. They can be overridden
|
These settings are defined in the default `kibana.yml`. They can be overridden
|
||||||
|
|
|
@ -49,13 +49,13 @@ To receive email notifications for the Cluster Alerts:
|
||||||
. Configure an email account as described in
|
. Configure an email account as described in
|
||||||
{ref}/actions-email.html#configuring-email[Configuring email accounts].
|
{ref}/actions-email.html#configuring-email[Configuring email accounts].
|
||||||
. Configure the
|
. Configure the
|
||||||
`xpack.monitoring.cluster_alerts.email_notifications.email_address` setting in
|
`monitoring.cluster_alerts.email_notifications.email_address` setting in
|
||||||
`kibana.yml` with your email address.
|
`kibana.yml` with your email address.
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
TIP: If you have separate production and monitoring clusters and separate {kib}
|
TIP: If you have separate production and monitoring clusters and separate {kib}
|
||||||
instances for those clusters, you must put the
|
instances for those clusters, you must put the
|
||||||
`xpack.monitoring.cluster_alerts.email_notifications.email_address` setting in
|
`monitoring.cluster_alerts.email_notifications.email_address` setting in
|
||||||
the {kib} instance that is associated with the production cluster.
|
the {kib} instance that is associated with the production cluster.
|
||||||
|
|
||||||
--
|
--
|
||||||
|
|
|
@ -164,4 +164,4 @@ image::user/monitoring/images/monitoring-elasticsearch-logs.jpg["Recent {es} log
|
||||||
|
|
||||||
TIP: By default, up to 10 log entries are shown. You can show up to 50 log
|
TIP: By default, up to 10 log entries are shown. You can show up to 50 log
|
||||||
entries by changing the
|
entries by changing the
|
||||||
<<monitoring-ui-settings,`xpack.monitoring.elasticsearch.logFetchCount` setting>>.
|
<<monitoring-ui-settings,`monitoring.ui.elasticsearch.logFetchCount` setting>>.
|
||||||
|
|
|
@ -61,8 +61,8 @@ For more information, see {ref}/monitoring-settings.html[Monitoring settings in
|
||||||
and {ref}/cluster-update-settings.html[Cluster update settings].
|
and {ref}/cluster-update-settings.html[Cluster update settings].
|
||||||
--
|
--
|
||||||
|
|
||||||
. Verify that `xpack.monitoring.enabled` and
|
. Verify that `monitoring.enabled` and
|
||||||
`xpack.monitoring.kibana.collection.enabled` are set to `true` in the
|
`monitoring.kibana.collection.enabled` are set to `true` in the
|
||||||
`kibana.yml` file. These are the default values. For
|
`kibana.yml` file. These are the default values. For
|
||||||
more information, see <<monitoring-settings-kb,Monitoring settings in {kib}>>.
|
more information, see <<monitoring-settings-kb,Monitoring settings in {kib}>>.
|
||||||
|
|
||||||
|
|
|
@ -25,10 +25,10 @@ Add the following setting in the {kib} configuration file (`kibana.yml`):
|
||||||
|
|
||||||
[source,yaml]
|
[source,yaml]
|
||||||
----------------------------------
|
----------------------------------
|
||||||
xpack.monitoring.kibana.collection.enabled: false
|
monitoring.kibana.collection.enabled: false
|
||||||
----------------------------------
|
----------------------------------
|
||||||
|
|
||||||
Leave the `xpack.monitoring.enabled` set to its default value (`true`).
|
Leave the `monitoring.enabled` set to its default value (`true`).
|
||||||
// end::disable-kibana-collection[]
|
// end::disable-kibana-collection[]
|
||||||
For more information, see
|
For more information, see
|
||||||
<<monitoring-settings-kb,Monitoring settings in {kib}>>.
|
<<monitoring-settings-kb,Monitoring settings in {kib}>>.
|
||||||
|
|
|
@ -52,7 +52,7 @@ The *Stack Monitoring* page in {kib} is empty.
|
||||||
. Confirm that {kib} is seeking monitoring data from the appropriate {es} URL.
|
. Confirm that {kib} is seeking monitoring data from the appropriate {es} URL.
|
||||||
By default, data is retrieved from the cluster specified in the
|
By default, data is retrieved from the cluster specified in the
|
||||||
`elasticsearch.hosts` setting in the `kibana.yml` file. If you want to retrieve it
|
`elasticsearch.hosts` setting in the `kibana.yml` file. If you want to retrieve it
|
||||||
from a different monitoring cluster, set `xpack.monitoring.elasticsearch.hosts`.
|
from a different monitoring cluster, set `monitoring.ui.elasticsearch.hosts`.
|
||||||
See <<monitoring-settings-kb>>.
|
See <<monitoring-settings-kb>>.
|
||||||
|
|
||||||
. Confirm that there is monitoring data available at that URL. It is stored in
|
. Confirm that there is monitoring data available at that URL. It is stored in
|
||||||
|
|
|
@ -26,14 +26,14 @@ cluster and view them all through the same instance of {kib}.
|
||||||
|
|
||||||
By default, data is retrieved from the cluster specified in the
|
By default, data is retrieved from the cluster specified in the
|
||||||
`elasticsearch.hosts` value in the `kibana.yml` file. If you want to retrieve it
|
`elasticsearch.hosts` value in the `kibana.yml` file. If you want to retrieve it
|
||||||
from a different cluster, set `xpack.monitoring.elasticsearch.hosts`.
|
from a different cluster, set `monitoring.ui.elasticsearch.hosts`.
|
||||||
|
|
||||||
To learn more about typical monitoring architectures,
|
To learn more about typical monitoring architectures,
|
||||||
see {ref}/how-monitoring-works.html[How monitoring works] and
|
see {ref}/how-monitoring-works.html[How monitoring works] and
|
||||||
{ref}/monitoring-production.html[Monitoring in a production environment].
|
{ref}/monitoring-production.html[Monitoring in a production environment].
|
||||||
--
|
--
|
||||||
|
|
||||||
. Verify that `xpack.monitoring.ui.enabled` is set to `true`, which is the
|
. Verify that `monitoring.ui.enabled` is set to `true`, which is the
|
||||||
default value, in the `kibana.yml` file. For more information, see
|
default value, in the `kibana.yml` file. For more information, see
|
||||||
<<monitoring-settings-kb>>.
|
<<monitoring-settings-kb>>.
|
||||||
|
|
||||||
|
@ -43,8 +43,8 @@ must provide a user ID and password so {kib} can retrieve the data.
|
||||||
.. Create a user that has the `monitoring_user`
|
.. Create a user that has the `monitoring_user`
|
||||||
{ref}/built-in-roles.html[built-in role] on the monitoring cluster.
|
{ref}/built-in-roles.html[built-in role] on the monitoring cluster.
|
||||||
|
|
||||||
.. Add the `xpack.monitoring.elasticsearch.username` and
|
.. Add the `monitoring.ui.elasticsearch.username` and
|
||||||
`xpack.monitoring.elasticsearch.password` settings in the `kibana.yml` file.
|
`monitoring.ui.elasticsearch.password` settings in the `kibana.yml` file.
|
||||||
If these settings are omitted, {kib} uses the `elasticsearch.username` and
|
If these settings are omitted, {kib} uses the `elasticsearch.username` and
|
||||||
`elasticsearch.password` setting values. For more
|
`elasticsearch.password` setting values. For more
|
||||||
information, see {kibana-ref}/using-kibana-with-security.html[Configuring security in {kib}].
|
information, see {kibana-ref}/using-kibana-with-security.html[Configuring security in {kib}].
|
||||||
|
|
|
@ -188,5 +188,5 @@ verification. For more information about this setting, see <<settings,{kib} conf
|
||||||
--
|
--
|
||||||
|
|
||||||
If the Elastic {monitor-features} are enabled and you have set up a separate {es} monitoring cluster, you can also configure {kib} to
|
If the Elastic {monitor-features} are enabled and you have set up a separate {es} monitoring cluster, you can also configure {kib} to
|
||||||
connect to the monitoring cluster via HTTPS. The steps are the same, but each setting is prefixed by `xpack.monitoring.`. For
|
connect to the monitoring cluster via HTTPS. The steps are the same, but each setting is prefixed by `monitoring.`. For
|
||||||
example, `xpack.monitoring.elasticsearch.hosts`, `xpack.monitoring.elasticsearch.ssl.truststore.path`, etc.
|
example, `monitoring.ui.elasticsearch.hosts`, `monitoring.ui.elasticsearch.ssl.truststore.path`, etc.
|
||||||
|
|
|
@ -72,6 +72,22 @@ kibana_vars=(
|
||||||
map.tilemap.options.minZoom
|
map.tilemap.options.minZoom
|
||||||
map.tilemap.options.subdomains
|
map.tilemap.options.subdomains
|
||||||
map.tilemap.url
|
map.tilemap.url
|
||||||
|
monitoring.cluster_alerts.email_notifications.email_address
|
||||||
|
monitoring.enabled
|
||||||
|
monitoring.kibana.collection.enabled
|
||||||
|
monitoring.kibana.collection.interval
|
||||||
|
monitoring.ui.container.elasticsearch.enabled
|
||||||
|
monitoring.ui.container.logstash.enabled
|
||||||
|
monitoring.ui.elasticsearch.password
|
||||||
|
monitoring.ui.elasticsearch.pingTimeout
|
||||||
|
monitoring.ui.elasticsearch.hosts
|
||||||
|
monitoring.ui.elasticsearch.username
|
||||||
|
monitoring.ui.elasticsearch.logFetchCount
|
||||||
|
monitoring.ui.elasticsearch.ssl.certificateAuthorities
|
||||||
|
monitoring.ui.elasticsearch.ssl.verificationMode
|
||||||
|
monitoring.ui.enabled
|
||||||
|
monitoring.ui.max_bucket_size
|
||||||
|
monitoring.ui.min_interval_seconds
|
||||||
newsfeed.enabled
|
newsfeed.enabled
|
||||||
ops.interval
|
ops.interval
|
||||||
path.data
|
path.data
|
||||||
|
@ -160,25 +176,6 @@ kibana_vars=(
|
||||||
xpack.infra.sources.default.metricAlias
|
xpack.infra.sources.default.metricAlias
|
||||||
xpack.license_management.enabled
|
xpack.license_management.enabled
|
||||||
xpack.ml.enabled
|
xpack.ml.enabled
|
||||||
xpack.monitoring.cluster_alerts.email_notifications.email_address
|
|
||||||
xpack.monitoring.elasticsearch.password
|
|
||||||
xpack.monitoring.elasticsearch.pingTimeout
|
|
||||||
xpack.monitoring.elasticsearch.hosts
|
|
||||||
xpack.monitoring.elasticsearch.username
|
|
||||||
xpack.monitoring.elasticsearch.logFetchCount
|
|
||||||
xpack.monitoring.elasticsearch.ssl.certificateAuthorities
|
|
||||||
xpack.monitoring.elasticsearch.ssl.verificationMode
|
|
||||||
xpack.monitoring.enabled
|
|
||||||
xpack.monitoring.kibana.collection.enabled
|
|
||||||
xpack.monitoring.kibana.collection.interval
|
|
||||||
xpack.monitoring.max_bucket_size
|
|
||||||
xpack.monitoring.min_interval_seconds
|
|
||||||
xpack.monitoring.node_resolver
|
|
||||||
xpack.monitoring.report_stats
|
|
||||||
xpack.monitoring.elasticsearch.pingTimeout
|
|
||||||
xpack.monitoring.ui.container.elasticsearch.enabled
|
|
||||||
xpack.monitoring.ui.container.logstash.enabled
|
|
||||||
xpack.monitoring.ui.enabled
|
|
||||||
xpack.reporting.capture.browser.autoDownload
|
xpack.reporting.capture.browser.autoDownload
|
||||||
xpack.reporting.capture.browser.chromium.disableSandbox
|
xpack.reporting.capture.browser.chromium.disableSandbox
|
||||||
xpack.reporting.capture.browser.chromium.inspect
|
xpack.reporting.capture.browser.chromium.inspect
|
||||||
|
|
|
@ -29,7 +29,7 @@ function generator({ imageFlavor }) {
|
||||||
server.name: kibana
|
server.name: kibana
|
||||||
server.host: "0"
|
server.host: "0"
|
||||||
elasticsearch.hosts: [ "http://elasticsearch:9200" ]
|
elasticsearch.hosts: [ "http://elasticsearch:9200" ]
|
||||||
${!imageFlavor ? 'xpack.monitoring.ui.container.elasticsearch.enabled: true' : ''}
|
${!imageFlavor ? 'monitoring.ui.container.elasticsearch.enabled: true' : ''}
|
||||||
`);
|
`);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -72,8 +72,8 @@ cluster.
|
||||||
1. Set the Kibana config:
|
1. Set the Kibana config:
|
||||||
```
|
```
|
||||||
% cat config/kibana.dev.yml
|
% cat config/kibana.dev.yml
|
||||||
xpack.monitoring.elasticsearch:
|
monitoring.ui.elasticsearch:
|
||||||
url: "http://localhost:9210"
|
hosts: "http://localhost:9210"
|
||||||
username: "kibana"
|
username: "kibana"
|
||||||
password: "changeme"
|
password: "changeme"
|
||||||
```
|
```
|
||||||
|
|
Loading…
Reference in a new issue