storage

Documentation

Index

• func GetQueryTerminatorTagName(query string) []byte
• func TranslateQueryToMatchersWithTerminator(query string) (models.Matchers, error)
• type DataOptions
• type FetchOptions
• type FetchResult
  • func NewFetchResult(ctx context.Context, seriesList []*ts.Series) *FetchResult
  • func (fr *FetchResult) Close() error
  • func (fr *FetchResult) Reset()
• type Storage
  • func NewM3WrappedStorage(m3storage storage.Storage, enforcer cost.ChainedEnforcer) Storage

Functions

func GetQueryTerminatorTagName

func GetQueryTerminatorTagName(query string) []byte

GetQueryTerminatorTagName will return the name for the terminator matcher in the given pattern. This is useful for filtering out any additional results.

func TranslateQueryToMatchersWithTerminator

func TranslateQueryToMatchersWithTerminator(
	query string,
) (models.Matchers, error)

TranslateQueryToMatchersWithTerminator converts a graphite query to tag matcher pairs, and adds a terminator matcher to the end.

Types

type DataOptions

type DataOptions struct {
	Timeout time.Duration // Whether to use a custom timeout, zero if no or positive if yes
}

DataOptions provide data context

type FetchOptions

type FetchOptions struct {
	StartTime time.Time // The start time for the fetch
	EndTime   time.Time // The end time for the fetch
	DataOptions
}

FetchOptions provide context to a fetch

type FetchResult

type FetchResult struct {
	SeriesList []*ts.Series // The aggregated list of results across all underlying storage calls
}

FetchResult provides a fetch result and meta information

func NewFetchResult

func NewFetchResult(ctx context.Context, seriesList []*ts.Series) *FetchResult

NewFetchResult is a convenience method for creating a FetchResult

func (*FetchResult) Close

func (fr *FetchResult) Close() error

Close will return the fetch result to the pool.

func (*FetchResult) Reset

func (fr *FetchResult) Reset()

Reset will wipe out existing fetch result data.

type Storage

type Storage interface {
	// FetchByQuery fetches timeseries data based on a query
	FetchByQuery(
		ctx context.Context, query string, opts FetchOptions,
	) (*FetchResult, error)
}

Storage provides an interface for retrieving timeseries values or names based upon a query or path

func NewM3WrappedStorage

func NewM3WrappedStorage(
	m3storage storage.Storage,
	enforcer cost.ChainedEnforcer,
) Storage

NewM3WrappedStorage creates a graphite storage wrapper around an m3query storage instance.