metrics

README

Zabbix Metrics Collector

This library provides easy-to-use wrapper for sending metrics to the Zabbix server.

Usage:

package main

import (
	"github.com/blacked/go-zabbix"
	"github.com/retailcrm/zabbix-metrics-collector"
)

func main() {
    go metrics("app", "zabbix_server_docker", 10051)
    // some other logic here
}

func metrics(appHostZabbix, host string, port, intervalSeconds int) {
	sender := zabbix.NewSender(host, port)
	collector := metrics.NewMemoryCollector(intervalSeconds)
	proc := metrics.NewZabbix([]metrics.Collector{collector}, sender, appHostZabbix, intervalSeconds, metrics.DefaultLogger)
	proc.Run()
}

To collect other metrics you must implement metrics.Collector interface and collect relevant data there. The collector must be goroutine-safe.

You also can implement your own transport by using metrics.Transport interface. It may be useful in some cases. The included Zabbix transport will work just fine for the majority of use-cases.

Documentation

Index

• Variables
• func StoppableFinalizer(s Stoppable)
• type Collector
• type ErrorLogger
• type MemoryCollector
  • func NewMemoryCollector(interval uint64) *MemoryCollector
  • func (c *MemoryCollector) Metrics() []Metric
  • func (c *MemoryCollector) Run()
  • func (c *MemoryCollector) Stop() error
• type Metric
• type Runnable
• type Stoppable
• type Transport
  • func NewZabbix(collectors []Collector, sender *zabbix.Sender, metricsHost string, ...) Transport

Variables

var (
	ErrNilSender         = errors.New("sender is nil")
	ErrTransportInactive = errors.New("transport is not running")
	ErrCollectorInactive = errors.New("collector is not running")
)

var (
	DefaultLogger = &defaultLogger{}
	NilLogger     = &nilLogger{}
)

Functions

func StoppableFinalizer

func StoppableFinalizer(s Stoppable)

Types

type Collector

type Collector interface {
	Metrics() []Metric
}

Collector return list of collected metrics.

type ErrorLogger

type ErrorLogger interface {
	Errorf(format string, args ...interface{})
}

ErrorLogger can be used to output errors.

type MemoryCollector

type MemoryCollector struct {
	// contains filtered or unexported fields
}

MemoryCollector collects information about memory usage and goroutines count.

func NewMemoryCollector

func NewMemoryCollector(interval uint64) *MemoryCollector

NewMemoryCollector creates new instance of AppCollector.

func (*MemoryCollector) Metrics

func (c *MemoryCollector) Metrics() []Metric

Metrics fetches and clears metrics.

func (*MemoryCollector) Run

func (c *MemoryCollector) Run()

Run collection process.

func (*MemoryCollector) Stop

func (c *MemoryCollector) Stop() error

Stop collection process.

type Metric

type Metric struct {
	Name  string
	Value string
}

Metric contains name and value.

type Runnable

type Runnable interface {
	Run()
}

Runnable represents any type with Run method.

type Stoppable

type Stoppable interface {
	Stop() error
}

Stoppable represents any type with Stop method that can return an error.

type Transport

type Transport interface {
	Runnable
	Stoppable
	WithCollector(Collector) Transport
}

Transport is an arbitrary object that can be started and stopped only once per object lifetime.

func NewZabbix

func NewZabbix(
	collectors []Collector, sender *zabbix.Sender, metricsHost string, interval uint64, logger ErrorLogger) Transport

NewZabbix creates new metrics transport for zabbix server.