Skip to content

Commit

Permalink
HAProxy docs updated (#2929)
Browse files Browse the repository at this point in the history
* Fix duplicated info name
* Change ruby to log docs
* Document supported versions

See #2485
  • Loading branch information
ruflin authored and tsg committed Nov 4, 2016
1 parent 98f44ef commit 2d776fa
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 11 deletions.
2 changes: 1 addition & 1 deletion metricbeat/docs/modules/apache.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ HTTPD] servers.
[float]
=== Compatibility

The Apache metricsets were tested with Apache 2.4.20 and are expected to work with all version
The Apache metricsets were tested with Apache 2.4.20 and are expected to work with all versions
>= 2.2.31 and >= 2.4.16.


Expand Down
9 changes: 7 additions & 2 deletions metricbeat/docs/modules/haproxy.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,21 @@ This file is generated! See scripts/docs_collector.py
////

[[metricbeat-module-haproxy]]
== haproxy Module
== HAProxy Module

This is the haproxy Module. To enable stats collection from HAProxy, you must enable the stats socket via TCP.
This is the haproxy Module. To enable stats collection from HAProxy, you must enable the stats socket via TCP.
For example, placing the following statement under the `global` or `default` section of the haproxy config:

`stats socket 127.0.0.1:14567`

will enable stats reporting via any local IP on port 14567. Please note that you should probably use an internal private IP
or secure this with a firewall rule so that only designated hosts can access this data.

[float]
=== Compatibility

The HAProxy metricsets were tested with HAProxy 1.6 and are expected to work with all 1.6 versions.


[float]
=== Example Configuration
Expand Down
2 changes: 1 addition & 1 deletion metricbeat/module/apache/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ HTTPD] servers.
[float]
=== Compatibility

The Apache metricsets were tested with Apache 2.4.20 and are expected to work with all version
The Apache metricsets were tested with Apache 2.4.20 and are expected to work with all versions
>= 2.2.31 and >= 2.4.16.


Expand Down
9 changes: 7 additions & 2 deletions metricbeat/module/haproxy/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
== haproxy Module
== HAProxy Module

This is the haproxy Module. To enable stats collection from HAProxy, you must enable the stats socket via TCP.
This is the haproxy Module. To enable stats collection from HAProxy, you must enable the stats socket via TCP.
For example, placing the following statement under the `global` or `default` section of the haproxy config:

`stats socket 127.0.0.1:14567`

will enable stats reporting via any local IP on port 14567. Please note that you should probably use an internal private IP
or secure this with a firewall rule so that only designated hosts can access this data.

[float]
=== Compatibility

The HAProxy metricsets were tested with HAProxy 1.6 and are expected to work with all 1.6 versions.
4 changes: 2 additions & 2 deletions metricbeat/module/haproxy/info/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
=== haproxy stat MetricSet
=== HAProxy info MetricSet

This is the info metricset of the module haproxy.
This is the info metricset of the haproxy module.
6 changes: 3 additions & 3 deletions metricbeat/module/haproxy/stat/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
=== haproxy stat MetricSet
=== HAProxy stat MetricSet

This is the info metricset of the module haproxy.
This is the stat metricset of the haproxy module.


[float]
Expand All @@ -12,7 +12,7 @@ http://www.haproxy.org/download/1.6/doc/management.txt

The following documentation bellow is an extract from the URL above, more specifically from section "9.1. CSV format"

[source,ruby]
[source,log]
----
In brackets after each field name are the types which may have a value for
that field. The types are L (Listeners), F (Frontends), B (Backends), and
Expand Down

0 comments on commit 2d776fa

Please sign in to comment.