From 772b7a7c478ce4b1f6cd96c4762f66cc3aa0fcaa Mon Sep 17 00:00:00 2001 From: Sebastian Grodzicki Date: Thu, 17 Oct 2019 20:00:07 +0200 Subject: [PATCH] [Infra UI] Update docs to reflect renaming to Metrics (#47927) (#48552) * Rename Infrastructure UI to Metrics UI * Rename Infrastructure app to Metrics app * Rename Infrastructure to Metrics # Conflicts: # x-pack/legacy/plugins/infra/docs/test_setups/infra_metricbeat_docker_nginx.md --- docs/infrastructure/getting-started.asciidoc | 2 +- docs/infrastructure/index.asciidoc | 6 +++--- docs/infrastructure/infra-ui.asciidoc | 6 +++--- docs/infrastructure/metrics-explorer.asciidoc | 6 +++--- docs/infrastructure/view-metrics.asciidoc | 2 +- docs/logs/index.asciidoc | 2 +- docs/settings/general-infra-logs-ui-settings.asciidoc | 2 +- docs/settings/infrastructure-ui-settings.asciidoc | 8 ++++---- docs/uptime/overview.asciidoc | 2 +- x-pack/legacy/plugins/infra/README.md | 6 +++--- .../infra/docs/test_setups/infra_metricbeat_aws.md | 2 +- 11 files changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/infrastructure/getting-started.asciidoc b/docs/infrastructure/getting-started.asciidoc index 510d53ccdccc..151a8e2928cf 100644 --- a/docs/infrastructure/getting-started.asciidoc +++ b/docs/infrastructure/getting-started.asciidoc @@ -2,7 +2,7 @@ [[xpack-metrics-getting-started]] == Getting started with infrastructure monitoring -To get started with the Infrastructure app in Kibana, you need to start collecting metrics data for your infrastructure. +To get started with the Metrics app in Kibana, you need to start collecting metrics data for your infrastructure. Kibana provides step-by-step instructions to help you add metrics data. The {infra-guide}[Infrastructure Monitoring Guide] is a good source for more detailed information and instructions. diff --git a/docs/infrastructure/index.asciidoc b/docs/infrastructure/index.asciidoc index 33389345fff7..17361ef6a608 100644 --- a/docs/infrastructure/index.asciidoc +++ b/docs/infrastructure/index.asciidoc @@ -1,10 +1,10 @@ [role="xpack"] [[xpack-infra]] -= Infrastructure += Metrics [partintro] -- -The Infrastructure app enables you to monitor your infrastructure and identify problems in real time. +The Metrics app enables you to monitor your infrastructure 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. @@ -21,7 +21,7 @@ You can optionally save these views and add them to {kibana-ref}/dashboard.html[ * Seamlessly switch to view the corresponding logs, application traces or uptime information for a component. -To get started, you need to <>. Then you can <>. +To get started, you need to <>. Then you can <>. [role="screenshot"] image::infrastructure/images/infra-sysmon.png[Infrastructure Overview in Kibana] diff --git a/docs/infrastructure/infra-ui.asciidoc b/docs/infrastructure/infra-ui.asciidoc index b976714587b7..e92f6b3f6420 100644 --- a/docs/infrastructure/infra-ui.asciidoc +++ b/docs/infrastructure/infra-ui.asciidoc @@ -1,8 +1,8 @@ [role="xpack"] [[infra-ui]] -== Using the Infrastructure app +== Using the Metrics app -Use the Infrastructure app in {kib} to monitor your infrastructure and identify problems in real time. +Use the Metrics app in {kib} to monitor your infrastructure 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. @@ -62,7 +62,7 @@ Select *Auto-refresh* to keep up-to-date metrics information coming in, or *Stop [[infra-configure-source]] === Configure the data to use for your metrics -The default source configuration for metrics is specified in the {kibana-ref}/infrastructure-ui-settings-kb.html[Infrastructure app settings] in the {kibana-ref}/settings.html[Kibana configuration file]. +The default source configuration for metrics is specified in the {kibana-ref}/infrastructure-ui-settings-kb.html[Metrics app settings] in the {kibana-ref}/settings.html[Kibana configuration file]. The default configuration uses the `metricbeat-*` index pattern to query the data. The default configuration also defines field settings for things like timestamps and container names. diff --git a/docs/infrastructure/metrics-explorer.asciidoc b/docs/infrastructure/metrics-explorer.asciidoc index 729d5ff97efd..2919eaa976d6 100644 --- a/docs/infrastructure/metrics-explorer.asciidoc +++ b/docs/infrastructure/metrics-explorer.asciidoc @@ -2,7 +2,7 @@ [[metrics-explorer]] == Metrics Explorer -Metrics Explorer in the Infrastructure app in Kibana allows you to group and visualise multiple customisable metrics for one or more components in a graphical format. +Metrics Explorer in the Metrics app in Kibana allows you to group and visualise multiple customisable metrics for one or more components in a graphical format. This can be a starting point for further investigations. You can also save your views and add them to {kibana-ref}/dashboard.html[dashboards]. @@ -14,7 +14,7 @@ image::infrastructure/images/metrics-explorer-screen.png[Metrics Explorer in Kib === Metrics Explorer requirements and considerations * 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 Infrastructure configuration. +* 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. By default that is set to `@timestamp`. * The interval for the X Axis is set to `auto`. @@ -30,7 +30,7 @@ After that, we'll filter down to a specific host and explore the outbound traffi Before we start, if you don't have any Metricbeat data, you'll need to head over to our {metricbeat-ref}/metricbeat-overview.html[Metricbeat documentation] to install Metricbeat and start collecting data. -1. When you have Metricbeat running and collecting data, open Kibana and navigate to *Infrastructure*. +1. When you have Metricbeat running and collecting data, open Kibana and navigate to *Metrics*. The *Inventory* tab shows the host or hosts you are monitoring. 2. Select the *Metrics Explorer* tab. diff --git a/docs/infrastructure/view-metrics.asciidoc b/docs/infrastructure/view-metrics.asciidoc index 229d91ae5aae..bbb981acc3ad 100644 --- a/docs/infrastructure/view-metrics.asciidoc +++ b/docs/infrastructure/view-metrics.asciidoc @@ -3,7 +3,7 @@ == Viewing infrastructure metrics -When you select *View Metrics* for a component in your infrastructure from the <>, you can view detailed metrics for that component, and for any related components. +When you select *View Metrics* for a component in your infrastructure from the <>, you can view detailed metrics for that component, and for any related components. You can also view additional component metadata. [role="screenshot"] diff --git a/docs/logs/index.asciidoc b/docs/logs/index.asciidoc index 77da7197f44a..d16bfb482aca 100644 --- a/docs/logs/index.asciidoc +++ b/docs/logs/index.asciidoc @@ -10,7 +10,7 @@ The Logs app has a compact, console-like display that you can customize. You can filter the logs by various fields, start and stop live streaming, and highlight text of interest. You can open the Logs app from the *Logs* tab in Kibana. -You can also open the Logs app directly from a component in the Infrastructure app. +You can also open the Logs app directly from a component in the Metrics app. In this case, you will only see the logs for the selected component. * <> diff --git a/docs/settings/general-infra-logs-ui-settings.asciidoc b/docs/settings/general-infra-logs-ui-settings.asciidoc index f57297143ee4..d84b73e57b83 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 Infrastructure UI plugin {kib}. Defaults to `true`. +`xpack.infra.enabled`:: Set to `false` to disable the Logs and Metrics UI 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*`. diff --git a/docs/settings/infrastructure-ui-settings.asciidoc b/docs/settings/infrastructure-ui-settings.asciidoc index 3d7180f7a757..1617f2847c50 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]] -=== Infrastructure UI settings in Kibana +=== Metrics UI settings in Kibana ++++ -Infrastructure UI settings +Metrics UI settings ++++ -You do not need to configure any settings to use the Infrastructure UI. It is enabled by default. +You do not need to configure any settings to use the Metrics UI. It is enabled by default. [float] [[general-infra-ui-settings-kb]] -==== General Infrastructure UI settings +==== General Metrics UI settings include::general-infra-logs-ui-settings.asciidoc[] \ No newline at end of file diff --git a/docs/uptime/overview.asciidoc b/docs/uptime/overview.asciidoc index 5105bffb3a33..ea7047ae940a 100644 --- a/docs/uptime/overview.asciidoc +++ b/docs/uptime/overview.asciidoc @@ -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 Infrastructure UI or Logs UI pre-filtered +Docker related host information, it will provide links to open the Metrics UI or Logs UI 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. diff --git a/x-pack/legacy/plugins/infra/README.md b/x-pack/legacy/plugins/infra/README.md index f13d0a472171..5bff47e7a55e 100644 --- a/x-pack/legacy/plugins/infra/README.md +++ b/x-pack/legacy/plugins/infra/README.md @@ -5,11 +5,11 @@ the infrastructure monitoring use-case within Kibana. ## UI Structure -The plugin provides two main apps in Kibana - the *Infrastructure UI* and the +The plugin provides two main apps in Kibana - the *Metrics UI* and the *Logs UI*. Both are reachable via their own main navigation items and via links from other parts of Kibana. -The *Infrastructure UI* consists of three main screens, which are the +The *Metrics UI* consists of three main screens, which are the *Inventory*, the *Node details* and the *Metrics explorer*. The *Logs UI* provides one log viewer screen. @@ -31,7 +31,7 @@ this section details a few plugin-specific aspects. ### Ingesting metrics for development -The *Infrastructure UI* displays [ECS]-compatible metric data from indices +The *Metrics UI* displays [ECS]-compatible metric data from indices matching the `metricbeat-*` pattern by default. The primary way to ingest these is by running [Metricbeat] to deliver metrics to the development Elasticsearch cluster. It can be used to ingest development host metrics using the `system` diff --git a/x-pack/legacy/plugins/infra/docs/test_setups/infra_metricbeat_aws.md b/x-pack/legacy/plugins/infra/docs/test_setups/infra_metricbeat_aws.md index 6b3c34fedd29..0cd117ed2bd3 100644 --- a/x-pack/legacy/plugins/infra/docs/test_setups/infra_metricbeat_aws.md +++ b/x-pack/legacy/plugins/infra/docs/test_setups/infra_metricbeat_aws.md @@ -4,7 +4,7 @@ This guide explains how to set up * `metricbeat` on a AWS instance to report `system` metrics * `metricbeat` on your local machine to report `aws` metrics through CloudWatch and the `aws` module -This is helpful to develop and test the following features in the Kibana Infrastructure UI: +This is helpful to develop and test the following features in the Kibana Metrics UI: * returning cloud metrics from the `metadata` and `metrics` endpoints * showing cloud metrics on the node detail page * showing cloud metrics on the inventory overview page (waffle map and list view)