Skip to content

Commit

Permalink
[Infra UI] Update docs to reflect renaming to Metrics (#47927)
Browse files Browse the repository at this point in the history
* Rename Infrastructure UI to Metrics UI

* Rename Infrastructure app to Metrics app

* Rename Infrastructure to Metrics
  • Loading branch information
Sebastian Grodzicki committed Oct 11, 2019
1 parent 5e2deb4 commit 9f7bc64
Show file tree
Hide file tree
Showing 12 changed files with 25 additions and 25 deletions.
2 changes: 1 addition & 1 deletion docs/infrastructure/getting-started.asciidoc
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions 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.

Expand All @@ -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 <<xpack-metrics-getting-started, start collecting metrics data from your infrastructure>>. Then you can <<infra-ui, use the Infrastructure application to inspect and analyze your data>>.
To get started, you need to <<xpack-metrics-getting-started, start collecting metrics data from your infrastructure>>. Then you can <<infra-ui, use the Metrics application to inspect and analyze your data>>.

[role="screenshot"]
image::infrastructure/images/infra-sysmon.png[Infrastructure Overview in Kibana]
Expand Down
6 changes: 3 additions & 3 deletions 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.

Expand Down Expand Up @@ -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.

Expand Down
6 changes: 3 additions & 3 deletions docs/infrastructure/metrics-explorer.asciidoc
Expand Up @@ -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].

Expand All @@ -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`.
Expand All @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/infrastructure/view-metrics.asciidoc
Expand Up @@ -3,7 +3,7 @@

== Viewing infrastructure metrics

When you select *View Metrics* for a component in your infrastructure from the <<infra-ui, Infrastructure app in Kibana>>, 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 <<infra-ui, Metrics app in Kibana>>, you can view detailed metrics for that component, and for any related components.
You can also view additional component metadata.

[role="screenshot"]
Expand Down
2 changes: 1 addition & 1 deletion docs/logs/index.asciidoc
Expand Up @@ -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.

* <<xpack-logs-getting-started>>
Expand Down
2 changes: 1 addition & 1 deletion 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*`. To match multiple wildcard patterns, use a comma to separate the names, with no space after the comma. For example, `logstash-app1-*,default-logs-*`.

Expand Down
8 changes: 4 additions & 4 deletions 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
++++
<titleabbrev>Infrastructure UI settings</titleabbrev>
<titleabbrev>Metrics UI settings</titleabbrev>
++++

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[]
2 changes: 1 addition & 1 deletion docs/uptime/overview.asciidoc
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions x-pack/legacy/plugins/infra/README.md
Expand Up @@ -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.
Expand All @@ -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`
Expand Down
Expand Up @@ -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)
Expand Down
Expand Up @@ -4,7 +4,7 @@ This guide explains how to set up
* `docker` to run `nginx` serving a very simple web page
* `metricbeat` to report metrics from `docker` and `nginx`

This is helpful to test the following features in the Kibana Infrastructure UI:
This is helpful to test the following features in the Kibana Metrics UI:
* waffle map and list overview
* metrics detail page

Expand Down Expand Up @@ -155,9 +155,9 @@ Watch the console output. At some point, a log line starting like this will appe
```
If this data contains entries for `docker` and for `nginx`, the configuration is correct.

## Infrastructure UI
## Metrics UI

Now start Kibana and navigate to the Infrastructure UI. You should see your containers in the `Docker` tab, and `nginx` metrics on the node detail page for each container.
Now start Kibana and navigate to the Metrics UI. You should see your containers in the `Docker` tab, and `nginx` metrics on the node detail page for each container.

## Clean up

Expand Down

0 comments on commit 9f7bc64

Please sign in to comment.