Skip to content

Commit

Permalink
[DOCS] Enhance Infrastructure UI section of Kibana docs (#42937) (#43279
Browse files Browse the repository at this point in the history
)

* Update index.asciidoc

More tidying up

* Partial commit, still very much work in progress

* Work in progress

* More partial changes

* More partial changes

* Yet more changes

* More changes to infrastructure section

* Some more tidying up of topics.

* More changes, adjusting links, proof-reading etc.

* Some review comments from @bmorelli25 and @gchaps

* Another review change

* Adding redirect for deleted bookmark

* More review changes

“application” is “app” apparently in this context

* Review comments from Brandon
  • Loading branch information
Titch990 authored Aug 14, 2019
1 parent ed193f3 commit 8de98a8
Show file tree
Hide file tree
Showing 13 changed files with 159 additions and 147 deletions.
11 changes: 11 additions & 0 deletions docs/infrastructure/getting-started.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
[role="xpack"]
[[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.

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.

[role="screenshot"]
image::infrastructure/images/metrics-add-data.png[Screenshot showing Add metric data to Kibana UI]
Binary file removed docs/infrastructure/images/infra-sysmon.jpg
Binary file not shown.
Binary file added docs/infrastructure/images/infra-sysmon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/infrastructure/images/metrics-add-data.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/infrastructure/images/time-filter-clock.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
82 changes: 15 additions & 67 deletions docs/infrastructure/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,83 +4,31 @@

[partintro]
--
Use the interactive Infrastructure UI to monitor your infrastructure and
identify problems in real time. You can explore metrics and logs for common
servers, containers, and services.
The Infrastructure 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.

[role="screenshot"]
image::infrastructure/images/infra-sysmon.jpg[Infrastructure Overview in Kibana]


[float]
== Add data

Kibana provides step-by-step instructions to help you add log data. The
{infra-guide}[Infrastructure Monitoring Guide] is a good source for more
detailed information and instructions.
You can:

[float]
== Configure data sources
* View an inventory of your infrastructure by hosts, Kubernetes pod or Docker containers.
You can group and filter the data in various ways to help you identify the items that interest you.

The `metricbeat-*` index pattern is used to query the data by default.
If your metrics are located in a different set of indices, or use a
different timestamp field, you can adjust the source configuration via the user
interface or the {kib} configuration file.
* View current and historic values for metrics such as CPU usage, memory usage, and network traffic for each component.
The available metrics depend on the kind of component being inspected.

NOTE: Logs and Infrastructure share a common data source definition in
each space. Changes in one of them can influence the data displayed in the
other.

[float]
=== Configure source

Configure source can be accessed via the corresponding
image:logs/images/logs-configure-source-gear-icon.png[Configure source icon]
button in the toolbar:

[role="screenshot"]
image::infrastructure/images/infrastructure-configure-source.png[Configure Infrastructure UI source button in Kibana]
* Use *Metrics Explorer* to group and visualize multiple customizable metrics for one or more components in a graphical format.
You can optionally save these views and add them to {kibana-ref}/dashboard.html[dashboards].

This opens the source configuration fly-out dialog, in which the following
configuration items can be inspected and adjusted:
* Seamlessly switch to view the corresponding logs, application traces or uptime information for a component.

* *Name*: The name of the source configuration.
* *Indices*: The patterns of the elasticsearch indices to read metrics and logs
from.
* *Fields*: The names of particular fields in the indices that need to be known
to the Infrastructure and Logs UIs in order to query and interpret the data
correctly.
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>>.

[role="screenshot"]
image::infrastructure/images/infrastructure-configure-source-dialog.png[Configure Infrastructure UI source dialog in Kibana]

TIP: If <<xpack-spaces>> are enabled in your Kibana instance, any configuration
changes performed via Configure source are specific to that space. You can
therefore easily make different subsets of the data available by creating
multiple spaces with different data source configurations.

[float]
[[infra-read-only-access]]
=== Read only access
When you have insufficient privileges to change the source configuration, the following
indicator in Kibana will be displayed. The buttons to change the source configuration
won't be visible. For more information on granting access to
Kibana see <<xpack-security-authorization>>.

[role="screenshot"]
image::infrastructure/images/read-only-badge.png[Example of Infrastructure's read only access indicator in Kibana's header]


[float]
=== Configuration file

The settings in the configuration file are used as a fallback when no other
configuration for that space has been defined. They are located in the
configuration namespace `xpack.infra.sources.default`. See
<<infrastructure-ui-settings-kb>> for a complete list of the possible entries.
image::infrastructure/images/infra-sysmon.png[Infrastructure Overview in Kibana]

--

include::monitor.asciidoc[]
include::getting-started.asciidoc[]
include::infra-ui.asciidoc[]
include::view-metrics.asciidoc[]
include::metrics-explorer.asciidoc[]
117 changes: 80 additions & 37 deletions docs/infrastructure/infra-ui.asciidoc
Original file line number Diff line number Diff line change
@@ -1,68 +1,111 @@
[role="xpack"]
[[infra-ui]]
== Using the Infrastructure UI
== Using the Infrastructure app

Use the Infrastructure UI in {kib} to monitor your infrastructure and identify
problems in real time.
Use the Infrastructure 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.

You start with an overview of your infrastructure.
Then you can use the interactive UI to drill down into areas of interest.
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.

[role="screenshot"]
image::infrastructure/images/infra-sysmon.jpg[Infrastructure Overview in Kibana]

TIP: Right-click an element to jump to related logs or metrics.
image::infrastructure/images/infra-sysmon.png[Infrastructure Overview in Kibana]

[float]
[[infra-cat]]
=== View your infrastructure by hosts or container

Select the high-level view: *Hosts*, *Kubernetes*, or *Docker*.
When you change views, you can see the same data through the perspective of a
different category.
=== Choose the high-level view of your infrastructure

[float]
[[infra-search]]
=== Use the power of Search
Select the high-level view from *Hosts*, *Kubernetes*, or *Docker*.
When you change views, you see the same data through the perspective of a different category.

The Search bar is always available. You can use it to perform adhoc or structured searches.
The Search feature can surface the information you're looking for, even if the
other options you have selected would normally filter it out.
The default representation is the *Map view*, which shows your components in a _waffle map_ of one or more rectangular grids.
If the view you select has a large number of components, you can hover over a component to see the details for that component. Alternatively, if you would prefer to see your infrastructure as a table, click *Table view*.

[float]
[[infra-metric]]
=== Start at a high-level by selecting the metric
=== Select the metric to view

This filter helps you start focusing on potential problem areas that may need
further investigation. You'll see metrics that are most relevant for hosts or
the container you selected.
Select the metric to view from the *Metric* dropdown list.
The available metrics are those that are most relevant for the high-level view you selected.

[float]
[[infra-group]]
=== Group components
=== Group components

Select the way you want to group the infrastructure components from the *Group By* dropdown list.
The available options are specific to your physical, virtual, or container-based infrastructure.
Examples of grouping options include *Availability Zone*, *Machine Type*, *Project ID*, and *Cloud Provider* for hosts, and *Namespace* and *Node* for Kubernetes.

[float]
[[infra-search]]
=== Use the power of search

The *Group By* selector offers grouping options that are native and specific for
your physical, virtual, and container-based infrastructure.
Examples include Availability Zone, Machine Type, Project ID, and Cloud Provider
for Hosts, and Namespace and Node for Kubernetes.
Use the search bar to perform ad hoc or structured searches using {kibana-ref}/kuery-query.html[Kibana Query Language] which features autocomplete and a simple, easy to use syntax.
For example, enter `host.hostname : "host1"` to see only the information for `host1`.

[float]
[[infra-date]]
=== Specify the date range
=== Specify the time and date

Use the time selector to focus on a specific timeframe.
Click the time selector to choose the timeframe for the metrics.
The values shown are the values for the last minute at the specified time and date.

[float]
[[infra-refresh]]
=== Auto-refresh or pause
=== Auto-refresh metrics

Set auto-refresh to keep up-to-date information coming in, or stop
refreshing to focus on historical data without new distractions.
Select *Auto-refresh* to keep up-to-date metrics information coming in, or *Stop refreshing* to focus on historical data without new distractions.

[float]
[[infra-configure-source]]
=== Adapt to your metric 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 configuration uses the `metricbeat-*` index pattern to query the data.
The default configuration also defines field settings for things like timestamps and container names.

If your metrics have custom index patterns, or use non-default field settings, you can override the default settings.
Click *Configuration* to change the settings.
This opens the *Configure source* fly-out dialog.

NOTE: These settings are shared with logs. Changes you make here may also affect the settings used in the *Logs* tab.

In the *Configure source* dialog, you can change the following values:

* *Name*: the name of the source configuration
* *Indices*: the index pattern or patterns in the Elasticsearch indices to read metrics data and log data
from
* *Fields*: the names of specific fields in the indices that need are used to query and interpret the data correctly

TIP: If <<xpack-spaces>> are enabled in your Kibana instance, any configuration changes you make here are specific to the current space.
You can make different subsets of data available by creating multiple spaces with different data source configurations.

TIP: If you don't see the *Configuration* option, you may not have sufficient privileges to change the source configuration.
For more information see <<xpack-security-authorization>>.

[float]
[[infra-metrics-explorer]]
=== Visualize multiple metrics in Metrics Explorer

<<metrics-explorer, Metrics Explorer>> allows you to visualize and analyze metrics for multiple components in a powerful and configurable way. Click the *Metrics Explorer* tab to get started.

[float]
[[infra-drill-down]]
=== Drill down for related information

Hover over a component to see more information about that component.

Click a component to see the other actions available for that component.
You can:

* Select *View Metrics* to <<xpack-view-metrics, view detailed infrastructure metrics>>.

* Select *View Logs* to <<xpack-logs-using, view the logs>> in the *Logs* app.

Depending on the features you have installed and configured, you may also be able to:

* Select *View APM* to <<traces, view APM traces>> in the *APM* app.

* Select *View Uptime* to <<uptime-overview, view uptime information>> in the *Uptime* app.

Using a custom index pattern to store the metrics, or want to limit the entries
presented in a space? Use configure source to change the index pattern and
other settings.
16 changes: 8 additions & 8 deletions docs/infrastructure/metrics-explorer.asciidoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[role="xpack"]
[[metrics-explorer]]

== Metrics Explorer

Metrics Explorer allows you to visualize metrics data collected by Metricbeat and group it in various ways to visualize multiple metrics.
It can be a starting point for further investigations.
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.
This can be a starting point for further investigations.
You can also save your views and add them to {kibana-ref}/dashboard.html[dashboards].

[role="screenshot"]
image::infrastructure/images/metrics-explorer-screen.png[Metrics Explorer in Kibana]
Expand All @@ -13,13 +13,13 @@ image::infrastructure/images/metrics-explorer-screen.png[Metrics Explorer in Kib
[[metrics-explorer-requirements]]
=== Metrics Explorer requirements and considerations

* The 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 UI.
* Metrics Explorer uses the timestamp field set in the Infrastructure configuration UI.
* 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.
* 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`.
The bucket size is determined by the time range.
* *Open in Visualize* requires you to have access to the Visualize app, otherwise it is not available.
* To use *Open in Visualize* you need access to the Visualize app.

[float]
[[metrics-explorer-tutorial]]
Expand Down Expand Up @@ -49,7 +49,7 @@ If you only have metrics for a single host, you will see a single graph.
Congratulations! Either way, you've explored your first metric.

5. Let's explore a bit further.
In the upper right hand corner of the graph for one of the hosts, select the *Actions* dropdown and click *Add Filter* to show ony the metrics for that host.
In the upper right hand corner of the graph for one of the hosts, select the *Actions* dropdown and click *Add Filter* to show only the metrics for that host.
This adds a {kibana-ref}/kuery-query.html[Kibana Query Language] filter for `host.name` in the second row of the Metrics Explorer configuration.
If you only have one host, the graph will not change as you are already exploring metrics for a single host.

Expand Down
35 changes: 0 additions & 35 deletions docs/infrastructure/monitor.asciidoc

This file was deleted.

39 changes: 39 additions & 0 deletions docs/infrastructure/view-metrics.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
[role="xpack"]
[[xpack-view-metrics]]

== 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.

[role="screenshot"]
image::infrastructure/images/infra-view-metrics.png[Infrastructure View Metrics in Kibana]

[float]
[[infra-view-metrics-date]]
=== Specify the time and date range

Use the time filter to select the time and date range for the metrics.

To quickly select some popular time range options, click the calendar dropdown image:infrastructure/images/time-filter-calendar.png[]. In this popup you can choose from:

* *Quick select* to choose a recent time range, and use the back and forward arrows to move through the time ranges
* *Commonly used* to choose a time range from some commonly used options such as *Last 15 minutes*, *Today*, or *Week to date*
* *Refresh every* to specify an auto-refresh rate

NOTE: When you start auto-refresh from within this dialog, the calendar dropdown changes to a clock image:infrastructure/images/time-filter-clock.png[].

For complete control over the start and end times, click the start time or end time shown in the bar beside the calendar dropdown. In this popup, you can choose from the *Absolute*, *Relative* or *Now* tabs, then specify the required options.

[float]
[[infra-view-refresh-metrics-date]]
=== Refresh the metrics

You can click *Refresh* to manually refresh the metrics.

[float]
[[infra-view-go-to-chart]]
=== Go to a specific chart

The charts available for this component are shown in a list on the left of the page. Click a chart in the list to quickly go to that chart.


6 changes: 6 additions & 0 deletions docs/redirects.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,9 @@ For more {kib} configuration settings, see <<settings>>.
== Uptime security

This page has moved. Please see the new section in the {uptime-guide}/uptime-security.html[Uptime Monitoring Guide].

[role="exclude",id="infra-read-only-access"]
== Configure source read-only access

This page has moved. Please see <<infra-configure-source>>.

0 comments on commit 8de98a8

Please sign in to comment.