Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[InfraOps] Update docs with data source configuration #26579

Merged
merged 16 commits into from Jan 9, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/infrastructure/index.asciidoc
Expand Up @@ -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[]
Expand Down
6 changes: 5 additions & 1 deletion docs/logs/index.asciidoc
Expand Up @@ -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.

--

Expand Down
2 changes: 1 addition & 1 deletion docs/logs/logs-ui.asciidoc
Expand Up @@ -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]
Expand Down
17 changes: 17 additions & 0 deletions docs/settings/general-infra-logs-ui-settings.asciidoc
@@ -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`.
14 changes: 14 additions & 0 deletions docs/settings/infrastructure-ui-settings.asciidoc
@@ -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[]
14 changes: 14 additions & 0 deletions docs/settings/logs-ui-settings.asciidoc
@@ -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[]
2 changes: 2 additions & 0 deletions docs/settings/settings-xkb.asciidoc
Expand Up @@ -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[]
Expand Up @@ -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;

Expand Down