From 0a85fcecb05e6312a2dbbb6ad8f842335ba79838 Mon Sep 17 00:00:00 2001 From: Tudor Golubenco Date: Wed, 23 May 2018 11:29:24 +0200 Subject: [PATCH] Document username/password options for HTTP based modules (#7134) This adds commented out `username` and `password` settings to most of the config places where they are supported (this part is manual). Since those configs are included in the docs, they also show up there. This also adds a line in the docs that link to "HTTP specific settings" (this part is automatised during `make update`). Completes #4268 and closes #6493. --- metricbeat/docs/metricbeat-options.asciidoc | 22 ++++++++++++++++--- metricbeat/docs/modules/apache.asciidoc | 2 +- metricbeat/docs/modules/ceph.asciidoc | 2 +- metricbeat/docs/modules/couchbase.asciidoc | 2 +- metricbeat/docs/modules/dropwizard.asciidoc | 2 +- .../docs/modules/elasticsearch.asciidoc | 2 +- metricbeat/docs/modules/etcd.asciidoc | 2 +- metricbeat/docs/modules/golang.asciidoc | 2 +- metricbeat/docs/modules/http.asciidoc | 4 +++- metricbeat/docs/modules/jolokia.asciidoc | 4 +++- metricbeat/docs/modules/kibana.asciidoc | 2 +- metricbeat/docs/modules/kubernetes.asciidoc | 2 +- metricbeat/docs/modules/logstash.asciidoc | 2 +- metricbeat/docs/modules/nginx.asciidoc | 2 +- metricbeat/docs/modules/php_fpm.asciidoc | 2 +- metricbeat/docs/modules/prometheus.asciidoc | 2 +- metricbeat/docs/modules/rabbitmq.asciidoc | 2 +- metricbeat/metricbeat.reference.yml | 4 ++++ metricbeat/module/apache/_meta/config.yml | 2 ++ metricbeat/module/ceph/_meta/config.yml | 2 ++ metricbeat/module/couchbase/_meta/config.yml | 2 ++ metricbeat/module/dropwizard/_meta/config.yml | 2 ++ .../module/elasticsearch/_meta/config.yml | 2 ++ metricbeat/module/etcd/_meta/config.yml | 2 ++ metricbeat/module/http/_meta/config.yml | 2 ++ metricbeat/module/jolokia/_meta/config.yml | 2 ++ metricbeat/module/kibana/_meta/config.yml | 2 ++ metricbeat/module/kubernetes/_meta/config.yml | 2 ++ metricbeat/module/logstash/_meta/config.yml | 2 ++ metricbeat/module/nginx/_meta/config.yml | 3 +++ metricbeat/module/php_fpm/_meta/config.yml | 2 ++ metricbeat/module/prometheus/_meta/config.yml | 2 ++ metricbeat/modules.d/apache.yml.disabled | 2 ++ metricbeat/modules.d/ceph.yml.disabled | 2 ++ metricbeat/modules.d/couchbase.yml.disabled | 2 ++ metricbeat/modules.d/dropwizard.yml.disabled | 2 ++ .../modules.d/elasticsearch.yml.disabled | 2 ++ metricbeat/modules.d/etcd.yml.disabled | 2 ++ metricbeat/modules.d/http.yml.disabled | 2 ++ metricbeat/modules.d/jolokia.yml.disabled | 2 ++ metricbeat/modules.d/kibana.yml.disabled | 2 ++ metricbeat/modules.d/kubernetes.yml.disabled | 2 ++ metricbeat/modules.d/logstash.yml.disabled | 2 ++ metricbeat/modules.d/nginx.yml.disabled | 3 +++ metricbeat/modules.d/php_fpm.yml.disabled | 2 ++ metricbeat/modules.d/prometheus.yml.disabled | 2 ++ metricbeat/scripts/docs_collector.py | 4 +++- 47 files changed, 104 insertions(+), 20 deletions(-) diff --git a/metricbeat/docs/metricbeat-options.asciidoc b/metricbeat/docs/metricbeat-options.asciidoc index 251e681838c3..426dccafd4f6 100644 --- a/metricbeat/docs/metricbeat-options.asciidoc +++ b/metricbeat/docs/metricbeat-options.asciidoc @@ -37,7 +37,7 @@ To see a list of enabled and disabled modules, run: ---- You can change the default module configurations by modifying the `.yml` files -in the `modules.d` directory. +in the `modules.d` directory. The following example shows a basic configuration for the Apache module: @@ -73,7 +73,7 @@ requires the `modules.d` layout. To enable specific modules and metricsets in the +{beatname_lc}.yml+ config file, you can add entries to the +{beatname_lc}.modules+ list. Each entry in the -list begins with a dash (-) and is followed by settings for that module. +list begins with a dash (-) and is followed by settings for that module. The following example shows a configuration where the apache and mysql modules are enabled: @@ -118,7 +118,7 @@ metricbeat.modules: == Configuration combinations You can specify a module configuration that uses different combinations of -metricsets, periods, and hosts. +metricsets, periods, and hosts. For a module with multiple metricsets defined, it's possible to define the module twice and specify a different period to use for each metricset. For the @@ -200,3 +200,19 @@ A list of processors to apply to the data generated by the metricset. See <> for information about specifying processors in your config. +[float] +[[module-http-config-options]] +=== Standard HTTP config options + +The modules and metricsets for which the host is defined as a HTTP URL, also +support the following options: + +[float] +==== `username` + +The username to use for basic authentication. + +[float] +==== `password` + +The password to use for basic authentication. diff --git a/metricbeat/docs/modules/apache.asciidoc b/metricbeat/docs/modules/apache.asciidoc index 81601507cd9a..882cd271f017 100644 --- a/metricbeat/docs/modules/apache.asciidoc +++ b/metricbeat/docs/modules/apache.asciidoc @@ -50,7 +50,7 @@ metricbeat.modules: #password: password ---- -This module supports TLS connection when using `ssl` config field, as described in <>. +This module supports TLS connection when using `ssl` config field, as described in <>. It also supports the options described in <>. [float] === Metricsets diff --git a/metricbeat/docs/modules/ceph.asciidoc b/metricbeat/docs/modules/ceph.asciidoc index f4ab6c19e165..b1d2f75886db 100644 --- a/metricbeat/docs/modules/ceph.asciidoc +++ b/metricbeat/docs/modules/ceph.asciidoc @@ -27,7 +27,7 @@ metricbeat.modules: enabled: true ---- -This module supports TLS connection when using `ssl` config field, as described in <>. +This module supports TLS connection when using `ssl` config field, as described in <>. It also supports the options described in <>. [float] === Metricsets diff --git a/metricbeat/docs/modules/couchbase.asciidoc b/metricbeat/docs/modules/couchbase.asciidoc index f8354b854cbd..c8c47367beb6 100644 --- a/metricbeat/docs/modules/couchbase.asciidoc +++ b/metricbeat/docs/modules/couchbase.asciidoc @@ -27,7 +27,7 @@ metricbeat.modules: enabled: true ---- -This module supports TLS connection when using `ssl` config field, as described in <>. +This module supports TLS connection when using `ssl` config field, as described in <>. It also supports the options described in <>. [float] === Metricsets diff --git a/metricbeat/docs/modules/dropwizard.asciidoc b/metricbeat/docs/modules/dropwizard.asciidoc index 9fe28110c18d..7a110f092926 100644 --- a/metricbeat/docs/modules/dropwizard.asciidoc +++ b/metricbeat/docs/modules/dropwizard.asciidoc @@ -29,7 +29,7 @@ metricbeat.modules: enabled: true ---- -This module supports TLS connection when using `ssl` config field, as described in <>. +This module supports TLS connection when using `ssl` config field, as described in <>. It also supports the options described in <>. [float] === Metricsets diff --git a/metricbeat/docs/modules/elasticsearch.asciidoc b/metricbeat/docs/modules/elasticsearch.asciidoc index ab4d09c6a3ce..4fe4565c87ac 100644 --- a/metricbeat/docs/modules/elasticsearch.asciidoc +++ b/metricbeat/docs/modules/elasticsearch.asciidoc @@ -32,7 +32,7 @@ metricbeat.modules: hosts: ["localhost:9200"] ---- -This module supports TLS connection when using `ssl` config field, as described in <>. +This module supports TLS connection when using `ssl` config field, as described in <>. It also supports the options described in <>. [float] === Metricsets diff --git a/metricbeat/docs/modules/etcd.asciidoc b/metricbeat/docs/modules/etcd.asciidoc index 5a07bcba22de..3b7184424b30 100644 --- a/metricbeat/docs/modules/etcd.asciidoc +++ b/metricbeat/docs/modules/etcd.asciidoc @@ -27,7 +27,7 @@ metricbeat.modules: hosts: ["localhost:2379"] ---- -This module supports TLS connection when using `ssl` config field, as described in <>. +This module supports TLS connection when using `ssl` config field, as described in <>. It also supports the options described in <>. [float] === Metricsets diff --git a/metricbeat/docs/modules/golang.asciidoc b/metricbeat/docs/modules/golang.asciidoc index c662a666534a..843711a76cda 100644 --- a/metricbeat/docs/modules/golang.asciidoc +++ b/metricbeat/docs/modules/golang.asciidoc @@ -31,7 +31,7 @@ metricbeat.modules: path: "/debug/vars" ---- -This module supports TLS connection when using `ssl` config field, as described in <>. +This module supports TLS connection when using `ssl` config field, as described in <>. It also supports the options described in <>. [float] === Metricsets diff --git a/metricbeat/docs/modules/http.asciidoc b/metricbeat/docs/modules/http.asciidoc index 6e1953b233a2..eccfe5207827 100644 --- a/metricbeat/docs/modules/http.asciidoc +++ b/metricbeat/docs/modules/http.asciidoc @@ -34,6 +34,8 @@ metricbeat.modules: path: "/" #body: "" #method: "GET" + #username: "user" + #password: "secret" #request.enabled: false #response.enabled: false #json.is_array: false @@ -52,7 +54,7 @@ metricbeat.modules: # key: "value" ---- -This module supports TLS connection when using `ssl` config field, as described in <>. +This module supports TLS connection when using `ssl` config field, as described in <>. It also supports the options described in <>. [float] === Metricsets diff --git a/metricbeat/docs/modules/jolokia.asciidoc b/metricbeat/docs/modules/jolokia.asciidoc index abf127325dba..6674ed18981f 100644 --- a/metricbeat/docs/modules/jolokia.asciidoc +++ b/metricbeat/docs/modules/jolokia.asciidoc @@ -24,6 +24,8 @@ metricbeat.modules: hosts: ["localhost"] namespace: "metrics" #path: "/jolokia/?ignoreErrors=true&canonicalNaming=false" + #username: "user" + #password: "secret" jmx.mappings: #- mbean: 'java.lang:type=Runtime' # attributes: @@ -47,7 +49,7 @@ metricbeat.modules: jmx.instance: ---- -This module supports TLS connection when using `ssl` config field, as described in <>. +This module supports TLS connection when using `ssl` config field, as described in <>. It also supports the options described in <>. [float] === Metricsets diff --git a/metricbeat/docs/modules/kibana.asciidoc b/metricbeat/docs/modules/kibana.asciidoc index 7f16f9505160..9738817dc5eb 100644 --- a/metricbeat/docs/modules/kibana.asciidoc +++ b/metricbeat/docs/modules/kibana.asciidoc @@ -28,7 +28,7 @@ metricbeat.modules: enabled: default ---- -This module supports TLS connection when using `ssl` config field, as described in <>. +This module supports TLS connection when using `ssl` config field, as described in <>. It also supports the options described in <>. [float] === Metricsets diff --git a/metricbeat/docs/modules/kubernetes.asciidoc b/metricbeat/docs/modules/kubernetes.asciidoc index 27b8b24bba88..a3b8cc2fcc71 100644 --- a/metricbeat/docs/modules/kubernetes.asciidoc +++ b/metricbeat/docs/modules/kubernetes.asciidoc @@ -66,7 +66,7 @@ metricbeat.modules: hosts: ["https://${KUBERNETES_SERVICE_HOST}:${KUBERNETES_SERVICE_PORT}"] ---- -This module supports TLS connection when using `ssl` config field, as described in <>. +This module supports TLS connection when using `ssl` config field, as described in <>. It also supports the options described in <>. [float] === Metricsets diff --git a/metricbeat/docs/modules/logstash.asciidoc b/metricbeat/docs/modules/logstash.asciidoc index 98e8d414cc53..999fee81aa33 100644 --- a/metricbeat/docs/modules/logstash.asciidoc +++ b/metricbeat/docs/modules/logstash.asciidoc @@ -28,7 +28,7 @@ metricbeat.modules: hosts: ["localhost:9600"] ---- -This module supports TLS connection when using `ssl` config field, as described in <>. +This module supports TLS connection when using `ssl` config field, as described in <>. It also supports the options described in <>. [float] === Metricsets diff --git a/metricbeat/docs/modules/nginx.asciidoc b/metricbeat/docs/modules/nginx.asciidoc index 367fdf05180b..b0d1022ace85 100644 --- a/metricbeat/docs/modules/nginx.asciidoc +++ b/metricbeat/docs/modules/nginx.asciidoc @@ -45,7 +45,7 @@ metricbeat.modules: server_status_path: "server-status" ---- -This module supports TLS connection when using `ssl` config field, as described in <>. +This module supports TLS connection when using `ssl` config field, as described in <>. It also supports the options described in <>. [float] === Metricsets diff --git a/metricbeat/docs/modules/php_fpm.asciidoc b/metricbeat/docs/modules/php_fpm.asciidoc index 0f485382296c..7c1fde145af0 100644 --- a/metricbeat/docs/modules/php_fpm.asciidoc +++ b/metricbeat/docs/modules/php_fpm.asciidoc @@ -57,7 +57,7 @@ metricbeat.modules: hosts: ["localhost:8080"] ---- -This module supports TLS connection when using `ssl` config field, as described in <>. +This module supports TLS connection when using `ssl` config field, as described in <>. It also supports the options described in <>. [float] === Metricsets diff --git a/metricbeat/docs/modules/prometheus.asciidoc b/metricbeat/docs/modules/prometheus.asciidoc index ad93f7c7ba07..d25d16187264 100644 --- a/metricbeat/docs/modules/prometheus.asciidoc +++ b/metricbeat/docs/modules/prometheus.asciidoc @@ -39,7 +39,7 @@ metricbeat.modules: #namespace: example ---- -This module supports TLS connection when using `ssl` config field, as described in <>. +This module supports TLS connection when using `ssl` config field, as described in <>. It also supports the options described in <>. [float] === Metricsets diff --git a/metricbeat/docs/modules/rabbitmq.asciidoc b/metricbeat/docs/modules/rabbitmq.asciidoc index bfd7f6dff0e0..409f773d24c9 100644 --- a/metricbeat/docs/modules/rabbitmq.asciidoc +++ b/metricbeat/docs/modules/rabbitmq.asciidoc @@ -37,7 +37,7 @@ metricbeat.modules: #password: guest ---- -This module supports TLS connection when using `ssl` config field, as described in <>. +This module supports TLS connection when using `ssl` config field, as described in <>. It also supports the options described in <>. [float] === Metricsets diff --git a/metricbeat/metricbeat.reference.yml b/metricbeat/metricbeat.reference.yml index 78b494ecb25a..56bf33fc6dd5 100644 --- a/metricbeat/metricbeat.reference.yml +++ b/metricbeat/metricbeat.reference.yml @@ -263,6 +263,8 @@ metricbeat.modules: path: "/" #body: "" #method: "GET" + #username: "user" + #password: "secret" #request.enabled: false #response.enabled: false #json.is_array: false @@ -287,6 +289,8 @@ metricbeat.modules: hosts: ["localhost"] namespace: "metrics" #path: "/jolokia/?ignoreErrors=true&canonicalNaming=false" + #username: "user" + #password: "secret" jmx.mappings: #- mbean: 'java.lang:type=Runtime' # attributes: diff --git a/metricbeat/module/apache/_meta/config.yml b/metricbeat/module/apache/_meta/config.yml index 070eec244637..65dc0b5ac747 100644 --- a/metricbeat/module/apache/_meta/config.yml +++ b/metricbeat/module/apache/_meta/config.yml @@ -3,3 +3,5 @@ # - status period: 10s hosts: ["http://127.0.0.1"] + #username: "user" + #password: "secret" diff --git a/metricbeat/module/ceph/_meta/config.yml b/metricbeat/module/ceph/_meta/config.yml index d84cf3c8c5cb..6df14df1d80d 100644 --- a/metricbeat/module/ceph/_meta/config.yml +++ b/metricbeat/module/ceph/_meta/config.yml @@ -5,6 +5,8 @@ # - monitor_health period: 10s hosts: ["localhost:5000"] + #username: "user" + #password: "secret" - module: ceph #metricsets: diff --git a/metricbeat/module/couchbase/_meta/config.yml b/metricbeat/module/couchbase/_meta/config.yml index 74840343019f..ce176b9c8710 100644 --- a/metricbeat/module/couchbase/_meta/config.yml +++ b/metricbeat/module/couchbase/_meta/config.yml @@ -5,3 +5,5 @@ # - node period: 10s hosts: ["localhost:8091"] + #username: "user" + #password: "secret" diff --git a/metricbeat/module/dropwizard/_meta/config.yml b/metricbeat/module/dropwizard/_meta/config.yml index cf04a3365f9a..cea792def07f 100644 --- a/metricbeat/module/dropwizard/_meta/config.yml +++ b/metricbeat/module/dropwizard/_meta/config.yml @@ -5,3 +5,5 @@ hosts: ["localhost:8080"] metrics_path: /metrics/metrics namespace: example + #username: "user" + #password: "secret" diff --git a/metricbeat/module/elasticsearch/_meta/config.yml b/metricbeat/module/elasticsearch/_meta/config.yml index 968449635293..1d7db8b1c11d 100644 --- a/metricbeat/module/elasticsearch/_meta/config.yml +++ b/metricbeat/module/elasticsearch/_meta/config.yml @@ -4,3 +4,5 @@ # - node_stats period: 10s hosts: ["localhost:9200"] + #username: "user" + #password: "secret" diff --git a/metricbeat/module/etcd/_meta/config.yml b/metricbeat/module/etcd/_meta/config.yml index 86e1e58fcc96..6acceb2a9c2a 100644 --- a/metricbeat/module/etcd/_meta/config.yml +++ b/metricbeat/module/etcd/_meta/config.yml @@ -5,3 +5,5 @@ # - store period: 10s hosts: ["localhost:2379"] + #username: "user" + #password: "secret" diff --git a/metricbeat/module/http/_meta/config.yml b/metricbeat/module/http/_meta/config.yml index a66e94295132..2944c5ba3455 100644 --- a/metricbeat/module/http/_meta/config.yml +++ b/metricbeat/module/http/_meta/config.yml @@ -7,6 +7,8 @@ path: "/" #body: "" #method: "GET" + #username: "user" + #password: "secret" #request.enabled: false #response.enabled: false #json.is_array: false diff --git a/metricbeat/module/jolokia/_meta/config.yml b/metricbeat/module/jolokia/_meta/config.yml index de48ae161fd7..a70d968a81ec 100644 --- a/metricbeat/module/jolokia/_meta/config.yml +++ b/metricbeat/module/jolokia/_meta/config.yml @@ -4,6 +4,8 @@ hosts: ["localhost"] namespace: "metrics" #path: "/jolokia/?ignoreErrors=true&canonicalNaming=false" + #username: "user" + #password: "secret" jmx.mappings: #- mbean: 'java.lang:type=Runtime' # attributes: diff --git a/metricbeat/module/kibana/_meta/config.yml b/metricbeat/module/kibana/_meta/config.yml index db546c958298..838670f8b629 100644 --- a/metricbeat/module/kibana/_meta/config.yml +++ b/metricbeat/module/kibana/_meta/config.yml @@ -3,3 +3,5 @@ # - status period: 10s hosts: ["localhost:5601"] + #username: "user" + #password: "secret" diff --git a/metricbeat/module/kubernetes/_meta/config.yml b/metricbeat/module/kubernetes/_meta/config.yml index ab04d158ceef..5492b0a3b99c 100644 --- a/metricbeat/module/kubernetes/_meta/config.yml +++ b/metricbeat/module/kubernetes/_meta/config.yml @@ -11,6 +11,8 @@ #ssl.certificate_authorities: ["/etc/pki/root/ca.pem"] #ssl.certificate: "/etc/pki/client/cert.pem" #ssl.key: "/etc/pki/client/cert.key" + #username: "user" + #password: "secret" # State metrics from kube-state-metrics service: #- module: kubernetes diff --git a/metricbeat/module/logstash/_meta/config.yml b/metricbeat/module/logstash/_meta/config.yml index 4e4f828e1798..eec892d96f33 100644 --- a/metricbeat/module/logstash/_meta/config.yml +++ b/metricbeat/module/logstash/_meta/config.yml @@ -4,3 +4,5 @@ # - node_stats period: 10s hosts: ["localhost:9600"] + #username: "user" + #password: "secret" diff --git a/metricbeat/module/nginx/_meta/config.yml b/metricbeat/module/nginx/_meta/config.yml index d2f66a7c4555..7d28f226e12f 100644 --- a/metricbeat/module/nginx/_meta/config.yml +++ b/metricbeat/module/nginx/_meta/config.yml @@ -8,3 +8,6 @@ # Path to server status. Default server-status #server_status_path: "server-status" + + #username: "user" + #password: "secret" diff --git a/metricbeat/module/php_fpm/_meta/config.yml b/metricbeat/module/php_fpm/_meta/config.yml index 87d98c3b4b85..f7b7b6c53c06 100644 --- a/metricbeat/module/php_fpm/_meta/config.yml +++ b/metricbeat/module/php_fpm/_meta/config.yml @@ -4,3 +4,5 @@ period: 10s hosts: ["localhost:8080"] status_path: "/status" + #username: "user" + #password: "secret" diff --git a/metricbeat/module/prometheus/_meta/config.yml b/metricbeat/module/prometheus/_meta/config.yml index e343f58df386..176fd562f018 100644 --- a/metricbeat/module/prometheus/_meta/config.yml +++ b/metricbeat/module/prometheus/_meta/config.yml @@ -5,3 +5,5 @@ hosts: ["localhost:9090"] metrics_path: /metrics #namespace: example + #username: "user" + #password: "secret" diff --git a/metricbeat/modules.d/apache.yml.disabled b/metricbeat/modules.d/apache.yml.disabled index 0f838b8d56c6..28e34fe429ad 100644 --- a/metricbeat/modules.d/apache.yml.disabled +++ b/metricbeat/modules.d/apache.yml.disabled @@ -6,3 +6,5 @@ # - status period: 10s hosts: ["http://127.0.0.1"] + #username: "user" + #password: "secret" diff --git a/metricbeat/modules.d/ceph.yml.disabled b/metricbeat/modules.d/ceph.yml.disabled index fafa2a69d719..7e875b274bd9 100644 --- a/metricbeat/modules.d/ceph.yml.disabled +++ b/metricbeat/modules.d/ceph.yml.disabled @@ -8,6 +8,8 @@ # - monitor_health period: 10s hosts: ["localhost:5000"] + #username: "user" + #password: "secret" - module: ceph #metricsets: diff --git a/metricbeat/modules.d/couchbase.yml.disabled b/metricbeat/modules.d/couchbase.yml.disabled index 1c0b2035d082..fbb8a53b4caa 100644 --- a/metricbeat/modules.d/couchbase.yml.disabled +++ b/metricbeat/modules.d/couchbase.yml.disabled @@ -8,3 +8,5 @@ # - node period: 10s hosts: ["localhost:8091"] + #username: "user" + #password: "secret" diff --git a/metricbeat/modules.d/dropwizard.yml.disabled b/metricbeat/modules.d/dropwizard.yml.disabled index d2607d7b7f0b..5baa63494528 100644 --- a/metricbeat/modules.d/dropwizard.yml.disabled +++ b/metricbeat/modules.d/dropwizard.yml.disabled @@ -8,3 +8,5 @@ hosts: ["localhost:8080"] metrics_path: /metrics/metrics namespace: example + #username: "user" + #password: "secret" diff --git a/metricbeat/modules.d/elasticsearch.yml.disabled b/metricbeat/modules.d/elasticsearch.yml.disabled index cebc667e85c7..112c9cebed7b 100644 --- a/metricbeat/modules.d/elasticsearch.yml.disabled +++ b/metricbeat/modules.d/elasticsearch.yml.disabled @@ -7,3 +7,5 @@ # - node_stats period: 10s hosts: ["localhost:9200"] + #username: "user" + #password: "secret" diff --git a/metricbeat/modules.d/etcd.yml.disabled b/metricbeat/modules.d/etcd.yml.disabled index 0039ea9b50eb..83927098538e 100644 --- a/metricbeat/modules.d/etcd.yml.disabled +++ b/metricbeat/modules.d/etcd.yml.disabled @@ -8,3 +8,5 @@ # - store period: 10s hosts: ["localhost:2379"] + #username: "user" + #password: "secret" diff --git a/metricbeat/modules.d/http.yml.disabled b/metricbeat/modules.d/http.yml.disabled index fb4b5787b462..0ce5b5c0f85c 100644 --- a/metricbeat/modules.d/http.yml.disabled +++ b/metricbeat/modules.d/http.yml.disabled @@ -10,6 +10,8 @@ path: "/" #body: "" #method: "GET" + #username: "user" + #password: "secret" #request.enabled: false #response.enabled: false #json.is_array: false diff --git a/metricbeat/modules.d/jolokia.yml.disabled b/metricbeat/modules.d/jolokia.yml.disabled index 38a6adbf9e84..2190273485f9 100644 --- a/metricbeat/modules.d/jolokia.yml.disabled +++ b/metricbeat/modules.d/jolokia.yml.disabled @@ -7,6 +7,8 @@ hosts: ["localhost"] namespace: "metrics" #path: "/jolokia/?ignoreErrors=true&canonicalNaming=false" + #username: "user" + #password: "secret" jmx.mappings: #- mbean: 'java.lang:type=Runtime' # attributes: diff --git a/metricbeat/modules.d/kibana.yml.disabled b/metricbeat/modules.d/kibana.yml.disabled index 37a1e8f9ed81..a2476f1b37a5 100644 --- a/metricbeat/modules.d/kibana.yml.disabled +++ b/metricbeat/modules.d/kibana.yml.disabled @@ -6,3 +6,5 @@ # - status period: 10s hosts: ["localhost:5601"] + #username: "user" + #password: "secret" diff --git a/metricbeat/modules.d/kubernetes.yml.disabled b/metricbeat/modules.d/kubernetes.yml.disabled index a446b381ec1d..5c569025d575 100644 --- a/metricbeat/modules.d/kubernetes.yml.disabled +++ b/metricbeat/modules.d/kubernetes.yml.disabled @@ -14,6 +14,8 @@ #ssl.certificate_authorities: ["/etc/pki/root/ca.pem"] #ssl.certificate: "/etc/pki/client/cert.pem" #ssl.key: "/etc/pki/client/cert.key" + #username: "user" + #password: "secret" # State metrics from kube-state-metrics service: #- module: kubernetes diff --git a/metricbeat/modules.d/logstash.yml.disabled b/metricbeat/modules.d/logstash.yml.disabled index fa6a2351560f..72ea8231ff4b 100644 --- a/metricbeat/modules.d/logstash.yml.disabled +++ b/metricbeat/modules.d/logstash.yml.disabled @@ -7,3 +7,5 @@ # - node_stats period: 10s hosts: ["localhost:9600"] + #username: "user" + #password: "secret" diff --git a/metricbeat/modules.d/nginx.yml.disabled b/metricbeat/modules.d/nginx.yml.disabled index dcb7e1ffb2c2..d9833114e650 100644 --- a/metricbeat/modules.d/nginx.yml.disabled +++ b/metricbeat/modules.d/nginx.yml.disabled @@ -11,3 +11,6 @@ # Path to server status. Default server-status #server_status_path: "server-status" + + #username: "user" + #password: "secret" diff --git a/metricbeat/modules.d/php_fpm.yml.disabled b/metricbeat/modules.d/php_fpm.yml.disabled index 3f88f99471e4..1fc49cc1e4e8 100644 --- a/metricbeat/modules.d/php_fpm.yml.disabled +++ b/metricbeat/modules.d/php_fpm.yml.disabled @@ -7,3 +7,5 @@ period: 10s hosts: ["localhost:8080"] status_path: "/status" + #username: "user" + #password: "secret" diff --git a/metricbeat/modules.d/prometheus.yml.disabled b/metricbeat/modules.d/prometheus.yml.disabled index 061ba9fde05b..21684d3adf19 100644 --- a/metricbeat/modules.d/prometheus.yml.disabled +++ b/metricbeat/modules.d/prometheus.yml.disabled @@ -8,3 +8,5 @@ hosts: ["localhost:9090"] metrics_path: /metrics #namespace: example + #username: "user" + #password: "secret" diff --git a/metricbeat/scripts/docs_collector.py b/metricbeat/scripts/docs_collector.py index cc4209cbfd2c..07ca0b46437a 100644 --- a/metricbeat/scripts/docs_collector.py +++ b/metricbeat/scripts/docs_collector.py @@ -89,7 +89,9 @@ def collect(beat_name): # HTTP helper if 'ssl' in get_settings(module_fields): - module_file += "This module supports TLS connection when using `ssl` config field, as described in <>.\n\n" + module_file += "This module supports TLS connection when using `ssl`" + \ + " config field, as described in <>." + \ + " It also supports the options described in <>.\n\n" # Add metricsets title as below each metricset adds its link module_file += "[float]\n"