[InfraOps] Update docs with data source configuration (#26579) (#28398)

* Updating docs

- Configure data sources via config/kibana.yml
- Fix typo

* Adding timestamp override

* Documenting all settings

* Removing changes from a different PR

* Add settings docs

* Adding all the settings

* Updating docs based on feed back from PR

* Adding periods to lines; changing disabled to present tense

* Updates to docs per PR

* Updates per PR

* Fixes per PR
This commit is contained in:
Chris Cowan 2019-01-09 12:41:07 -07:00 committed by GitHub
parent 92d875a0a2
commit eea7a18a8e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 60 additions and 4 deletions

View file

@ -17,9 +17,14 @@ 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 good source for more detailed
The {infra-guide}[Infrastructure Monitoring Guide] is a good source for more detailed
instructions and information.
[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.
--
include::monitor.asciidoc[]

View file

@ -17,9 +17,13 @@ image::logs/images/logs-console.png[Log Console in Kibana]
== Add data sources
Kibana provides step-by-step instructions to help you add your data sources.
The {infra-guide}[Infrastructure Monitoring Guide] is good source for more detailed information and
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.
--

View file

@ -2,7 +2,7 @@
[[logs-ui]]
== Using the Logs UI
Customize the Infrastructure UI to focus on the data you want to see and control how you see it.
Customize the Logs UI to focus on the data you want to see and control how you see it.
[role="screenshot"]
image::logs/images/logs-console.png[Log Console in Kibana]

View file

@ -0,0 +1,17 @@
`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.metricAlias`:: Index pattern for matching indices that contain Metricbeat data. Defaults to `metricbeat-*`.
`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.tiebreaker`:: Field used to break ties between two entries with the same timestamp. Defaults to `_doc`.
`xpack.infra.sources.default.fields.host`:: Field used to identify hosts. Defaults to `beat.hostname`.
`xpack.infra.sources.default.fields.container`:: Field used to identify Docker containers. Defaults to `docker.container.name`.
`xpack.infra.sources.default.fields.pod`:: Field used to identify Kubernetes pods. Defaults to `kubernetes.pod.name`.

View file

@ -0,0 +1,14 @@
[role="xpack"]
[[infrastructure-ui-settings-kb]]
=== Infrastructure UI Settings in Kibana
++++
<titleabbrev>Infrastructure UI Settings</titleabbrev>
++++
You do not need to configure any settings to use the Infrastructure UI. It is enabled by default.
[float]
[[general-infra-ui-settings-kb]]
==== General Infrastructure UI Settings
include::general-infra-logs-ui-settings.asciidoc[]

View file

@ -0,0 +1,14 @@
[role="xpack"]
[[logs-ui-settings-kb]]
=== Logs UI Settings in Kibana
++++
<titleabbrev>Logs UI Settings</titleabbrev>
++++
You do not need to configure any settings to use the Logs UI. It is enabled by default.
[float]
[[general-logs-ui-settings-kb]]
==== General Logs UI Settings
include::general-infra-logs-ui-settings.asciidoc[]

View file

@ -12,6 +12,8 @@ For more {kib} configuration settings, see <<settings>>.
include::apm-settings.asciidoc[]
include::dev-settings.asciidoc[]
include::graph-settings.asciidoc[]
include::infrastructure-ui-settings.asciidoc[]
include::logs-ui-settings.asciidoc[]
include::ml-settings.asciidoc[]
include::reporting-settings.asciidoc[]
include::spaces-settings.asciidoc[]

View file

@ -4,7 +4,7 @@
* you may not use this file except in compliance with the Elastic License.
*/
export const SCALE_FACTOR = 0.6;
export const SCALE_FACTOR = 0.55;
export const MAX_SIZE = Infinity;
export const MIN_SIZE = 24;