Skip to content

Commit

Permalink
Update metricbeat full config to have all modules disabled
Browse files Browse the repository at this point in the history
Currently modules in the full config were disabled by commenting it out. Unfortunately we were not very consistent in the commenting style and some were missing the comments which enabled some of the modules.

Having the configs commented out also meant they are commented out in the documentation as the same config files are used to generate the docs.

Only system module has a short config as it is the one enabled by default. For all the other modules I merged removed the short config as we should come up with one as soon as we need it, means it's in the short config. So the full config files for the modules were removed and merged into the short one.

This change in the full config will also simplify copy / paste of config options for adding it to the short config. Only thing that has to be changed is the enabled flag.

Experimental log message and note are now added to each new metricset by default.
  • Loading branch information
ruflin committed Apr 20, 2017
1 parent f8a6877 commit a425890
Show file tree
Hide file tree
Showing 52 changed files with 396 additions and 374 deletions.
2 changes: 1 addition & 1 deletion metricbeat/docs/modules/apache.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ in <<configuration-metricbeat>>. Here is an example configuration:
metricbeat.modules:
- module: apache
metricsets: ["status"]
enabled: true
enabled: false
period: 10s
# Apache hosts
Expand Down
10 changes: 5 additions & 5 deletions metricbeat/docs/modules/ceph.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ in <<configuration-metricbeat>>. Here is an example configuration:
[source,yaml]
----
metricbeat.modules:
#- module: ceph
# metricsets: ["cluster_disk", "cluster_health", "monitor_health", "pool_disk"]
# enabled: true
# period: 10s
# hosts: ["localhost:5000"]
- module: ceph
metricsets: ["cluster_disk", "cluster_health", "monitor_health", "pool_disk"]
enabled: false
period: 10s
hosts: ["localhost:5000"]
----

[float]
Expand Down
10 changes: 5 additions & 5 deletions metricbeat/docs/modules/couchbase.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ in <<configuration-metricbeat>>. Here is an example configuration:
[source,yaml]
----
metricbeat.modules:
#- module: couchbase
#metricsets: ["cluster", "node", "bucket"]
#enabled: true
#period: 10s
#hosts: ["localhost:8091"]
- module: couchbase
metricsets: ["bucket", "cluster", "node"]
enabled: false
period: 10s
hosts: ["localhost:8091"]
----

[float]
Expand Down
10 changes: 5 additions & 5 deletions metricbeat/docs/modules/docker.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ in <<configuration-metricbeat>>. Here is an example configuration:
[source,yaml]
----
metricbeat.modules:
#- module: docker
#metricsets: ["container", "cpu", "diskio", "healthcheck", "info", "memory", "network"]
#hosts: ["unix:///var/run/docker.sock"]
#enabled: true
#period: 10s
- module: docker
metricsets: ["container", "cpu", "diskio", "healthcheck", "info", "memory", "network"]
hosts: ["unix:///var/run/docker.sock"]
enabled: false
period: 10s
# To connect to Docker over TLS you must specify a client and CA certificate.
#ssl:
Expand Down
14 changes: 7 additions & 7 deletions metricbeat/docs/modules/dropwizard.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ in <<configuration-metricbeat>>. Here is an example configuration:
[source,yaml]
----
metricbeat.modules:
#- module: dropwizard
#metricsets: ["collector"]
#enabled: true
#period: 10s
#hosts: ["localhost:8080"]
#metrics_path: /metrics/metrics
#namespace: example
- module: dropwizard
metricsets: ["collector"]
enabled: false
period: 10s
hosts: ["localhost:8080"]
metrics_path: /metrics/metrics
namespace: example
----

[float]
Expand Down
10 changes: 5 additions & 5 deletions metricbeat/docs/modules/elasticsearch.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ in <<configuration-metricbeat>>. Here is an example configuration:
[source,yaml]
----
metricbeat.modules:
#- module: elasticsearch
# metricsets: ["node", "node_stats", "stats"]
# enabled: true
# period: 10s
# hosts: ["localhost:9200"]
- module: elasticsearch
metricsets: ["node", "node_stats", "stats"]
enabled: false
period: 10s
hosts: ["localhost:9200"]
----

Expand Down
18 changes: 9 additions & 9 deletions metricbeat/docs/modules/golang.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@ in <<configuration-metricbeat>>. Here is an example configuration:
[source,yaml]
----
metricbeat.modules:
#- module: golang
# metricsets: ["expvar","heap"]
# enabled: true
# period: 10s
# hosts: ["localhost:6060"]
# heap.path: "/debug/vars"
# expvar:
# namespace: "example"
# path: "/debug/vars"
- module: golang
metricsets: ["expvar","heap"]
enabled: false
period: 10s
hosts: ["localhost:6060"]
heap.path: "/debug/vars"
expvar:
namespace: "example"
path: "/debug/vars"
----

[float]
Expand Down
2 changes: 1 addition & 1 deletion metricbeat/docs/modules/haproxy.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ in <<configuration-metricbeat>>. Here is an example configuration:
metricbeat.modules:
- module: haproxy
metricsets: ["info", "stat"]
enabled: true
enabled: false
period: 10s
hosts: ["tcp://127.0.0.1:14567"]
----
Expand Down
20 changes: 10 additions & 10 deletions metricbeat/docs/modules/jolokia.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,16 @@ in <<configuration-metricbeat>>. Here is an example configuration:
[source,yaml]
----
metricbeat.modules:
#- module: jolokia
# metricsets: ["jmx"]
# enabled: true
# period: 10s
# hosts: ["localhost"]
# namespace: "metrics"
# path: "/jolokia/?ignoreErrors=true&canonicalNaming=false"
# jmx.mapping:
# jmx.application:
# jmx.instance:
- module: jolokia
metricsets: ["jmx"]
enabled: false
period: 10s
hosts: ["localhost"]
namespace: "metrics"
path: "/jolokia/?ignoreErrors=true&canonicalNaming=false"
jmx.mapping:
jmx.application:
jmx.instance:
----

[float]
Expand Down
10 changes: 5 additions & 5 deletions metricbeat/docs/modules/kafka.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ in <<configuration-metricbeat>>. Here is an example configuration:
[source,yaml]
----
metricbeat.modules:
#- module: kafka
#metricsets: ["partition"]
#enabled: true
#period: 10s
#hosts: ["localhost:9092"]
- module: kafka
metricsets: ["partition"]
enabled: false
period: 10s
hosts: ["localhost:9092"]
#client_id: metricbeat
#retries: 3
Expand Down
2 changes: 1 addition & 1 deletion metricbeat/docs/modules/kibana.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ in <<configuration-metricbeat>>. Here is an example configuration:
metricbeat.modules:
- module: kibana
metricsets: ["status"]
enabled: true
enabled: false
period: 10s
hosts: ["localhost:5601"]
Expand Down
10 changes: 5 additions & 5 deletions metricbeat/docs/modules/kubelet.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ in <<configuration-metricbeat>>. Here is an example configuration:
[source,yaml]
----
metricbeat.modules:
#- module: kubelet
# metricsets: ["node","container","volume","pod","system"]
# enabled: true
# period: 10s
# hosts: ["localhost:10255"]
- module: kubelet
metricsets: ["node","container","volume","pod","system"]
enabled: false
period: 10s
hosts: ["localhost:10255"]
----

Expand Down
2 changes: 1 addition & 1 deletion metricbeat/docs/modules/memcached.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ in <<configuration-metricbeat>>. Here is an example configuration:
metricbeat.modules:
- module: memcached
metricsets: ["stats"]
enabled: true
enabled: false
period: 10s
hosts: ["localhost:11211"]
Expand Down
10 changes: 5 additions & 5 deletions metricbeat/docs/modules/mongodb.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -63,17 +63,17 @@ in <<configuration-metricbeat>>. Here is an example configuration:
[source,yaml]
----
metricbeat.modules:
#- module: mongodb
#metricsets: ["dbstats", "status"]
#enabled: true
#period: 10s
- module: mongodb
metricsets: ["dbstats", "status"]
enabled: false
period: 10s
# The hosts must be passed as MongoDB URLs in the format:
# [mongodb://][user:pass@]host[:port].
# The username and password can also be set using the respective configuration
# options. The credentials in the URL take precedence over the username and
# password configuration options.
#hosts: ["localhost:27017"]
hosts: ["localhost:27017"]
# Username to use when connecting to MongoDB. Empty by default.
#username: user
Expand Down
11 changes: 10 additions & 1 deletion metricbeat/docs/modules/mysql.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,22 @@ in <<configuration-metricbeat>>. Here is an example configuration:
metricbeat.modules:
- module: mysql
metricsets: ["status"]
enabled: true
enabled: false
period: 10s
# Host DSN should be defined as "user:pass@tcp(127.0.0.1:3306)/"
# The username and password can either be set in the DSN or using the username
# and password config options. Those specified in the DSN take precedence.
hosts: ["root:secret@tcp(127.0.0.1:3306)/"]
# Username of hosts. Empty by default.
#username: root
# Password of hosts. Empty by default.
#password: secret
# By setting raw to true, all raw fields from the status metricset will be added to the event.
#raw: false
----

[float]
Expand Down
5 changes: 4 additions & 1 deletion metricbeat/docs/modules/nginx.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,14 @@ in <<configuration-metricbeat>>. Here is an example configuration:
metricbeat.modules:
- module: nginx
metricsets: ["stubstatus"]
enabled: true
enabled: false
period: 10s
# Nginx hosts
hosts: ["http://127.0.0.1"]
# Path to server status. Default server-status
#server_status_path: "server-status"
----

[float]
Expand Down
12 changes: 6 additions & 6 deletions metricbeat/docs/modules/php_fpm.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,12 @@ in <<configuration-metricbeat>>. Here is an example configuration:
[source,yaml]
----
metricbeat.modules:
#- module: php_fpm
#metricsets: ["pool"]
#enabled: true
#period: 10s
#status_path: "/status"
#hosts: ["localhost:8080"]
- module: php_fpm
metricsets: ["pool"]
enabled: false
period: 10s
status_path: "/status"
hosts: ["localhost:8080"]
----

[float]
Expand Down
16 changes: 8 additions & 8 deletions metricbeat/docs/modules/postgresql.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -63,25 +63,25 @@ in <<configuration-metricbeat>>. Here is an example configuration:
[source,yaml]
----
metricbeat.modules:
#- module: postgresql
#metricsets:
- module: postgresql
metricsets:
# Stats about every PostgreSQL database
#- database
- database
# Stats about the background writer process's activity
#- bgwriter
- bgwriter
# Stats about every PostgreSQL process
#- activity
- activity
#enabled: true
#period: 10s
enabled: false
period: 10s
# The host must be passed as PostgreSQL URL. Example:
# postgres://localhost:5432?sslmode=disable
# The available parameters are documented here:
# https://godoc.org/github.com/lib/pq#hdr-Connection_String_Parameters
#hosts: ["postgres://localhost:5432"]
hosts: ["postgres://localhost:5432"]
# Username to use when connecting to PostgreSQL. Empty by default.
#username: user
Expand Down
12 changes: 6 additions & 6 deletions metricbeat/docs/modules/prometheus.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ in <<configuration-metricbeat>>. Here is an example configuration:
[source,yaml]
----
metricbeat.modules:
#- module: prometheus
#metricsets: ["stats"]
#enabled: true
#period: 10s
#hosts: ["localhost:9090"]
#metrics_path: /metrics
- module: prometheus
metricsets: ["stats"]
enabled: false
period: 10s
hosts: ["localhost:9090"]
metrics_path: /metrics
#namespace: example
----

Expand Down
27 changes: 25 additions & 2 deletions metricbeat/docs/modules/redis.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,35 @@ in <<configuration-metricbeat>>. Here is an example configuration:
----
metricbeat.modules:
- module: redis
metricsets: ["info"]
enabled: true
metricsets: ["info", "keyspace"]
enabled: false
period: 10s
# Redis hosts
hosts: ["127.0.0.1:6379"]
# Timeout after which time a metricset should return an error
# Timeout is by default defined as period, as a fetch of a metricset
# should never take longer then period, as otherwise calls can pile up.
#timeout: 1s
# Optional fields to be added to each event
#fields:
# datacenter: west
# Network type to be used for redis connection. Default: tcp
#network: tcp
# Max number of concurrent connections. Default: 10
#maxconn: 10
# Filters can be used to reduce the number of fields sent.
#filters:
# - include_fields:
# fields: ["stats"]
# Redis AUTH password. Empty by default.
#password: foobared
----

[float]
Expand Down
Loading

0 comments on commit a425890

Please sign in to comment.