metric

Documentation

Overview

* Copyright 2023 Caio Matheus Marcatti Calimério * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License.

* Copyright 2023 Caio Matheus Marcatti Calimério * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License.

Index

• type IMetric
  • func Factory(env env.IEnv, logger log.ILog) IMetric
  • func NewInstancePrometheus(env env.IEnv, logger log.ILog) IMetric
• type Labels
• type LabelsKeys
• type MetricType
• type Prometheus
  • func (m *Prometheus) CreateMetric(metricType MetricType, name, help string, labelKeys LabelsKeys)
  • func (m *Prometheus) IncrementCounter(name string, labelValues Labels) error
  • func (m *Prometheus) ObserveHistogram(name string, value float64, labelValues Labels) error
  • func (m *Prometheus) ObserveSummary(name string, value float64, labelValues Labels) error
  • func (m *Prometheus) SetGauge(name string, value float64, labelValues Labels) error

Types

type IMetric

type IMetric interface {
	CreateMetric(metricType MetricType, name, help string, labelKeys LabelsKeys)
	IncrementCounter(name string, labelValues Labels) error
	SetGauge(name string, value float64, labelValues Labels) error
	ObserveHistogram(name string, value float64, labelValues Labels) error
	ObserveSummary(name string, value float64, labelValues Labels) error
}

Metricser define a interface for our metrics manager.

func Factory

func Factory(env env.IEnv, logger log.ILog) IMetric

func NewInstancePrometheus

func NewInstancePrometheus(env env.IEnv, logger log.ILog) IMetric

type Labels

type Labels map[string]string

type LabelsKeys

type LabelsKeys []string

type MetricType

type MetricType string

const (
	Counter   MetricType = "Counter"
	Gauge     MetricType = "Gauge"
	Histogram MetricType = "Histogram"
	Summary   MetricType = "Summary"
)

type Prometheus

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

func (*Prometheus) CreateMetric

func (m *Prometheus) CreateMetric(metricType MetricType, name, help string, labelKeys LabelsKeys)

func (*Prometheus) IncrementCounter

func (m *Prometheus) IncrementCounter(name string, labelValues Labels) error

func (*Prometheus) ObserveHistogram

func (m *Prometheus) ObserveHistogram(name string, value float64, labelValues Labels) error

func (*Prometheus) ObserveSummary

func (m *Prometheus) ObserveSummary(name string, value float64, labelValues Labels) error

func (*Prometheus) SetGauge

func (m *Prometheus) SetGauge(name string, value float64, labelValues Labels) error