From 28c9bd747cbccf003bc682ea0e97c826f5592e44 Mon Sep 17 00:00:00 2001 From: Marjorie Jones Date: Tue, 29 Oct 2019 13:32:26 +0000 Subject: [PATCH] [DOCs] Rename some instances of Infrastructure to Metrics (#49195) (#49612) * Renaming Infrastructure to Metrics whenever the context is the metrics app. * More renames, and picking up a few stray references to Infrastructure/Metrics/Logs UI too. * Fixing typo --- docs/infrastructure/getting-started.asciidoc | 4 ++-- docs/infrastructure/index.asciidoc | 4 ++-- docs/infrastructure/infra-ui.asciidoc | 4 ++-- docs/infrastructure/metrics-explorer.asciidoc | 2 +- docs/logs/using.asciidoc | 2 +- docs/settings/general-infra-logs-ui-settings.asciidoc | 4 ++-- docs/settings/infrastructure-ui-settings.asciidoc | 8 ++++---- docs/settings/logs-ui-settings.asciidoc | 8 ++++---- docs/uptime-guide/overview.asciidoc | 4 ++-- docs/uptime/overview.asciidoc | 4 ++-- 10 files changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/infrastructure/getting-started.asciidoc b/docs/infrastructure/getting-started.asciidoc index 1c5645f5a6e4..7122ad5c19f7 100644 --- a/docs/infrastructure/getting-started.asciidoc +++ b/docs/infrastructure/getting-started.asciidoc @@ -1,6 +1,6 @@ [role="xpack"] [[xpack-metrics-getting-started]] -== Getting started with infrastructure monitoring +== Getting started with metrics To get started with the Metrics app in Kibana, you need to start collecting metrics data for your infrastructure. @@ -8,4 +8,4 @@ Kibana provides step-by-step instructions to help you add metrics data. The {metrics-guide}[Metrics Monitoring Guide] is a good source for more detailed information and instructions. [role="screenshot"] -image::infrastructure/images/metrics-add-data.png[Screenshot showing Add metric data to Kibana UI] +image::infrastructure/images/metrics-add-data.png[Screenshot showing Add metric data to Kibana] diff --git a/docs/infrastructure/index.asciidoc b/docs/infrastructure/index.asciidoc index 17361ef6a608..5e2d0f3e757b 100644 --- a/docs/infrastructure/index.asciidoc +++ b/docs/infrastructure/index.asciidoc @@ -4,13 +4,13 @@ [partintro] -- -The Metrics app enables you to monitor your infrastructure and identify problems in real time. +The Metrics app enables you to monitor your infrastructure metrics and identify problems in real time. You start with a visual summary of your infrastructure where you can view basic metrics for common servers, containers, and services. Then you can drill down to view more detailed metrics or other information for that component. You can: -* View an inventory of your infrastructure by hosts, Kubernetes pod or Docker containers. +* View your infrastructure metrics by hosts, Kubernetes pods or Docker containers. You can group and filter the data in various ways to help you identify the items that interest you. * View current and historic values for metrics such as CPU usage, memory usage, and network traffic for each component. diff --git a/docs/infrastructure/infra-ui.asciidoc b/docs/infrastructure/infra-ui.asciidoc index 5c8c50a978d6..120a22541717 100644 --- a/docs/infrastructure/infra-ui.asciidoc +++ b/docs/infrastructure/infra-ui.asciidoc @@ -2,12 +2,12 @@ [[infra-ui]] == Using the Metrics app -Use the Metrics app in {kib} to monitor your infrastructure and identify problems in real time. +Use the Metrics app in {kib} to monitor your infrastructure metrics and identify problems in real time. You can explore metrics for hosts, containers, and services. You can also drill down to view more detailed metrics, or seamlessly switch to view the corresponding logs, application traces, and uptime information. Initially, the *Inventory* tab shows an overview of the hosts in of your infrastructure and the current CPU usage for each host. -From here, you can drill down into areas of interest. +From here, you can view other metrics or drill down into areas of interest. [role="screenshot"] image::infrastructure/images/infra-sysmon.png[Infrastructure Overview in Kibana] diff --git a/docs/infrastructure/metrics-explorer.asciidoc b/docs/infrastructure/metrics-explorer.asciidoc index 2919eaa976d6..c20718dac1c7 100644 --- a/docs/infrastructure/metrics-explorer.asciidoc +++ b/docs/infrastructure/metrics-explorer.asciidoc @@ -15,7 +15,7 @@ image::infrastructure/images/metrics-explorer-screen.png[Metrics Explorer in Kib * Metrics Explorer uses data collected from {metricbeat-ref}/metricbeat-overview.html[Metricbeat]. * You need read permissions on `metricbeat-*` or the metric index specified in the Metrics configuration. -* Metrics Explorer uses the timestamp field set in the Infrastructure configuration. +* Metrics Explorer uses the timestamp field from the *Settings* tab. By default that is set to `@timestamp`. * The interval for the X Axis is set to `auto`. The bucket size is determined by the time range. diff --git a/docs/logs/using.asciidoc b/docs/logs/using.asciidoc index 65693f4399e5..916ad42a6d22 100644 --- a/docs/logs/using.asciidoc +++ b/docs/logs/using.asciidoc @@ -17,7 +17,7 @@ image::logs/images/logs-console.png[Logs Console in Kibana] Use the search bar to perform ad hoc searches for specific text. You can also create structured queries using {kibana-ref}/kuery-query.html[Kibana Query Language]. For example, enter `host.hostname : "host1"` to see only the information for `host1`. -// ++ this isn't quite the same as the corresponding infrastructure description now. +// ++ this isn't quite the same as the corresponding metrics description now. [float] [[logs-configure-source]] diff --git a/docs/settings/general-infra-logs-ui-settings.asciidoc b/docs/settings/general-infra-logs-ui-settings.asciidoc index d84b73e57b83..a993519f4256 100644 --- a/docs/settings/general-infra-logs-ui-settings.asciidoc +++ b/docs/settings/general-infra-logs-ui-settings.asciidoc @@ -1,4 +1,4 @@ -`xpack.infra.enabled`:: Set to `false` to disable the Logs and Metrics UI plugin {kib}. Defaults to `true`. +`xpack.infra.enabled`:: Set to `false` to disable the Logs and Metrics app plugin {kib}. Defaults to `true`. `xpack.infra.sources.default.logAlias`:: Index pattern for matching indices that contain log data. Defaults to `filebeat-*,kibana_sample_data_logs*`. @@ -6,7 +6,7 @@ `xpack.infra.sources.default.fields.timestamp`:: Timestamp used to sort log entries. Defaults to `@timestamp`. -`xpack.infra.sources.default.fields.message`:: Fields used to display messages in the Logs UI. Defaults to `['message', '@message']`. +`xpack.infra.sources.default.fields.message`:: Fields used to display messages in the Logs app. Defaults to `['message', '@message']`. `xpack.infra.sources.default.fields.tiebreaker`:: Field used to break ties between two entries with the same timestamp. Defaults to `_doc`. diff --git a/docs/settings/infrastructure-ui-settings.asciidoc b/docs/settings/infrastructure-ui-settings.asciidoc index 1617f2847c50..ed69c27feab7 100644 --- a/docs/settings/infrastructure-ui-settings.asciidoc +++ b/docs/settings/infrastructure-ui-settings.asciidoc @@ -1,14 +1,14 @@ [role="xpack"] [[infrastructure-ui-settings-kb]] -=== Metrics UI settings in Kibana +=== Metrics settings in Kibana ++++ -Metrics UI settings +Metrics settings ++++ -You do not need to configure any settings to use the Metrics UI. It is enabled by default. +You do not need to configure any settings to use the Metrics app in {kib}. It is enabled by default. [float] [[general-infra-ui-settings-kb]] -==== General Metrics UI settings +==== General Metrics settings include::general-infra-logs-ui-settings.asciidoc[] \ No newline at end of file diff --git a/docs/settings/logs-ui-settings.asciidoc b/docs/settings/logs-ui-settings.asciidoc index a2c9e12e22fb..5b6dd902091a 100644 --- a/docs/settings/logs-ui-settings.asciidoc +++ b/docs/settings/logs-ui-settings.asciidoc @@ -1,14 +1,14 @@ [role="xpack"] [[logs-ui-settings-kb]] -=== Logs UI settings in Kibana +=== Logs app settings in Kibana ++++ -Logs UI settings +Logs settings ++++ -You do not need to configure any settings to use the Logs UI. It is enabled by default. +You do not need to configure any settings to use the Logs app in {kib}. It is enabled by default. [float] [[general-logs-ui-settings-kb]] -==== General Logs UI settings +==== General Logs settings include::general-infra-logs-ui-settings.asciidoc[] diff --git a/docs/uptime-guide/overview.asciidoc b/docs/uptime-guide/overview.asciidoc index 09867e7b05f2..c6bd71b1f557 100644 --- a/docs/uptime-guide/overview.asciidoc +++ b/docs/uptime-guide/overview.asciidoc @@ -33,8 +33,8 @@ The {kibana-ref}/xpack-uptime.html[Elasticsearch Uptime app] in Kibana provides [float] === Example deployments -// ++ I like the Infra/logging diagram which shows Infrastructure and Logging apps as separate components inside Kibana -// ++ In diagram, should be Uptime app, not Uptime UI, possibly even Elastic Uptime? Also applies to Infra/logging/APM. +// ++ I like the Infra/logging diagram which shows Metrics and Logging apps as separate components inside Kibana +// ++ In diagram, should be Uptime app, not Uptime UI, possibly even Elastic Uptime? Also applies to Metrics/Logging/APM. // ++ Need more whitespace around components. image::images/uptime-simple-deployment.png[Uptime simple deployment] diff --git a/docs/uptime/overview.asciidoc b/docs/uptime/overview.asciidoc index ea7047ae940a..098ce12a5699 100644 --- a/docs/uptime/overview.asciidoc +++ b/docs/uptime/overview.asciidoc @@ -34,7 +34,7 @@ in an `up` or `down` state are displayed, based on the last check reported by He for each monitor. Next to the counts, there is a histogram displaying the change over time throughout the -selected date range. +selected date range. [float] === Monitor list @@ -56,7 +56,7 @@ ID and URL, its IP address, and a dedicated sparkline showing its check status o image::uptime/images/observability_integrations.png[Observability integrations] The Monitor list also contains a menu of possible integrations. If Uptime detects Kubernetes or -Docker related host information, it will provide links to open the Metrics UI or Logs UI pre-filtered +Docker related host information, it will provide links to open the Metrics app or Logs app pre-filtered for this host. Additionally, this feature supplies links to simply filter the other views on the host's IP address, to help you quickly determine if these other solutions contain data relevant to your current interest.