micrometer

README

Welcome to micrometer-go 👋

a micrometer implementation in Golang.

🏠 Homepage

Install

$ go get -u github.com/jjeffcaii/micrometer-go

Author

👤 Jeffsky

• Github: @jjeffcaii

Show your support

Give a ⭐️ if this project helped you!

---

This README was generated with ❤️ by readme-md-generator

Documentation

Index

• type Counter
  • func NewCounter(id *ID) Counter
• type CounterBuilder
  • func (p *CounterBuilder) Description(desc string) *CounterBuilder
  • func (p *CounterBuilder) Register(registry MeterRegistry) (Counter, error)
  • func (p *CounterBuilder) Tag(k, v string) *CounterBuilder
  • func (p *CounterBuilder) Tags(tags ...string) *CounterBuilder
  • func (p *CounterBuilder) Unit(unit string) *CounterBuilder
• type ID
• type Measurement
• type Meter
• type MeterBuilder
  • func Builder() MeterBuilder
  • func (b MeterBuilder) Counter(name string) *CounterBuilder
• type MeterRegistry
  • func NewSimpleMeterRegistry() MeterRegistry
• type Statistic
  • func (s Statistic) String() string
• type Summary
• type Tag
• type Type

Types

type Counter

type Counter interface {
	Meter
	Increment(amount float64)
	Count() float64
}

func NewCounter

func NewCounter(id *ID) Counter

type CounterBuilder

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

func (*CounterBuilder) Description

func (p *CounterBuilder) Description(desc string) *CounterBuilder

func (*CounterBuilder) Register

func (p *CounterBuilder) Register(registry MeterRegistry) (Counter, error)

func (*CounterBuilder) Tag

func (p *CounterBuilder) Tag(k, v string) *CounterBuilder

func (*CounterBuilder) Tags

func (p *CounterBuilder) Tags(tags ...string) *CounterBuilder

func (*CounterBuilder) Unit

func (p *CounterBuilder) Unit(unit string) *CounterBuilder

type ID

type ID struct {
	Name string
	Tags []*Tag
	Type Type
	Unit string
	Desc string
}

type Measurement

type Measurement interface {
	Statistic() Statistic
	Value() float64
}

type Meter

type Meter interface {
	ID() *ID
	Measure() []Measurement
}

type MeterBuilder

type MeterBuilder struct {
}

func Builder

func Builder() MeterBuilder

func (MeterBuilder) Counter

func (b MeterBuilder) Counter(name string) *CounterBuilder

type MeterRegistry

type MeterRegistry interface {
	Counter(id *ID) (Counter, error)
}

func NewSimpleMeterRegistry

func NewSimpleMeterRegistry() MeterRegistry

type Statistic

type Statistic int8

const (
	StatisticUnknown Statistic = iota
	StatisticTotal
	StatisticTotalTime
	StatisticCount
	StatisticMax
	StatisticValue
	StatisticActiveTasks
	StatisticDuration
)

func (Statistic) String

func (s Statistic) String() string

type Summary

type Summary interface {
	Meter
	Record(v float64)
	Count() int64
	Amount() float64
	Mean() float64
	Max() float64
}

type Tag

type Tag struct {
	K string
	V string
}

type Type

type Type int8

const (
	TypeCounter Type
	TypeGauge
	TypeLongTaskTimer
	TypeTimer
	TypeDistributionSummary
	TypeOther
)