go-srvc

go-srvc / mods / metermod

github.com/go-srvc/mods/metermod

pkg.go.dev source 
go get github.com/go-srvc/mods/metermod@v1.17.0

README

metermod

metermod exports metrics to the otel endpoint and flushes buffers before the application exits. By default it also collects Go runtime metrics.

package main

import (
	"fmt"
	"net/http"
	"os"

	"github.com/go-srvc/mods/httpmod"
	"github.com/go-srvc/mods/metermod"
	"github.com/go-srvc/mods/sigmod"
	"github.com/go-srvc/srvc"
)

func main() {
	srvc.RunAndExit(
		metermod.New(),
		sigmod.New(os.Interrupt),
		httpmod.New(
			httpmod.WithAddr(":8080"),
			httpmod.WithHandler(http.HandlerFunc(hello)),
		),
	)
}

func hello(w http.ResponseWriter, r *http.Request) {
	fmt.Fprint(w, "ok")
}

Overview

Package metermod provides OpenTelemetry meter provider as a module.

Constants

const (
	ErrMissingProvider = errStr("meter provider not set")

	// ErrFlushFailed is no longer returned by Stop, which relies on
	// Shutdown to flush remaining metrics.
	//
	// Deprecated: kept for API compatibility and will be removed in a future
	// major version.
	ErrFlushFailed = errStr("failed to flush remaining metrics")
)
const ID = "metermod"

Types

type Opt

type Opt func(*Provider) error

func WithEnv

func WithEnv() Opt

WithEnv uses OTEL_EXPORTER_OTLP_METRICS_PROTOCOL and OTEL_EXPORTER_OTLP_PROTOCOL environment variable to set exporter. Accepted values are:

  • http/protobuf
  • grpc
  • stdout

If no value is provided, stdout is used.

func WithGRPC

func WithGRPC() Opt

WithGRPC creates meter provider with periodic reader using grpc exporter from OTEL_* env configs. Env variables: https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc

func WithHTTP

func WithHTTP() Opt

WithHTTP creates meter provider with periodic reader using http exporter from OTEL_* env configs. Env variables: https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp

func WithProvider

func WithProvider(exp *metric.MeterProvider) Opt

WithProvider sets the underlying meter provider for module.

func WithProviderFn

func WithProviderFn(fn func() (*metric.MeterProvider, error)) Opt

WithProviderFn sets the underlying meter provider for module using given function.

func WithRuntimeMetrics

func WithRuntimeMetrics(opts ...runtime.Option) Opt

WithRuntimeMetrics starts runtime metrics collection.

func WithStdout

func WithStdout(opt ...stdoutmetric.Option) Opt

WithStdout creates meter provider with stdout exporter.

type Provider

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

func New

func New(opts ...Opt) *Provider

New creates meter provider module with sane defaults. Default options are: WithEnv and WithRuntimeMetrics.

func (*Provider) ID

func (p *Provider) ID() string

func (*Provider) Init

func (p *Provider) Init() error

func (*Provider) Run

func (p *Provider) Run() error

func (*Provider) Stop

func (p *Provider) Stop() error

Examples

ExampleNew

package main

import (
	"github.com/go-srvc/mods/metermod"
	"github.com/go-srvc/srvc"
)

func main() {
	srvc.RunAndExit(
		metermod.New(),
	)
}