traefik

README

Traefik monitoring with Netdata

Traefik is a leading modern reverse proxy and load balancer that makes deploying microservices easy. .

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

Requirements

• Traefik with enabled Prometheus exporter.

Metrics

Current implementation collects only entrypoint metrics.

All metrics have "vcsa." prefix.

Metric	Scope	Dimensions	Units
entrypoint_requests	entrypoint, protocol	1xx, 2xx, 3xx, 4xx, 5xx	requests/s
entrypoint_request_duration_average	entrypoint, protocol	1xx, 2xx, 3xx, 4xx, 5xx	milliseconds
entrypoint_open_connections	entrypoint, protocol	a dimension per HTTP method	connections

Configuration

Edit the go.d/traefik.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/traefik.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:8082/metrics

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

For all available options please see module configuration file.

Troubleshooting

To troubleshoot issues with the traefik 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 traefik
  

Documentation

Index

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

Types

type Config

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

type Traefik

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

func New

func New() *Traefik

func (*Traefik) Charts

func (t *Traefik) Charts() *module.Charts

func (*Traefik) Check

func (t *Traefik) Check() bool

func (Traefik) Cleanup

func (Traefik) Cleanup()

func (*Traefik) Collect

func (t *Traefik) Collect() map[string]int64

func (*Traefik) Init

func (t *Traefik) Init() bool