haproxy

README

HAProxy collector

HAProxy is a free, very fast and reliable solution offering high availability, load balancing, and proxying for TCP and HTTP-based applications.

This module will monitor one or more HAProxy instances, depending on your configuration.

Requirements

• HAProxy v2.0+ (or 1.9r1+ for Enterprise users) with enabled PROMEX addon. PROMEX is not built by default with HAProxy. It is provided as an extra component for everyone who wants to use it.

Metrics

Current implementation collects only backend metrics.

All metrics have "haproxy." prefix.

Metric	Scope	Dimensions	Units
backend_current_sessions	global	a dimension per proxy	sessions
backend_sessions	global	a dimension per proxy	sessions/s
backend_response_time_average	global	a dimension per proxy	milliseconds
backend_queue_time_average	global	a dimension per proxy	milliseconds
backend_current_queue	global	a dimension per proxy	requests
backend_http_responses	proxy	1xx, 2xx, 3xx, 4xx, 5xx, other	responses/s
backend_network_io	proxy	in, out	bytes/s

Charts

Backend

• Sessions
  • Current number of active sessions in sessions
  • Sessions rate in sessions/s
• Responses
  • Average response time for last 1024 successful connections in milliseconds
  • HTTP responses by code class in responses/s
• Queue
  • Average queue time for last 1024 successful connections in milliseconds
  • Current number of queued requests in requests
• Network
  • Network traffic in bytes/s

Configuration

Edit the go.d/haproxy.conf configuration file using edit-config from the Netdata config directory, which is typically at /etc/netdata.

cd /etc/netdata # Replace this path with your Netdata config directory
sudo ./edit-config go.d/haproxy.conf

Needs only url to server's /metrics endpoint. Here is an example for 2 servers:

jobs:
  - name: local
    url: http://127.0.0.1:8404/metrics

  - name: remote
    url: http://203.0.113.10:8404/metrics

For all available options please see module configuration file.

Troubleshooting

To troubleshoot issues with the haproxy collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

• Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

  cd /usr/libexec/netdata/plugins.d/
  

• Switch to the netdata user.

  sudo -u netdata -s
  

• Run the go.d.plugin to debug the collector:

  ./go.d.plugin -d -m haproxy
  

Documentation

Index

• type Config
• type Haproxy
  • func New() *Haproxy
  • func (h *Haproxy) Charts() *module.Charts
  • func (h *Haproxy) Check() bool
  • func (Haproxy) Cleanup()
  • func (h *Haproxy) Collect() map[string]int64
  • func (h *Haproxy) Init() bool

Types

type Config

type Config struct {
	web.HTTP `yaml:",inline"`
}

type Haproxy

type Haproxy struct {
	module.Base
	Config `yaml:",inline"`
	// contains filtered or unexported fields
}

func New

func New() *Haproxy

func (*Haproxy) Charts

func (h *Haproxy) Charts() *module.Charts

func (*Haproxy) Check

func (h *Haproxy) Check() bool

func (Haproxy) Cleanup

func (Haproxy) Cleanup()

func (*Haproxy) Collect

func (h *Haproxy) Collect() map[string]int64

func (*Haproxy) Init

func (h *Haproxy) Init() bool