prometheus

Documentation

Index

• type Fanout
  • func NewFanout(children []storage.Appendable, componentID string, ...) *Fanout
  • func (f *Fanout) Appender(ctx context.Context) storage.Appender
  • func (f *Fanout) UpdateChildren(children []storage.Appendable)
• type Interceptor
  • func NewInterceptor(next storage.Appendable, ls labelstore.LabelStore, opts ...InterceptorOption) *Interceptor
  • func (f *Interceptor) Appender(ctx context.Context) storage.Appender
• type InterceptorOption
  • func WithAppendHook(...) InterceptorOption
  • func WithExemplarHook(...) InterceptorOption
  • func WithHistogramHook(...) InterceptorOption
  • func WithMetadataHook(...) InterceptorOption
• type NoopMetadataStore
  • func (ms NoopMetadataStore) GetMetadata(familyName string) (scrape.MetricMetadata, bool)
  • func (ms NoopMetadataStore) LengthMetadata() int
  • func (ms NoopMetadataStore) ListMetadata() []scrape.MetricMetadata
  • func (ms NoopMetadataStore) SizeMetadata() int

Types

type Fanout

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

Fanout supports the default Flow style of appendables since it can go to multiple outputs. It also allows the intercepting of appends.

func NewFanout

func NewFanout(children []storage.Appendable, componentID string, register prometheus.Registerer, ls labelstore.LabelStore) *Fanout

NewFanout creates a fanout appendable.

func (*Fanout) Appender

func (f *Fanout) Appender(ctx context.Context) storage.Appender

Appender satisfies the Appendable interface.

func (*Fanout) UpdateChildren

func (f *Fanout) UpdateChildren(children []storage.Appendable)

UpdateChildren allows changing of the children of the fanout.

type Interceptor

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

Interceptor is a storage.Appendable which invokes callback functions upon getting data. Interceptor should not be modified once created. All callback fields are optional.

func NewInterceptor

func NewInterceptor(next storage.Appendable, ls labelstore.LabelStore, opts ...InterceptorOption) *Interceptor

NewInterceptor creates a new Interceptor storage.Appendable. Options can be provided to NewInterceptor to install custom hooks for different methods.

func (*Interceptor) Appender

func (f *Interceptor) Appender(ctx context.Context) storage.Appender

Appender satisfies the Appendable interface.

type InterceptorOption

type InterceptorOption func(*Interceptor)

InterceptorOption is an option argument passed to NewInterceptor.

func WithAppendHook

func WithAppendHook(f func(ref storage.SeriesRef, l labels.Labels, t int64, v float64, next storage.Appender) (storage.SeriesRef, error)) InterceptorOption

WithAppendHook returns an InterceptorOption which hooks into calls to Append.

func WithExemplarHook

func WithExemplarHook(f func(ref storage.SeriesRef, l labels.Labels, e exemplar.Exemplar, next storage.Appender) (storage.SeriesRef, error)) InterceptorOption

WithExemplarHook returns an InterceptorOption which hooks into calls to AppendExemplar.

func WithHistogramHook

func WithHistogramHook(f func(ref storage.SeriesRef, l labels.Labels, t int64, h *histogram.Histogram, fh *histogram.FloatHistogram, next storage.Appender) (storage.SeriesRef, error)) InterceptorOption

WithHistogramHook returns an InterceptorOption which hooks into calls to AppendHistogram.

func WithMetadataHook

func WithMetadataHook(f func(ref storage.SeriesRef, l labels.Labels, m metadata.Metadata, next storage.Appender) (storage.SeriesRef, error)) InterceptorOption

WithMetadataHook returns an InterceptorOption which hooks into calls to UpdateMetadata.

type NoopMetadataStore

type NoopMetadataStore map[string]scrape.MetricMetadata

NoopMetadataStore implements the MetricMetadataStore interface.

func (NoopMetadataStore) GetMetadata

func (ms NoopMetadataStore) GetMetadata(familyName string) (scrape.MetricMetadata, bool)

GetMetadata implements the MetricMetadataStore interface.

func (NoopMetadataStore) LengthMetadata

func (ms NoopMetadataStore) LengthMetadata() int

LengthMetadata implements the MetricMetadataStore interface.

func (NoopMetadataStore) ListMetadata

func (ms NoopMetadataStore) ListMetadata() []scrape.MetricMetadata

ListMetadata implements the MetricMetadataStore interface.

func (NoopMetadataStore) SizeMetadata

func (ms NoopMetadataStore) SizeMetadata() int

SizeMetadata implements the MetricMetadataStore interface.