Skip to content

Commit

Permalink
Add a different doc helper for http and tls configurations (elastic#8159
Browse files Browse the repository at this point in the history
)
  • Loading branch information
jsoriano authored Sep 20, 2018
1 parent 6f3b81f commit 613cb6d
Show file tree
Hide file tree
Showing 50 changed files with 78 additions and 54 deletions.
3 changes: 2 additions & 1 deletion metricbeat/docs/modules/apache.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ metricbeat.modules:
#password: password
----

This module supports TLS connection when using `ssl` config field, as described in <<configuration-ssl>>. It also supports the options described in <<module-http-config-options>>.
This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.
It also supports the options described in <<module-http-config-options>>.

[float]
=== Metricsets
Expand Down
3 changes: 2 additions & 1 deletion metricbeat/docs/modules/ceph.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ metricbeat.modules:
enabled: true
----

This module supports TLS connection when using `ssl` config field, as described in <<configuration-ssl>>. It also supports the options described in <<module-http-config-options>>.
This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.
It also supports the options described in <<module-http-config-options>>.

[float]
=== Metricsets
Expand Down
3 changes: 2 additions & 1 deletion metricbeat/docs/modules/couchbase.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ metricbeat.modules:
enabled: true
----

This module supports TLS connection when using `ssl` config field, as described in <<configuration-ssl>>. It also supports the options described in <<module-http-config-options>>.
This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.
It also supports the options described in <<module-http-config-options>>.

[float]
=== Metricsets
Expand Down
3 changes: 2 additions & 1 deletion metricbeat/docs/modules/dropwizard.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ metricbeat.modules:
enabled: true
----

This module supports TLS connection when using `ssl` config field, as described in <<configuration-ssl>>. It also supports the options described in <<module-http-config-options>>.
This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.
It also supports the options described in <<module-http-config-options>>.

[float]
=== Metricsets
Expand Down
3 changes: 2 additions & 1 deletion metricbeat/docs/modules/elasticsearch.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ metricbeat.modules:
#index_recovery.active_only: true
----

This module supports TLS connection when using `ssl` config field, as described in <<configuration-ssl>>. It also supports the options described in <<module-http-config-options>>.
This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.
It also supports the options described in <<module-http-config-options>>.

[float]
=== Metricsets
Expand Down
3 changes: 2 additions & 1 deletion metricbeat/docs/modules/etcd.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ metricbeat.modules:
hosts: ["localhost:2379"]
----

This module supports TLS connection when using `ssl` config field, as described in <<configuration-ssl>>. It also supports the options described in <<module-http-config-options>>.
This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.
It also supports the options described in <<module-http-config-options>>.

[float]
=== Metricsets
Expand Down
3 changes: 2 additions & 1 deletion metricbeat/docs/modules/golang.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ metricbeat.modules:
path: "/debug/vars"
----

This module supports TLS connection when using `ssl` config field, as described in <<configuration-ssl>>. It also supports the options described in <<module-http-config-options>>.
This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.
It also supports the options described in <<module-http-config-options>>.

[float]
=== Metricsets
Expand Down
3 changes: 2 additions & 1 deletion metricbeat/docs/modules/http.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ metricbeat.modules:
# key: "value"
----

This module supports TLS connection when using `ssl` config field, as described in <<configuration-ssl>>. It also supports the options described in <<module-http-config-options>>.
This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.
It also supports the options described in <<module-http-config-options>>.

[float]
=== Metricsets
Expand Down
3 changes: 2 additions & 1 deletion metricbeat/docs/modules/jolokia.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ metricbeat.modules:
jmx.instance:
----

This module supports TLS connection when using `ssl` config field, as described in <<configuration-ssl>>. It also supports the options described in <<module-http-config-options>>.
This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.
It also supports the options described in <<module-http-config-options>>.

[float]
=== Metricsets
Expand Down
3 changes: 2 additions & 1 deletion metricbeat/docs/modules/kibana.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ metricbeat.modules:
enabled: true
----

This module supports TLS connection when using `ssl` config field, as described in <<configuration-ssl>>. It also supports the options described in <<module-http-config-options>>.
This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.
It also supports the options described in <<module-http-config-options>>.

[float]
=== Metricsets
Expand Down
3 changes: 2 additions & 1 deletion metricbeat/docs/modules/kubernetes.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,8 @@ metricbeat.modules:
hosts: ["https://${KUBERNETES_SERVICE_HOST}:${KUBERNETES_SERVICE_PORT}"]
----

This module supports TLS connection when using `ssl` config field, as described in <<configuration-ssl>>. It also supports the options described in <<module-http-config-options>>.
This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.
It also supports the options described in <<module-http-config-options>>.

[float]
=== Metricsets
Expand Down
3 changes: 2 additions & 1 deletion metricbeat/docs/modules/logstash.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ metricbeat.modules:
hosts: ["localhost:9600"]
----

This module supports TLS connection when using `ssl` config field, as described in <<configuration-ssl>>. It also supports the options described in <<module-http-config-options>>.
This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.
It also supports the options described in <<module-http-config-options>>.

[float]
=== Metricsets
Expand Down
2 changes: 1 addition & 1 deletion metricbeat/docs/modules/mongodb.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ metricbeat.modules:
#password: pass
----

This module supports TLS connection when using `ssl` config field, as described in <<configuration-ssl>>. It also supports the options described in <<module-http-config-options>>.
This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.

[float]
=== Metricsets
Expand Down
3 changes: 2 additions & 1 deletion metricbeat/docs/modules/nginx.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ metricbeat.modules:
server_status_path: "server-status"
----

This module supports TLS connection when using `ssl` config field, as described in <<configuration-ssl>>. It also supports the options described in <<module-http-config-options>>.
This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.
It also supports the options described in <<module-http-config-options>>.

[float]
=== Metricsets
Expand Down
3 changes: 2 additions & 1 deletion metricbeat/docs/modules/php_fpm.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@ metricbeat.modules:
hosts: ["localhost:8080"]
----

This module supports TLS connection when using `ssl` config field, as described in <<configuration-ssl>>. It also supports the options described in <<module-http-config-options>>.
This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.
It also supports the options described in <<module-http-config-options>>.

[float]
=== Metricsets
Expand Down
3 changes: 2 additions & 1 deletion metricbeat/docs/modules/prometheus.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ metricbeat.modules:
# - /var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt
----

This module supports TLS connection when using `ssl` config field, as described in <<configuration-ssl>>. It also supports the options described in <<module-http-config-options>>.
This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.
It also supports the options described in <<module-http-config-options>>.

[float]
=== Metricsets
Expand Down
3 changes: 2 additions & 1 deletion metricbeat/docs/modules/rabbitmq.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ metricbeat.modules:
#password: guest
----

This module supports TLS connection when using `ssl` config field, as described in <<configuration-ssl>>. It also supports the options described in <<module-http-config-options>>.
This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.
It also supports the options described in <<module-http-config-options>>.

[float]
=== Metricsets
Expand Down
2 changes: 1 addition & 1 deletion metricbeat/module/apache/_meta/fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Apache HTTPD server metricsets collected from the Apache web server.
short_config: false
release: ga
settings: ["ssl"]
settings: ["ssl", "http"]
fields:
- name: apache
type: group
Expand Down
2 changes: 1 addition & 1 deletion metricbeat/module/apache/fields.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion metricbeat/module/ceph/_meta/fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Ceph module
short_config: false
release: beta
settings: ["ssl"]
settings: ["ssl", "http"]
fields:
- name: ceph
type: group
Expand Down
2 changes: 1 addition & 1 deletion metricbeat/module/ceph/fields.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion metricbeat/module/couchbase/_meta/fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Metrics collected from Couchbase servers.
short_config: false
release: beta
settings: ["ssl"]
settings: ["ssl", "http"]
fields:
- name: couchbase
type: group
Expand Down
2 changes: 1 addition & 1 deletion metricbeat/module/couchbase/fields.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion metricbeat/module/dropwizard/_meta/fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
description: >
Stats collected from Dropwizard.
release: beta
settings: ["ssl"]
settings: ["ssl", "http"]
short_config: false
fields:
- name: dropwizard
Expand Down
2 changes: 1 addition & 1 deletion metricbeat/module/dropwizard/fields.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion metricbeat/module/elasticsearch/_meta/fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
description: >
Elasticsearch module
release: beta
settings: ["ssl"]
settings: ["ssl", "http"]
short_config: false
fields:
- name: elasticsearch
Expand Down
Loading

0 comments on commit 613cb6d

Please sign in to comment.