vmetric

package

v0.0.2 Latest Latest Go to latest Published: Mar 30, 2025 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/sunshinexcode/gotk

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func MetricHttpRequestCount(metric *Metric, count float64, lvs ...string)
func MetricHttpRequestCountTypeApi(metric *Metric, count float64, lvs ...string)
func MetricHttpRequestCountTypeCron(metric *Metric, count float64, lvs ...string)
func MetricHttpRequestCountTypeThirdPartyApi(metric *Metric, count float64, lvs ...string)
func MetricHttpRequestDuration(metric *Metric, timeStart time.Time, lvs ...string)
func MetricHttpRequestDurationTypeApi(metric *Metric, timeStart time.Time, lvs ...string)
func MetricHttpRequestDurationTypeCron(metric *Metric, timeStart time.Time, lvs ...string)
func MetricHttpRequestDurationTypeThirdPartyApi(metric *Metric, timeStart time.Time, lvs ...string)
func MetricHttpRequestTotal(metric *Metric, lvs ...string)
func MetricHttpRequestTotalTypeApi(metric *Metric, lvs ...string)
func MetricHttpRequestTotalTypeCron(metric *Metric, lvs ...string)
func MetricHttpRequestTotalTypeThirdPartyApi(metric *Metric, lvs ...string)
func Reset()
type Metric
- func Init(options map[string]any) (metric *Metric, err error)
- func Mock() (metric *Metric, patches []*vmock.Patches)
- func New(options map[string]any) (metric *Metric, err error)
- func (metric *Metric) D() *prometheus.HistogramVec
- func (metric *Metric) NewBuildInfo()
- func (metric *Metric) NewHttpRequestDuration()
- func (metric *Metric) NewHttpRequestTotal()
- func (metric *Metric) Run() (err error)
- func (metric *Metric) SetConfig(options map[string]any) error
- func (metric *Metric) T() *prometheus.CounterVec
type MockCounter
- func (m *MockCounter) Add(float64)
- func (m *MockCounter) Collect(chan<- prometheus.Metric)
- func (m *MockCounter) Desc() *prometheus.Desc
- func (m *MockCounter) Describe(chan<- *prometheus.Desc)
- func (m *MockCounter) Inc()
- func (m *MockCounter) Write(*dto.Metric) error
type MockGauge
- func (m *MockGauge) Add(float64)
- func (m *MockGauge) Collect(chan<- prometheus.Metric)
- func (m *MockGauge) Dec()
- func (m *MockGauge) Desc() *prometheus.Desc
- func (m *MockGauge) Describe(chan<- *prometheus.Desc)
- func (m *MockGauge) Inc()
- func (m *MockGauge) Set(float64)
- func (m *MockGauge) SetToCurrentTime()
- func (m *MockGauge) Sub(float64)
- func (m *MockGauge) Write(*dto.Metric) error
type MockObserver
- func (m *MockObserver) Observe(float64)
type Options

Constants ¶

View Source

const (
	MetricTypeApi           = "api"
	MetricTypeThirdPartyApi = "thirdPartyApi"
	MetricTypeCron          = "cron"
)

Variables ¶

This section is empty.

Functions ¶

func MetricHttpRequestCount ¶

func MetricHttpRequestCount(metric *Metric, count float64, lvs ...string)

func MetricHttpRequestCountTypeApi ¶

func MetricHttpRequestCountTypeApi(metric *Metric, count float64, lvs ...string)

func MetricHttpRequestCountTypeCron ¶

func MetricHttpRequestCountTypeCron(metric *Metric, count float64, lvs ...string)

func MetricHttpRequestCountTypeThirdPartyApi ¶

func MetricHttpRequestCountTypeThirdPartyApi(metric *Metric, count float64, lvs ...string)

func MetricHttpRequestDuration ¶

func MetricHttpRequestDuration(metric *Metric, timeStart time.Time, lvs ...string)

lvs: type/api/code

func MetricHttpRequestDurationTypeApi ¶

func MetricHttpRequestDurationTypeApi(metric *Metric, timeStart time.Time, lvs ...string)

func MetricHttpRequestDurationTypeCron ¶

func MetricHttpRequestDurationTypeCron(metric *Metric, timeStart time.Time, lvs ...string)

func MetricHttpRequestDurationTypeThirdPartyApi ¶

func MetricHttpRequestDurationTypeThirdPartyApi(metric *Metric, timeStart time.Time, lvs ...string)

func MetricHttpRequestTotal ¶

func MetricHttpRequestTotal(metric *Metric, lvs ...string)

lvs: type/api/code

func MetricHttpRequestTotalTypeApi ¶

func MetricHttpRequestTotalTypeApi(metric *Metric, lvs ...string)

func MetricHttpRequestTotalTypeCron ¶

func MetricHttpRequestTotalTypeCron(metric *Metric, lvs ...string)

func MetricHttpRequestTotalTypeThirdPartyApi ¶

func MetricHttpRequestTotalTypeThirdPartyApi(metric *Metric, lvs ...string)

func Reset ¶

func Reset()

Reset reset metric

Types ¶

type Metric ¶

type Metric struct {
	BuildInfo           *prometheus.GaugeVec
	HttpRequestDuration *prometheus.HistogramVec
	HttpRequestTotal    *prometheus.CounterVec
	Options             *Options
}

func Init ¶

func Init(options map[string]any) (metric *Metric, err error)

Init init metric

func Mock ¶

func Mock() (metric *Metric, patches []*vmock.Patches)

func New ¶

func New(options map[string]any) (metric *Metric, err error)

New create new metric

func (*Metric) D ¶

func (metric *Metric) D() *prometheus.HistogramVec

D return HttpRequestDuration

func (*Metric) NewBuildInfo ¶

func (metric *Metric) NewBuildInfo()

NewBuildInfo new build info

func (*Metric) NewHttpRequestDuration ¶

func (metric *Metric) NewHttpRequestDuration()

NewHttpRequestDuration new http request duration, millisecond

func (*Metric) NewHttpRequestTotal ¶

func (metric *Metric) NewHttpRequestTotal()

NewHttpRequestTotal new http request total

func (*Metric) Run ¶

func (metric *Metric) Run() (err error)

Run http

func (*Metric) SetConfig ¶

func (metric *Metric) SetConfig(options map[string]any) error

SetConfig set config

func (*Metric) T ¶

func (metric *Metric) T() *prometheus.CounterVec

T return HttpRequestTotal

type MockCounter ¶

type MockCounter struct {
}

func (*MockCounter) Add ¶

func (m *MockCounter) Add(float64)

func (*MockCounter) Collect ¶

func (m *MockCounter) Collect(chan<- prometheus.Metric)

func (*MockCounter) Desc ¶

func (m *MockCounter) Desc() *prometheus.Desc

func (*MockCounter) Describe ¶

func (m *MockCounter) Describe(chan<- *prometheus.Desc)

func (*MockCounter) Inc ¶

func (m *MockCounter) Inc()

func (*MockCounter) Write ¶

func (m *MockCounter) Write(*dto.Metric) error

type MockGauge ¶

type MockGauge struct {
}

func (*MockGauge) Add ¶

func (m *MockGauge) Add(float64)

func (*MockGauge) Collect ¶

func (m *MockGauge) Collect(chan<- prometheus.Metric)

func (*MockGauge) Dec ¶

func (m *MockGauge) Dec()

func (*MockGauge) Desc ¶

func (m *MockGauge) Desc() *prometheus.Desc

func (*MockGauge) Describe ¶

func (m *MockGauge) Describe(chan<- *prometheus.Desc)

func (*MockGauge) Inc ¶

func (m *MockGauge) Inc()

func (*MockGauge) Set ¶

func (m *MockGauge) Set(float64)

func (*MockGauge) SetToCurrentTime ¶

func (m *MockGauge) SetToCurrentTime()

func (*MockGauge) Sub ¶

func (m *MockGauge) Sub(float64)

func (*MockGauge) Write ¶

func (m *MockGauge) Write(*dto.Metric) error

type MockObserver ¶

type MockObserver struct {
}

func (*MockObserver) Observe ¶

func (m *MockObserver) Observe(float64)

type Options ¶

type Options struct {
	DisableGoCollector              bool              `mapstructure:",omitempty"`
	DisableProcessCollector         bool              `mapstructure:",omitempty"`
	BuildInfoConstLabels            map[string]string `mapstructure:",omitempty"`
	BuildInfoHelp                   string            `mapstructure:",omitempty"`
	BuildInfoLabelNames             []string          `mapstructure:",omitempty"`
	BuildInfoName                   string            `mapstructure:",omitempty"`
	HttpRequestDurationBucketsCount int               `mapstructure:",omitempty"`
	HttpRequestDurationBucketsStart float64           `mapstructure:",omitempty"`
	HttpRequestDurationBucketsWidth float64           `mapstructure:",omitempty"`
	HttpRequestDurationConstLabels  map[string]string `mapstructure:",omitempty"`
	HttpRequestDurationHelp         string            `mapstructure:",omitempty"`
	HttpRequestDurationLabelNames   []string          `mapstructure:",omitempty"`
	HttpRequestDurationName         string            `mapstructure:",omitempty"`
	HttpRequestTotalConstLabels     map[string]string `mapstructure:",omitempty"`
	HttpRequestTotalHelp            string            `mapstructure:",omitempty"`
	HttpRequestTotalLabelNames      []string          `mapstructure:",omitempty"`
	HttpRequestTotalName            string            `mapstructure:",omitempty"`
	Namespace                       string            `mapstructure:",omitempty"`
	Port                            string            `mapstructure:",omitempty"`
	Url                             string            `mapstructure:",omitempty"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL