prometheus

Documentation

Index

• func NewPrometheusQueryable(opts PrometheusOptions) promstorage.Queryable
• type ContextKey
• type PrometheusOptions
• type RemoteReadFlags
• type StorageErr
  • func NewStorageErr(err error) *StorageErr
  • func (e *StorageErr) Error() string
  • func (e *StorageErr) Unwrap() error

Functions

func NewPrometheusQueryable

func NewPrometheusQueryable(opts PrometheusOptions) promstorage.Queryable

NewPrometheusQueryable returns a new prometheus queryable backed by a m3 storage.

Types

type ContextKey

type ContextKey string

ContextKey is the context key type.

const (
	// FetchOptionsContextKey is the context key for fetch options.
	FetchOptionsContextKey ContextKey = "fetch-options"

	// BlockResultMetadataFnKey is the context key for a function to receive block metadata results.
	BlockResultMetadataFnKey ContextKey = "block-meta-result-fn"
)

type PrometheusOptions

type PrometheusOptions struct {
	Storage           storage.Storage
	InstrumentOptions instrument.Options
}

PrometheusOptions are options to create a prometheus queryable backed by a m3 storage.

type RemoteReadFlags

type RemoteReadFlags struct {
	Limited bool
}

RemoteReadFlags is a set of flags for storage remote read requests.

type StorageErr

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

StorageErr wraps all errors returned by the storage layer. This allows the http handlers that call the Prometheus library directly to distinguish prometheus library errors and remote storage errors.

func NewStorageErr

func NewStorageErr(err error) *StorageErr

NewStorageErr wraps the provided error as a StorageErr.

func (*StorageErr) Error

func (e *StorageErr) Error() string

Error returns the error string for the underlying error.

func (*StorageErr) Unwrap

func (e *StorageErr) Unwrap() error

Unwrap returns the underlying error.