[7.x] [Infra + Logs UI] Add source configuration ui to the docs (#33535) (#33699)

Backports the following commits to 7.x:
 - [Infra + Logs UI] Add source configuration ui to the docs  (#33535)
This commit is contained in:
Felix Stürmer 2019-03-22 15:38:53 +01:00 committed by GitHub
parent 505f18651b
commit 784d914c8a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 113 additions and 19 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 127 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 748 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

View file

@ -4,8 +4,6 @@
[partintro]
--
beta[]
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.
@ -15,15 +13,59 @@ image::infrastructure/images/infra-sysmon.jpg[Infrastructure Overview in Kibana]
[float]
== Add data sources
Kibana provides step-by-step instructions to help you add your data sources.
The {infra-guide}[Infrastructure Monitoring Guide] is a good source for more detailed
instructions and information.
== 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.
[float]
== Configure data sources
By default the Infrastructure UI uses the `metricbeat-*` index pattern to query the data. If you configured Metricbeat to export data to a different set of indices, you will need to set `xpack.infra.sources.default.metricAlias` in `config/kibana.yml` to match your index pattern. You can also configure the timestamp field by overriding `xpack.infra.sources.default.fields.timestamp`. See <<infrastructure-ui-settings-kb>> for a complete list.
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.
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]
This opens the source configuration fly-out dialog, in which the following
configuration items can be inspected and adjusted:
* *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.
[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]
=== 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.
--

View file

@ -59,4 +59,10 @@ Use the time selector to focus on a specific timeframe.
Set auto-refresh to keep up-to-date information coming in, or stop
refreshing to focus on historical data without new distractions.
[float]
[[infra-configure-source]]
=== Adapt to your metric source
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.

Binary file not shown.

After

Width:  |  Height:  |  Size: 279 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 748 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB

View file

@ -5,7 +5,6 @@
[partintro]
--
beta[]
Use the Logs UI to explore logs for common servers, containers, and services.
{kib} provides a compact, console-like display that you can customize.
@ -14,17 +13,60 @@ image::logs/images/logs-console.png[Log Console in Kibana]
[float]
== Add data sources
== Add data
Kibana provides step-by-step instructions to help you add your data sources.
The {infra-guide}[Infrastructure Monitoring Guide] is a good source for more detailed information and
instructions.
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.
[float]
== Configure data sources
By default the Logs UI uses the `filebeat-*` index pattern to query the data. If your logs are located in a different set of indices, you will need to set `xpack.infra.sources.default.logAlias` in `config/kibana.yml` to match your log's index pattern. You can also configure the timestamp field by overriding `xpack.infra.sources.default.fields.timestamp`, by default it is set to `@timestamp`. See <<logs-ui-settings-kb>> for a complete list.
The `filebeat-*` index pattern is used to query data by default.
If your logs 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.
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::logs/images/logs-configure-source.png[Configure Logs UI source button in Kibana]
This opens the source configuration fly-out dialog, in which the following
configuration items can be inspected and adjusted:
* *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.
[role="screenshot"]
image::logs/images/logs-configure-source-dialog.png[Configure logs 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]
=== 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
<<logs-ui-settings-kb>> for a complete list of the possible entries.
--
include::logs-ui.asciidoc[]
include::logs-ui.asciidoc[]

View file

@ -12,6 +12,13 @@ image::logs/images/logs-console.png[Log Console in Kibana]
=== Use the power of Search
The Search bar is always available. Use it to perform adhoc and structured searches.
[float]
[[logs-configure-source]]
=== Adapt to your log source
Using a custom index pattern to store the log entries, or want to limit the
entries presented in a space? Use configure source to change the index pattern
and other settings.
[float]
[[logs-time]]
=== Jump to a specific time period
@ -31,7 +38,4 @@ Use *Customize* to adjust your console view and to set the time scale of the log
=== Stream or pause logs
You can stream data for live log tailing, or pause streaming to focus on historical log data.
When you are streaming logs, the most recent log appears at the bottom on the console.
Historical data offers infinite scrolling.
Historical data offers infinite scrolling.

View file

@ -1,6 +1,6 @@
`xpack.infra.enabled`:: Set to `false` to disable the Logs and Infrastructure UI plugin {kib}. Defaults to `true`.
`xpack.infra.sources.default.logAlias`:: Index pattern for matching indices that contain log data. Defaults to `filebeat-*`.
`xpack.infra.sources.default.logAlias`:: Index pattern for matching indices that contain log data. Defaults to `filebeat-*,kibana_sample_data_logs*`.
`xpack.infra.sources.default.metricAlias`:: Index pattern for matching indices that contain Metricbeat data. Defaults to `metricbeat-*`.