vimebu

vimebu is a small library that provides a builder to create VictoriaMetrics compatible metrics.

Installation

go get -u github.com/wazazaby/vimebu

Usage

import (
    "github.com/VictoriaMetrics/metrics"
    "github.com/wazazaby/vimebu"
)

// Only using the builder.
var requestsTotalCounter = metrics.NewCounter(
    vimebu.
        Metric("request_total").
        Label("path", "/foo/bar").
        String(), // request_total{path="/foo/bar"}
)

var responseSizeHistogram = metrics.NewHistogram(
    vimebu.Metric("response_size").String(), // response_size
)

// Registering the metric using the provided helpers.
var updateTotalCounterV3 = vimebu.
    Metric("update_total").
    LabelInt("version", 3).
    NewCounter() // update_total{version="3"}

Create metrics with variable label values

It's even more useful when you want to build metrics with variable label values.

import (
    "net"

    "github.com/VictoriaMetrics/metrics"
    "github.com/wazazaby/vimebu"
)

func getCassandraQueryCounter(name string, host net.IP) *metrics.Counter {
    var b vimebu.Builder
    b.Metric("cassandra_query_total")
    b.Label("name", name)
    b.LabelStringer("host", host)
    metric := b.String() // cassandra_query_total{name="beep",host="1.2.3.4"}
    return metrics.GetOrCreateCounter(metric)
}

Create metrics with conditional labels

import (
    "github.com/VictoriaMetrics/metrics"
    "github.com/wazazaby/vimebu"
)

func getHTTPRequestCounter(host string) *metrics.Counter {
    var b vimebu.Builder
    b.Metric("api_http_requests_total")
    if host != "" {
        b.Label("host", host)
    }
    metric := b.String() // api_http_requests_total or api_http_requests_total{host="api.app.com"}
    return metrics.GetOrCreateCounter(metric)
}

Create metrics with label values that need to be escaped

vimebu also exposes a way to escape quotes on label values you don't control using Builder.LabelQuote.

import (
    "github.com/VictoriaMetrics/metrics"
    "github.com/wazazaby/vimebu"
)

func getHTTPRequestCounter(path string) *metrics.Counter {
    var b vimebu.Builder
    b.Metric("api_http_requests_total")
    b.LabelQuote("path", path)
    counter := b.GetOrCreateCounter() // api_http_requests_total{path="some/bro\"ken/path"}
    return counter
}

Create metrics with label values that aren't string

You can use Builder.LabelBool, Builder.LabelInt, Builder.LabelFloat or Builder.LabelStringer to append boolean, integer, float or fmt.Stringer label values to the builder.

For now, vimebu doesn't expose more helper methods.

Gotchas

When a metric is invalid (empty name, empty label name or value etc), vimebu will skip and log to os.Stderr.

vrischmann / vimebu