metric_manager

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 Labels
• type LabelsKeys
• type MetricManager
  • func NewMetricManager() *MetricManager
  • func (m *MetricManager) CreateMetric(metricType MetricType, name, help string, labelKeys LabelsKeys)
  • func (m *MetricManager) IncrementCounter(name string, labelValues Labels) error
  • func (m *MetricManager) ObserveHistogram(name string, value float64, labelValues Labels) error
  • func (m *MetricManager) ObserveSummary(name string, value float64, labelValues Labels) error
  • func (m *MetricManager) SetGauge(name string, value float64, labelValues Labels) error
• type MetricManagerInterface
• type MetricType

Types

type Labels

type Labels map[string]string

type LabelsKeys

type LabelsKeys []string

type MetricManager

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

func NewMetricManager

func NewMetricManager() *MetricManager

func (*MetricManager) CreateMetric

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

func (*MetricManager) IncrementCounter

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

func (*MetricManager) ObserveHistogram

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

func (*MetricManager) ObserveSummary

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

func (*MetricManager) SetGauge

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

type MetricManagerInterface

type MetricManagerInterface 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.

type MetricType

type MetricType int

const (
	Counter MetricType = iota
	Gauge
	Histogram
	Summary
)