common

package

v0.3.1 Latest Latest Go to latest Published: Feb 21, 2023 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Package common defines reusable objects for APIs.

This section is empty.

View Source

var PositionKey = contextPositionKey{}

PositionKey is a context key to store the module position.

func SetPosition(ctx context.Context, fn func(p Position) Position) context.Context

SetPosition sets a position returned from fn to attach it to ctx, then return a new context.

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

Error wraps a error msg.

func NewError(tpl string, args ...any) Error

NewError returns a new Error.

func (e Error) Msg() string

Msg shows the string msg.

type ItemID uint64

ItemID identity an item in a series.

type KindVersion struct {
	Version string
	Kind    string
}

KindVersion contains elements which identify the API uniquely.

func (s *KindVersion) String() string

type Position struct {
	Module   string
	Database string
	Shard    string
	Segment  string
	Block    string
	KV       string
}

Position is stored in the context. The logger could attach it for debugging.

func (p Position) Labels() prometheus.Labels

Labels converts Position to Prom Labels.

type SeriesID uint64

SeriesID identity a series in a shard.

func (s SeriesID) Marshal() []byte

Marshal encodes series id to bytes.

type ShardID uint32

ShardID identity a shard in a tsdb.