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

[DOCS] Split fields and metrics content in Metrics monitoring guide #1210

Merged
merged 1 commit into from
Jun 30, 2020
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions docs/en/metrics/aws-ec2-metricset.asciidoc
Original file line number Diff line number Diff line change
@@ -1,14 +1,7 @@
[[aws-ec2-metricset]]
[role="xpack"]

=== AWS EC2 Instance Fields

*ID*:: `cloud.instance.id`
*Name*:: `cloud.instance.name`
*IP Address*:: `aws.ec2.instance.public.ip`

[float]
=== AWS ECS Instance Metrics
== AWS ECS Instance metrics

*CPU Usage*:: Average of `aws.ec2.cpu.total.pct`

Expand All @@ -20,3 +13,6 @@

*Disk Writes (Bytes)*:: Average of `aws.ec2.diskio.write.bytes_per_sec`


For information about which required fields the {metrics-app} uses to display EC2 instance metrics, see the <<metrics-fields-reference, metrics field reference>>.

11 changes: 4 additions & 7 deletions docs/en/metrics/aws-rds-metricset.asciidoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
[[aws-rds-metricset]]
[role="xpack"]

=== AWS RDS Database Fields

*ID*:: `aws.rds.db_instance.arn`
*Name*:: `aws.rds.db_instance.identifier`

[float]
=== AWS RDS Database Metrics
== AWS RDS database metrics

*CPU Usage*:: Average of `aws.rds.cpu.total.pct`

Expand All @@ -19,3 +13,6 @@

*Latency*:: Average of `aws.rds.latency.dml`


For information about which required fields the {metrics-app} uses to display RDS database metrics, see the <<metrics-fields-reference, metrics field reference>>.

11 changes: 4 additions & 7 deletions docs/en/metrics/aws-s3-metricset.asciidoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
[[aws-s3-metricset]]
[role="xpack"]

=== AWS S3 Bucket Fields

*ID*:: `aws.s3.bucket.name`
*Name*:: `aws.s3.bucket.name`

[float]
=== AWS S3 Bucket Metrics
== AWS S3 bucket metrics

*Bucket Size*:: Average of `aws.s3_daily_storage.bucket.size.bytes`

Expand All @@ -19,3 +13,6 @@

*Uploads (Bytes)*:: Average of `aws.s3_request.uploaded.bytes`


For information about which required fields the {metrics-app} uses to display S3 bucket metrics, see the <<metrics-fields-reference, metrics field reference>>.

9 changes: 2 additions & 7 deletions docs/en/metrics/aws-sqs-metricset.asciidoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
[[aws-sqs-metricset]]
[role="xpack"]

=== AWS SQS Queue Fields

*ID*:: `aws.sqs.queue.name`
*Name*:: `aws.sqs.queue.name`

[float]
=== AWS SQS Queue Metrics
== AWS SQS queue metrics

*Messages Available*:: Max of `aws.sqs.messages.visible`

Expand All @@ -20,3 +14,4 @@
*Oldest Message*:: Max of `aws.sqs.oldest_message_age.sec`


For information about which required fields the {metrics-app} uses to display SQS queue metrics, see the <<metrics-fields-reference, metrics field reference>>.
12 changes: 4 additions & 8 deletions docs/en/metrics/docker-metricset.asciidoc
Original file line number Diff line number Diff line change
@@ -1,14 +1,7 @@
[[docker-metricset]]
[role="xpack"]

=== Docker Container Fields

*ID*:: `container.id`
*Name*:: `container.name`
*IP Address*:: `container.ip_address`

[float]
=== Docker Container Metrics
== Docker container metrics

*CPU Usage*:: Average of `docker.cpu.total.pct`

Expand All @@ -17,3 +10,6 @@
*Inbound Traffic*:: Derivative of the maximum of `docker.network.in.bytes` scaled to a 1 second rate

*Outbound Traffic*:: Derivative of the maximum of `docker.network.out.bytes` scaled to a 1 second rate


For information about which required fields the {metrics-app} uses to display Docker metrics, see the <<metrics-fields-reference, metrics field reference>>.
11 changes: 3 additions & 8 deletions docs/en/metrics/host-metricset.asciidoc
Original file line number Diff line number Diff line change
@@ -1,14 +1,7 @@
[[host-metricset]]
[role="xpack"]

=== Hosts Fields

*ID*:: `host.name`
*Name*:: `host.name`
*IP Address*:: `host.ip`

[float]
=== Host Metrics
== Host metrics

*CPU Usage*:: Average of `system.cpu.user.pct` added to the average of `system.cpu.system.pct` divided by `system.cpu.cores`

Expand All @@ -22,3 +15,5 @@

*Log Rate*:: Derivative of the cumulative sum of the document count scaled to a 1 second rate.
This metric relies on the same indices as the logs.

For information about which required fields the {metrics-app} uses to display host metrics, see the <<metrics-fields-reference, metrics field reference>>.
7 changes: 5 additions & 2 deletions docs/en/metrics/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ include::metrics-overview.asciidoc[]

include::metrics-installation.asciidoc[]

include::infrastructure-metrics.asciidoc[]

include::metrics-app-overview.asciidoc[]

include::configuring-metrics-source.asciidoc[]
Expand All @@ -25,3 +23,8 @@ include::explore-metrics-data.asciidoc[]
include::metrics-explorer.asciidoc[]

include::metrics-alerting.asciidoc[]

include::metrics-fields-reference.asciidoc[]

include::infrastructure-metrics.asciidoc[]

24 changes: 10 additions & 14 deletions docs/en/metrics/infrastructure-metrics.asciidoc
Original file line number Diff line number Diff line change
@@ -1,24 +1,20 @@
[[infrastructure-metrics]]
[role="xpack"]

== Infrastructure metrics
= Infrastructure metrics

This section contains detailed information about each of the metricsets the {metrics-app} supports. The metrics listed below are provided by the {beats} shippers.
This section contains detailed information about each of the metricsets the {metrics-app} supports.

* <<host-metricset, Hosts>>
* <<docker-metricset, Docker Containers>>
* <<kubernetes-metricset, Kubernetes Pods>>
* <<aws-ec2-metricset, AWS EC2 Instances>>
* <<aws-s3-metricset, AWS S3 Buckets>>
* <<aws-rds-metricset, AWS RDS Databases>>
* <<aws-sqs-metricset, AWS SQS Queues>>

[float]
=== Additional field details
The metrics listed below are provided by the {beats} shippers.

To display data properly in some views, the `event.dataset` field is required. This field is a combination of `metricset.module`, which is the Metricbeat module name, and `metricset.name`, which is the metricset name.
* <<host-metricset, Hosts>>
* <<docker-metricset, Docker containers>>
* <<kubernetes-metricset, Kubernetes pods>>
* <<aws-ec2-metricset, AWS EC2 instances>>
* <<aws-s3-metricset, AWS S3 buckets>>
* <<aws-rds-metricset, AWS RDS databases>>
* <<aws-sqs-metricset, AWS SQS queues>>

To determine the optimal time interval for each metric, all of the charts use the `metricset.period`. If `metricset.period` is not available then it falls back to 1 minute intervals.

include::host-metricset.asciidoc[]

Expand Down
12 changes: 4 additions & 8 deletions docs/en/metrics/kubernetes-metricset.asciidoc
Original file line number Diff line number Diff line change
@@ -1,14 +1,7 @@
[[kubernetes-metricset]]
[role="xpack"]

=== Kubernetes Pod Fields

*ID*:: `kubernetes.pod.uid`
*Name*:: `kubernetes.pod.name`
*IP Address*:: `kubernetes.pod.ip`

[float]
=== Kubernetes Pod Metrics
== Kubernetes pod metrics

*CPU Usage*:: Average of `kubernetes.pod.cpu.usage.node.pct`

Expand All @@ -17,3 +10,6 @@
*Inbound Traffic*:: Derivative of the maximum of `kubernetes.pod.network.rx.bytes` scaled to a 1 second rate

*Outbound Traffic*:: Derivative of the maximum of `kubernetes.pod.network.tx.bytes` scaled to a 1 second rate


For information about which required fields the {metrics-app} uses to display Kubernetes metrics, see the <<metrics-fields-reference, metrics field reference>>.
Loading