measure

package

v0.5.0 Latest Latest Go to latest Published: Oct 17, 2023 License: Apache-2.0 Imports: 47 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/apache/skywalking-banyandb

Links

Open Source Insights

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 SchemaService
- func NewPortableRepository(metadata metadata.Repo, l *logger.Logger) SchemaService
type Service
- func NewService(_ context.Context, metadata metadata.Repo, pipeline queue.Server) (Service, error)

Constants ¶

View Source

const (

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

Variables ¶

View Source

var (

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

View Source

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,
	}
)

Functions ¶

This section is empty.

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 SchemaService ¶ added in v0.5.0

type SchemaService interface {
	Query
	Close()
}

SchemaService allows querying schema information.

func NewPortableRepository ¶ added in v0.5.0

func NewPortableRepository(metadata metadata.Repo, l *logger.Logger) 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) (Service, error)

NewService returns a new service.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL