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

Add edits for docker module docs #3176

Merged
merged 1 commit into from
Dec 13, 2016
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
2 changes: 1 addition & 1 deletion metricbeat/_meta/beat.full.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ metricbeat.modules:
# Password of hosts. Empty by default
#password: test123

#------------------------------- docker Module -------------------------------
#------------------------------- Docker Module -------------------------------
#- module: docker
#metricsets: ["cpu", "info", "memory", "network", "diskio", "container"]
#hosts: ["unix:///var/run/docker.sock"]
Expand Down
36 changes: 18 additions & 18 deletions metricbeat/docs/fields.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -506,7 +506,7 @@ The document type. Always set to "metricsets".


[[exported-fields-docker]]
== docker Fields
== Docker Fields

experimental[]
Docker stats collected from Docker.
Expand All @@ -516,14 +516,14 @@ Docker stats collected from Docker.
[float]
== docker Fields

docker contains different informations and statistics of docker's containers running
Information and statistics about docker's running containers.



[float]
== container Fields

Docker container metrics
Docker container metrics.



Expand All @@ -532,15 +532,15 @@ Docker container metrics

type: keyword

Executed command in docker container.
Command that was executed in the Docker container.


[float]
=== docker.container.created

type: date

Date then the container was created.
Date when the container was created.


[float]
Expand Down Expand Up @@ -595,13 +595,13 @@ Total size of all the files in the container.

type: long

Size of the files which have been created or changed since creation.
Size of the files that have been created or changed since creation.


[float]
== cpu Fields

Runtime cpu metrics.
Runtime CPU metrics.



Expand All @@ -612,15 +612,15 @@ type: scaled_float

format: percentage

The system kernel consumed by The Docker server.
The system kernel consumed by the Docker server.


[float]
=== docker.cpu.kernel.ticks

type: long

Cpu kernel tikcs
CPU kernel ticks.


[float]
Expand All @@ -637,7 +637,7 @@ format: percentage

type: long

Cpu system tikcs
CPU system ticks.


[float]
Expand All @@ -654,7 +654,7 @@ format: percentage

type: long

Cpu user tikcs
CPU user ticks


[float]
Expand All @@ -664,13 +664,13 @@ type: scaled_float

format: percentage

Total cpu usage.
Total CPU usage.


[float]
== diskio Fields

Diskio metrics.
Disk I/O metrics.



Expand All @@ -695,14 +695,14 @@ Number of writes.

type: scaled_float

Reads and writes numbers combined.
Number of reads and writes combined.


[float]
== info Fields

experimental[]
info metrics based on https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/display-system-wide-information
Info metrics based on https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/display-system-wide-information.



Expand Down Expand Up @@ -750,7 +750,7 @@ Total number of existing containers.

type: keyword

Unique docker host identifier.
Unique Docker host identifier.


[float]
Expand Down Expand Up @@ -789,7 +789,7 @@ Memory limit.
[float]
== rss Fields

Rss memory stats.
RSS memory stats.



Expand Down Expand Up @@ -849,7 +849,7 @@ Total memory usage.
[float]
== network Fields

Netowrk metrics.
Network metrics.



Expand Down
6 changes: 3 additions & 3 deletions metricbeat/docs/modules/docker.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@ This file is generated! See scripts/docs_collector.py
////

[[metricbeat-module-docker]]
== docker Module
== Docker Module

experimental[]

This is the docker Module.
This module fetches metrics from https://www.docker.com/[Docker] containers.



[float]
=== Example Configuration

The docker module supports the standard configuration options that are described
The Docker module supports the standard configuration options that are described
in <<configuration-metricbeat>>. Here is an example configuration:

[source,yaml]
Expand Down
2 changes: 1 addition & 1 deletion metricbeat/docs/modules_list.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ This file is generated! See scripts/docs_collector.py
////

* <<metricbeat-module-apache,Apache>>
* <<metricbeat-module-docker,docker>>
* <<metricbeat-module-docker,Docker>>
* <<metricbeat-module-haproxy,haproxy>>
* <<metricbeat-module-kafka,kafka>>
* <<metricbeat-module-mongodb,MongoDB>>
Expand Down
2 changes: 1 addition & 1 deletion metricbeat/metricbeat.full.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ metricbeat.modules:
# Password of hosts. Empty by default
#password: test123

#------------------------------- docker Module -------------------------------
#------------------------------- Docker Module -------------------------------
#- module: docker
#metricsets: ["cpu", "info", "memory", "network", "diskio", "container"]
#hosts: ["unix:///var/run/docker.sock"]
Expand Down
4 changes: 2 additions & 2 deletions metricbeat/module/docker/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
== docker Module
== Docker Module

experimental[]

This is the docker Module.
This module fetches metrics from https://www.docker.com/[Docker] containers.

4 changes: 2 additions & 2 deletions metricbeat/module/docker/_meta/fields.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
- key: docker
title: "docker"
title: "Docker"
description: >
experimental[]

Expand All @@ -9,5 +9,5 @@
- name: docker
type: group
description: >
docker contains different informations and statistics of docker's containers running
Information and statistics about docker's running containers.
fields:
5 changes: 3 additions & 2 deletions metricbeat/module/docker/container/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
=== docker container MetricSet
=== Docker Container Metricset

This is the container metricset of the module docker.
The Docker `container` metricset collects information and statistics about
running Docker containers.
8 changes: 4 additions & 4 deletions metricbeat/module/docker/container/_meta/fields.yml
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
- name: container
type: group
description: >
Docker container metrics
Docker container metrics.
fields:
- name: command
type: keyword
description: >
Executed command in docker container.
Command that was executed in the Docker container.
- name: created
type: date
description: >
Date then the container was created.
Date when the container was created.
- name: id
type: keyword
description: >
Expand Down Expand Up @@ -39,4 +39,4 @@
- name: rw
type: long
description: >
Size of the files which have been created or changed since creation.
Size of the files that have been created or changed since creation.
4 changes: 2 additions & 2 deletions metricbeat/module/docker/cpu/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
=== docker cpu MetricSet
=== Docker CPU Metricset

This is the cpu metricset of the module docker.
The Docker `cpu` metricset collects runtime CPU metrics.
12 changes: 6 additions & 6 deletions metricbeat/module/docker/cpu/_meta/fields.yml
Original file line number Diff line number Diff line change
@@ -1,38 +1,38 @@
- name: cpu
type: group
description: >
Runtime cpu metrics.
Runtime CPU metrics.
fields:
- name: kernel.pct
type: scaled_float
format: percentage
description: >
The system kernel consumed by The Docker server.
The system kernel consumed by the Docker server.
- name: kernel.ticks
type: long
description: >
Cpu kernel tikcs
CPU kernel ticks.
- name: system.pct
type: scaled_float
format: percentage
description: >
- name: system.ticks
type: long
description: >
Cpu system tikcs
CPU system ticks.
- name: user.pct
type: scaled_float
format: percentage
description: >
- name: user.ticks
type: long
description: >
Cpu user tikcs
CPU user ticks
- name: total.pct
type: scaled_float
format: percentage
description: >
Total cpu usage.
Total CPU usage.
# TODO: how to document cpu list?
#- name: core
# type: list
Expand Down
4 changes: 2 additions & 2 deletions metricbeat/module/docker/diskio/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
=== docker diskio MetricSet
=== Docker Diskio Metricset

This is the diskio metricset of the module docker.
The Docker `diskio` metricset collects disk I/O metrics.
4 changes: 2 additions & 2 deletions metricbeat/module/docker/diskio/_meta/fields.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
- name: diskio
type: group
description: >
Diskio metrics.
Disk I/O metrics.
fields:
- name: reads
type: scaled_float
Expand All @@ -14,4 +14,4 @@
- name: total
type: scaled_float
description: >
Reads and writes numbers combined.
Number of reads and writes combined.
5 changes: 3 additions & 2 deletions metricbeat/module/docker/info/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
=== docker info MetricSet
=== Docker Info Metricset

This is the info metricset of the module docker.
The Docker `info` metricset collects system-wide information based on the
https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/display-system-wide-information[Docker Remote API].
4 changes: 2 additions & 2 deletions metricbeat/module/docker/info/_meta/fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
description: >
experimental[]

info metrics based on https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/display-system-wide-information
Info metrics based on https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/display-system-wide-information.
fields:
- name: containers
type: group
Expand All @@ -29,7 +29,7 @@
- name: id
type: keyword
description: >
Unique docker host identifier.
Unique Docker host identifier.

- name: images
type: long
Expand Down
4 changes: 2 additions & 2 deletions metricbeat/module/docker/memory/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
=== docker memory MetricSet
=== Docker Memory Metricset

This is the memory metricset of the module docker.
The Docker `memory` metricset collects memory metrics.
2 changes: 1 addition & 1 deletion metricbeat/module/docker/memory/_meta/fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
- name: rss
type: group
description: >
Rss memory stats.
RSS memory stats.
fields:
- name: total
type: long
Expand Down
4 changes: 2 additions & 2 deletions metricbeat/module/docker/network/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
=== docker network MetricSet
=== Docker Network Metricset

This is the network metricset of the module docker.
The Docker `network` metricset collects network metrics.
2 changes: 1 addition & 1 deletion metricbeat/module/docker/network/_meta/fields.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
- name: network
type: group
description: >
Netowrk metrics.
Network metrics.
fields:

- name: interface
Expand Down