HAProxy 🔗

Description 🔗

The Splunk Distribution of OpenTelemetry Collector provides this integration as the haproxy monitor using the Smart Agent receiver.

This monitors an HAProxy instance. This monitor requires HAProxy 1.5+.

Socket configuration 🔗

The location of the HAProxy socket file is defined in the HAProxy configuration file, as shown in the following example:

global
    daemon
    stats socket /var/run/haproxy.sock
    stats timeout 2m

Note: You can use a TCP socket for stats in HAProxy. In your haproxy plugin configuration file, specify the TCP address for the socket. For example, you can use https://www.example.com/socket:9000. In the haproxy.cfg file, change the stats socket to use the same TCP address and port, as shown in the following example:

global
    daemon
    stats socket localhost:9000
    stats timeout 2m

To use a more restricted TCP socket, follow these steps:

Define a backend server that listens to stats on localhost.
Define a frontend proxy server that communicates with the back-end server on a different port.
Use ACLs on both servers to control access. Depending on how restrictive your socket is, you might need to add the signalfx-agent user to the haproxy group as follows: sudo usermod -a -G haproxy signalfx-agent

The following configuration file shows how to define a back-end server and a frontend proxy:

global
    daemon
    stats socket localhost:9000
    stats timeout 2m

backend stats-backend
    mode tcp
    server stats-localhost localhost:9000

frontend stats-frontend
    bind *:9001
    default_backend stats-backend
    acl ...
    acl ...

SELinux setup 🔗

If you have SELinux activated, create a SELinux policy package by downloading the type enforcement file to some place on your server. Run the following commands to create and install the policy package:

    $ checkmodule -M -m -o haproxy.mod haproxy.te
    checkmodule:  loading policy configuration from haproxy.te
    checkmodule:  policy configuration loaded
    checkmodule:  writing binary representation (version 17) to haproxy.mod
    $ semodule_package -o haproxy.pp -m haproxy.mod
    $ sudo semodule -i haproxy.pp
    $ sudo reboot

Installation 🔗

This monitor is available in the Smart Agent Receiver, which is part of the Splunk Distribution of OpenTelemetry Collector.

To install this integration:

Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform.
Configure the monitor, as described in the next section.

Configuration 🔗

The Splunk Distribution of OpenTelemetry Collector allows embedding a Smart Agent monitor configuration in an associated Smart Agent Receiver instance.

Note: Providing an HAProxy monitor entry in your Collector or Smart Agent (deprecated) configuration is required for its use. Use the appropriate form for your agent type.

Splunk Distribution of OpenTelemetry Collector 🔗

To activate this monitor in the OpenTelemetry Collector, add the following to your agent configuration:

receivers:
    smartagent/haproxy:
        type: haproxy
        ...  # Additional config

To complete the monitor activation, you must also include the smartagent/haproxy receiver item in a metrics pipeline. To do this, add the receiver item to the service > pipelines > metrics > receivers section of your configuration file.

See configuration examples for specific use cases that show how the Splunk Distribution of OpenTelemetry Collector can integrate and complement existing environments.

Smart Agent 🔗

To activate this monitor in the Smart Agent, add the following to your agent configuration:

monitors:  # All monitor config goes under this key
 - type: haproxy
   ...  # Additional config

See Smart Agent example configuration for an autogenerated example of a YAML configuration file, with default values where applicable.

Configuration settings 🔗

The following table shows the configuration options for this monitor:

Option	Required	Type	Description
`pythonBinary`	no	`string`	Path to a python binary that should be used to execute the Python code. If not set, a built-in runtime will be used. Can include arguments to the binary as well.
`host`	yes	`string`
`port`	no	`integer`	(default: `0`)
`proxiesToMonitor`	no	`list of strings`	A list of all the pxname(s) or svname(s) that you want to monitor (e.g. `["http-in", "server1", "backend"]`)
`excludedMetrics`	no	`list of strings`	Deprecated. Please use `datapointsToExclude` on the monitor config block instead.
`enhancedMetrics`	no	`bool`	(default: `false`)

Metrics 🔗

The following metrics are available for this integration:

Get help 🔗

If you are not able to see your data in Splunk Observability Cloud, try these tips:

Submit a case in the Splunk Support Portal
- Available to Splunk Observability Cloud customers
Call Splunk Customer Support
- Available to Splunk Observability Cloud customers
Ask a question and get answers through community support at Splunk Answers
- Available to Splunk Observability Cloud customers and free trial users
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide
- Available to Splunk Observability Cloud customers and free trial users
- To learn how to join, see Get Started with Splunk Community - Chat groups

To learn about even more support options, see Splunk Customer Success.

Related Topics