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

• Constants
• Variables
• type Measure
• type Query
• type Service
  • func NewService(_ context.Context, metadata metadata.Repo, repo discovery.ServiceRepo, ...) (Service, error)

Constants

const (

	// TopNTagFamily is the identity of a tag family which contains the topN calculated result.
	TopNTagFamily = "__topN__"
)

Variables

var (

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

var (

	// TopNValueFieldSpec denotes the field specification of the topN calculated result.
	TopNValueFieldSpec = &databasev1.FieldSpec{
		Name:              "value",
		FieldType:         databasev1.FieldType_FIELD_TYPE_INT,
		EncodingMethod:    databasev1.EncodingMethod_ENCODING_METHOD_GORILLA,
		CompressionMethod: databasev1.CompressionMethod_COMPRESSION_METHOD_ZSTD,
	}
)

Types

type Measure

type Measure interface {
	io.Closer
	Shards(entity tsdb.Entity) ([]tsdb.Shard, error)
	CompanionShards(metadata *commonv1.Metadata) ([]tsdb.Shard, error)
	Shard(id common.ShardID) (tsdb.Shard, error)
	ParseTagFamily(family string, item tsdb.Item) (*modelv1.TagFamily, error)
	ParseField(name string, item tsdb.Item) (*measurev1.DataPoint_Field, error)
	GetSchema() *databasev1.Measure
	GetIndexRules() []*databasev1.IndexRule
	GetInterval() time.Duration
}

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 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, repo discovery.ServiceRepo, pipeline queue.Queue) (Service, error)

NewService returns a new service.