:modulename: haproxy
:has-dashboards: true

== haproxy module

The +{modulename}+ module collects and parses logs from a (`haproxy`) process.

include::../include/what-happens.asciidoc[]

include::../include/gs-link.asciidoc[]

[float]
=== Compatibility

The +{modulename}+ module was tested with logs from `haproxy` running on AWS Linux as a gateway to a cluster of microservices.

The module was also tested with HAProxy 1.8, 1.9 and 2.0 running on a Debian.

This module is not available for Windows.

include::../include/configuring-intro.asciidoc[]

The module is by default configured to run via syslog on port 9001. However
it can also be configured to read from a file path. See the following example.

["source","yaml",subs="attributes"]
-----
- module: haproxy
  log:
    enabled: true
    var.paths: ["/var/log/haproxy.log"]
    var.input: "file"
-----

:fileset_ex: log

include::../include/config-option-intro.asciidoc[]


[float]
==== `log` fileset settings

include::../include/var-paths.asciidoc[]

include::../include/timezone-support.asciidoc[]

[float]
=== Example dashboard

This module comes with a sample dashboard showing geolocation, distribution of requests between backends and frontends,
and status codes over time. For example:

[role="screenshot"]
image::./images/kibana-haproxy-overview.png[]

:has-dashboards!:

:fileset_ex!:

:modulename!:
