common

Documentation

Overview

Package common defines reusable objects for APIs.

Index

• Variables
• func LabelNames() []string
• func SetPosition(ctx context.Context, fn func(p Position) Position) context.Context
• func ShardLabelNames() []string
• type Error
  • func NewError(tpl string, args ...any) Error
  • func (e Error) Msg() string
• type ItemID
• type KindVersion
  • func (s *KindVersion) String() string
• type Node
  • func GenerateNode(grpcPort, httpPort *uint32) (Node, error)
• type NodeHostProvider
  • func ParseNodeHostProvider(s string) (NodeHostProvider, error)
  • func (n *NodeHostProvider) String() string
• type Position
  • func GetPosition(ctx context.Context) Position
  • func (p Position) LabelValues() []string
  • func (p Position) ShardLabelValues() []string
• type SeriesID
  • func (s SeriesID) Marshal() []byte
• type ShardID

Variables

var (
	// FlagNodeHost is the node id from flag.
	FlagNodeHost string
	// FlagNodeHostProvider is the node id provider from flag.
	FlagNodeHostProvider NodeHostProvider
)

var ContextNodeKey = contextNodeKey{}

ContextNodeKey is a context key to store the node id.

var ContextNodeRolesKey = contextNodeRolesKey{}

ContextNodeRolesKey is a context key to store the node roles.

Functions

func LabelNames

func LabelNames() []string

LabelNames returns the label names of Position.

func SetPosition

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.

func ShardLabelNames

func ShardLabelNames() []string

ShardLabelNames returns the label names of Position. It is used for shard level metrics.

Types

type Error

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

Error wraps a error msg.

func NewError

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

NewError returns a new Error.

func (Error) Msg

func (e Error) Msg() string

Msg shows the string msg.

type ItemID

type ItemID uint64

ItemID identities an item in a series.

type KindVersion

type KindVersion struct {
	Version string
	Kind    string
}

KindVersion contains elements which identify the API uniquely.

func (*KindVersion) String

func (s *KindVersion) String() string

type Node

type Node struct {
	NodeID      string
	GrpcAddress string
	HTTPAddress string
}

Node contains the node id and address.

func GenerateNode

func GenerateNode(grpcPort, httpPort *uint32) (Node, error)

GenerateNode generates a node id.

type NodeHostProvider

type NodeHostProvider int

NodeHostProvider is the provider of node id.

const (
	NodeHostProviderHostname NodeHostProvider = iota
	NodeHostProviderIP
	NodeHostProviderFlag
)

NodeIDProvider constants.

func ParseNodeHostProvider

func ParseNodeHostProvider(s string) (NodeHostProvider, error)

ParseNodeHostProvider parses the string to NodeIDProvider.

func (*NodeHostProvider) String

func (n *NodeHostProvider) String() string

String returns the string representation of NodeIDProvider.

type Position

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

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

func GetPosition

func GetPosition(ctx context.Context) Position

GetPosition returns the position from ctx.

func (Position) LabelValues

func (p Position) LabelValues() []string

LabelValues returns the label values of Position.

func (Position) ShardLabelValues

func (p Position) ShardLabelValues() []string

ShardLabelValues returns the label values of Position. It is used for shard level metrics.

type SeriesID

type SeriesID uint64

SeriesID identities a series in a shard.

func (SeriesID) Marshal

func (s SeriesID) Marshal() []byte

Marshal encodes series id to bytes.

type ShardID

type ShardID uint32

ShardID identities a shard in a tsdb.