Skip to content

Commit

Permalink
Docker module for Metricbeat
Browse files Browse the repository at this point in the history
All credit for this module goes to @douaejeouit and Ingensi. See #2444
  • Loading branch information
douaejeouit authored and ruflin committed Sep 23, 2016
1 parent 6d2eae7 commit 60d4eb2
Show file tree
Hide file tree
Showing 393 changed files with 117,898 additions and 2,537 deletions.
97 changes: 97 additions & 0 deletions metricbeat/docs/fields.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ grouped in the following categories:
* <<exported-fields-beat>>
* <<exported-fields-beats>>
* <<exported-fields-common>>
* <<exported-fields-docker>>
* <<exported-fields-haproxy>>
* <<exported-fields-mongodb>>
* <<exported-fields-mysql>>
Expand Down Expand Up @@ -700,6 +701,102 @@ required: True
The document type. Always set to "metricsets".


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

Docker stats collected from Docker.



[float]
== docker Fields

docker contains different informations and statistics of docker's containers running



[float]
== container Fields

container



[float]
=== docker.container.example

type: keyword

Example field


[float]
== cpu Fields

Runtime cpu metrics



[float]
== cpu Fields

CPU statistics of the running container



[float]
=== docker.cpu.cpu.usage_in_user_mode

type: float

The system user mode consumed by The Docker server.


[float]
== diskio Fields

diskio



[float]
=== docker.diskio.example

type: keyword

Example field


[float]
== memory Fields

memory



[float]
=== docker.memory.example

type: keyword

Example field


[float]
== network Fields

network



[float]
=== docker.network.example

type: keyword

Example field


[[exported-fields-haproxy]]
== haproxy Fields

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

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

This is the docker Module.



[float]
=== Example Configuration

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

[source,yaml]
----
metricbeat.modules:
- module: docker
metricsets: ["cpu","memory","network","diskio","container"]
enabled: true
period: 5s
hosts: ["localhost"]
socket: unix:///var/run/docker.sock
# If dockerbeat has to deal with a TLS-enabled docker daemon, you need to enable TLS and configure path for key and certificates.
tls:
# By default, TLS is disabled
enable: false
----

[float]
=== Metricsets

The following metricsets are available:

* <<metricbeat-metricset-docker-container,container>>

* <<metricbeat-metricset-docker-cpu,cpu>>

* <<metricbeat-metricset-docker-diskio,diskio>>

* <<metricbeat-metricset-docker-memory,memory>>

* <<metricbeat-metricset-docker-network,network>>

include::docker/container.asciidoc[]

include::docker/cpu.asciidoc[]

include::docker/diskio.asciidoc[]

include::docker/memory.asciidoc[]

include::docker/network.asciidoc[]

19 changes: 19 additions & 0 deletions metricbeat/docs/modules/docker/container.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
////
This file is generated! See scripts/docs_collector.py
////

[[metricbeat-metricset-docker-container]]
include::../../../module/docker/container/_meta/docs.asciidoc[]


==== Fields

For a description of each field in the metricset, see the
<<exported-fields-docker,exported fields>> section.

Here is an example document generated by this metricset:

[source,json]
----
include::../../../module/docker/container/_meta/data.json[]
----
19 changes: 19 additions & 0 deletions metricbeat/docs/modules/docker/cpu.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
////
This file is generated! See scripts/docs_collector.py
////

[[metricbeat-metricset-docker-cpu]]
include::../../../module/docker/cpu/_meta/docs.asciidoc[]


==== Fields

For a description of each field in the metricset, see the
<<exported-fields-docker,exported fields>> section.

Here is an example document generated by this metricset:

[source,json]
----
include::../../../module/docker/cpu/_meta/data.json[]
----
19 changes: 19 additions & 0 deletions metricbeat/docs/modules/docker/diskio.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
////
This file is generated! See scripts/docs_collector.py
////

[[metricbeat-metricset-docker-diskio]]
include::../../../module/docker/diskio/_meta/docs.asciidoc[]


==== Fields

For a description of each field in the metricset, see the
<<exported-fields-docker,exported fields>> section.

Here is an example document generated by this metricset:

[source,json]
----
include::../../../module/docker/diskio/_meta/data.json[]
----
19 changes: 19 additions & 0 deletions metricbeat/docs/modules/docker/memory.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
////
This file is generated! See scripts/docs_collector.py
////

[[metricbeat-metricset-docker-memory]]
include::../../../module/docker/memory/_meta/docs.asciidoc[]


==== Fields

For a description of each field in the metricset, see the
<<exported-fields-docker,exported fields>> section.

Here is an example document generated by this metricset:

[source,json]
----
include::../../../module/docker/memory/_meta/data.json[]
----
19 changes: 19 additions & 0 deletions metricbeat/docs/modules/docker/network.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
////
This file is generated! See scripts/docs_collector.py
////

[[metricbeat-metricset-docker-network]]
include::../../../module/docker/network/_meta/docs.asciidoc[]


==== Fields

For a description of each field in the metricset, see the
<<exported-fields-docker,exported fields>> section.

Here is an example document generated by this metricset:

[source,json]
----
include::../../../module/docker/network/_meta/data.json[]
----
13 changes: 13 additions & 0 deletions metricbeat/etc/beat.full.yml
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,19 @@ metricbeat.modules:
#vars_path: /debug/vars


#------------------------------- docker Module -------------------------------
- module: docker
metricsets: ["cpu","memory","network","diskio","container"]
enabled: true
period: 5s
hosts: ["localhost"]
socket: unix:///var/run/docker.sock

# If dockerbeat has to deal with a TLS-enabled docker daemon, you need to enable TLS and configure path for key and certificates.
tls:
# By default, TLS is disabled
enable: false

#------------------------------- haproxy Module ------------------------------
#- module: haproxy
#metricsets: [stat, info]
Expand Down
13 changes: 13 additions & 0 deletions metricbeat/etc/beat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,17 @@ metricbeat.modules:
period: 10s
processes: ['.*']

#------------------------------- docker Module -------------------------------
- module: docker
metricsets: ["cpu","memory","network","diskio","container"]
enabled: true
period: 5s
hosts: ["localhost"]
socket: unix:///var/run/docker.sock

# If dockerbeat has to deal with a TLS-enabled docker daemon, you need to enable TLS and configure path for key and certificates.
tls:
# By default, TLS is disabled
enable: false


Loading

0 comments on commit 60d4eb2

Please sign in to comment.