measure

Documentation

Overview

Package measure implements a time-series-based storage which is consists of a sequence of data points. Each data point contains tags and fields. They arrive in a fixed interval. A data point could be updated by one with the identical entity(series_id) and timestamp.

Index

• Variables
• type Measure
• type Query
• type SchemaService
  • func NewPortableRepository(metadata metadata.Repo, l *logger.Logger, metrics *resourceSchema.Metrics) SchemaService
• type Service
  • func NewService(_ context.Context, metadata metadata.Repo, pipeline queue.Server, ...) (Service, error)

Variables

var (

	// ErrMeasureNotExist denotes a measure doesn't exist in the metadata repo.
	ErrMeasureNotExist = errors.New("measure doesn't exist")
)

Types

type Measure

type Measure interface {
	io.Closer
	Query(ctx context.Context, opts model.MeasureQueryOptions) (model.MeasureQueryResult, error)
	GetSchema() *databasev1.Measure
	GetIndexRules() []*databasev1.IndexRule
}

Measure allows inspecting measure data points' details.

type Query

type Query interface {
	LoadGroup(name string) (resourceSchema.Group, bool)
	Measure(measure *commonv1.Metadata) (Measure, error)
}

Query allow to retrieve measure data points.

type SchemaService

type SchemaService interface {
	Query
	Close()
}

SchemaService allows querying schema information.

func NewPortableRepository

func NewPortableRepository(metadata metadata.Repo, l *logger.Logger, metrics *resourceSchema.Metrics) SchemaService

NewPortableRepository creates a new portable repository.

type Service

type Service interface {
	run.PreRunner
	run.Config
	run.Service
	Query
}

Service allows inspecting the measure data points.

func NewService

func NewService(_ context.Context, metadata metadata.Repo, pipeline queue.Server, metricPipeline queue.Server, omr observability.MetricsRegistry) (Service, error)

NewService returns a new service.