Documentation
¶
Index ¶
- Constants
- func GetErrorCode(err error) string
- func NewMetricsCollector(...) prometheus.Collector
- func NewPrometheusMetricManager(metricsEndpoint string, mux *http.ServeMux) *prometheusMetricManager
- func ProcessMetricsData(metricsReader io.Reader) (map[string]*dto.MetricFamily, error)
- func ProcessMetricsDataAsStream(metricsReader io.Reader) iter.Seq2[*dto.MetricFamily, error]
- type FakeMetricsManager
- type FakePrometheusMetricManager
- type Manager
- type PrometheusMetricManager
Constants ¶
const (
SocketName = "metrics.sock"
)
Variables ¶
This section is empty.
Functions ¶
func GetErrorCode ¶ added in v1.21.0
func NewMetricsCollector ¶ added in v1.6.0
func NewMetricsCollector(socketBasePath, emptyDirBasePath, namespace, podName, podUID, volumeName string, labels map[string]string, clientset clientset.Interface, streamMetrics bool) prometheus.Collector
NewMetricsCollector returns a new Collector exposing metrics read from the give path.
func NewPrometheusMetricManager ¶ added in v1.21.0
func NewPrometheusMetricManager(metricsEndpoint string, mux *http.ServeMux) *prometheusMetricManager
NewPrometheusMetricManager initializes and returns a prometheusMetricManager. This manager is intended to encapsulate Prometheus metric definitions and registrations used by this application. New metrics can be added here. Note that this manager is orthogonal to the metrics collector above. Use the metrics collector instead if your component is running on user nodes.
func ProcessMetricsData ¶ added in v1.6.0
ProcessMetricsData processes metrics that follow Prometheus text format: https://prometheus.io/docs/instrumenting/exposition_formats/, returning its MetricFamily.
func ProcessMetricsDataAsStream ¶ added in v1.23.1
ProcessMetricsDataAsStream processes metrics that follow Prometheus text format, returning an iterator of MetricFamily.
Types ¶
type FakeMetricsManager ¶ added in v1.6.0
type FakeMetricsManager struct {
// contains filtered or unexported fields
}
FakeMetricsManager is a fake implementation of the MetricsManager interface for testing.
func NewFakeMetricsManager ¶ added in v1.22.3
func NewFakeMetricsManager() *FakeMetricsManager
NewFakeMetricsManager returns a new FakeMetricsManager.
func (*FakeMetricsManager) GetCollectors ¶ added in v1.22.3
func (f *FakeMetricsManager) GetCollectors() map[string]string
GetCollectors returns the map of registered collectors.
func (*FakeMetricsManager) InitializeHTTPHandler ¶ added in v1.6.0
func (*FakeMetricsManager) InitializeHTTPHandler()
InitializeHTTPHandler is a no-op.
func (*FakeMetricsManager) RegisterMetricsCollector ¶ added in v1.6.0
func (f *FakeMetricsManager) RegisterMetricsCollector(targetPath, _, _, bucketName, nodeName string)
RegisterMetricsCollector records the registration of a metrics collector.
func (*FakeMetricsManager) UnregisterMetricsCollector ¶ added in v1.6.0
func (f *FakeMetricsManager) UnregisterMetricsCollector(targetPath, nodeName string)
UnregisterMetricsCollector records the unregistration of a metrics collector.
type FakePrometheusMetricManager ¶ added in v1.21.0
type FakePrometheusMetricManager struct {
// contains filtered or unexported fields
}
func (*FakePrometheusMetricManager) InitializeHTTPHandler ¶ added in v1.21.0
func (*FakePrometheusMetricManager) InitializeHTTPHandler()
func (*FakePrometheusMetricManager) RecordSyncPVMetric ¶ added in v1.21.0
func (m *FakePrometheusMetricManager) RecordSyncPVMetric(err error)
func (*FakePrometheusMetricManager) RecordSyncPodMetric ¶ added in v1.21.0
func (m *FakePrometheusMetricManager) RecordSyncPodMetric(err error)
type Manager ¶
type PrometheusMetricManager ¶ added in v1.21.0
type PrometheusMetricManager interface {
InitializeHTTPHandler()
RecordSyncPVMetric(err error)
RecordSyncPodMetric(err error)
}
func NewFakePrometheusMetricsManager ¶ added in v1.21.0
func NewFakePrometheusMetricsManager() PrometheusMetricManager
Source Files