ingester

Documentation

Index

• Variables
• type Config
  • func (cfg *Config) RegisterFlagsAndApplyDefaults(prefix string, f *flag.FlagSet)
• type Ingester
  • func New(cfg Config, store storage.Store, limits *overrides.Overrides, ...) (*Ingester, error)
  • func (i *Ingester) CheckReady(ctx context.Context) error
  • func (i *Ingester) FindTraceByID(ctx context.Context, req *tempopb.TraceByIDRequest) (*tempopb.TraceByIDResponse, error)
  • func (i *Ingester) Flush()
  • func (i *Ingester) FlushHandler(w http.ResponseWriter, _ *http.Request)
  • func (i *Ingester) PushBytes(ctx context.Context, req *tempopb.PushBytesRequest) (*tempopb.PushResponse, error)
  • func (i *Ingester) PushBytesV2(ctx context.Context, req *tempopb.PushBytesRequest) (*tempopb.PushResponse, error)
  • func (i *Ingester) SearchBlock(context.Context, *tempopb.SearchBlockRequest) (*tempopb.SearchResponse, error)
  • func (i *Ingester) SearchRecent(ctx context.Context, req *tempopb.SearchRequest) (*tempopb.SearchResponse, error)
  • func (i *Ingester) SearchTagValues(ctx context.Context, req *tempopb.SearchTagValuesRequest) (*tempopb.SearchTagValuesResponse, error)
  • func (i *Ingester) SearchTags(ctx context.Context, req *tempopb.SearchTagsRequest) (*tempopb.SearchTagsResponse, error)
  • func (i *Ingester) ShutdownHandler(w http.ResponseWriter, _ *http.Request)
  • func (i *Ingester) TransferOut(ctx context.Context) error
• type Limiter
  • func NewLimiter(limits *overrides.Overrides, ring RingCount, replicationFactor int) *Limiter
  • func (l *Limiter) AssertMaxTracesPerUser(userID string, traces int) error
• type RingCount

Variables

var ErrReadOnly = errors.New("Ingester is shutting down")

ErrReadOnly is returned when the ingester is shutting down and a push was attempted.

var (
	ErrTraceMissing = errors.New("Trace missing")
)

Errors returned on Query.

Types

type Config

type Config struct {
	LifecyclerConfig ring.LifecyclerConfig `yaml:"lifecycler,omitempty"`

	ConcurrentFlushes    int           `yaml:"concurrent_flushes"`
	FlushCheckPeriod     time.Duration `yaml:"flush_check_period"`
	FlushOpTimeout       time.Duration `yaml:"flush_op_timeout"`
	MaxTraceIdle         time.Duration `yaml:"trace_idle_period"`
	MaxBlockDuration     time.Duration `yaml:"max_block_duration"`
	MaxBlockBytes        uint64        `yaml:"max_block_bytes"`
	CompleteBlockTimeout time.Duration `yaml:"complete_block_timeout"`
	OverrideRingKey      string        `yaml:"override_ring_key"`
}

Config for an ingester.

func (*Config) RegisterFlagsAndApplyDefaults

func (cfg *Config) RegisterFlagsAndApplyDefaults(prefix string, f *flag.FlagSet)

RegisterFlagsAndApplyDefaults registers the flags.

type Ingester

type Ingester struct {
	services.Service
	// contains filtered or unexported fields
}

Ingester builds blocks out of incoming traces

func New

func New(cfg Config, store storage.Store, limits *overrides.Overrides, reg prometheus.Registerer) (*Ingester, error)

New makes a new Ingester.

func (*Ingester) CheckReady

func (i *Ingester) CheckReady(ctx context.Context) error

func (*Ingester) FindTraceByID

func (i *Ingester) FindTraceByID(ctx context.Context, req *tempopb.TraceByIDRequest) (*tempopb.TraceByIDResponse, error)

FindTraceByID implements tempopb.Querier.f

func (*Ingester) Flush

func (i *Ingester) Flush()

Flush triggers a flush of all in memory traces to disk. This is called by the lifecycler on shutdown and will put our traces in the WAL to be replayed.

func (*Ingester) FlushHandler

func (i *Ingester) FlushHandler(w http.ResponseWriter, _ *http.Request)

FlushHandler calls sweepAllInstances(true) which will force push all traces into the WAL and force

mark all head blocks as ready to flush.

func (*Ingester) PushBytes

func (i *Ingester) PushBytes(ctx context.Context, req *tempopb.PushBytesRequest) (*tempopb.PushResponse, error)

PushBytes implements tempopb.Pusher.PushBytes. Traces pushed to this endpoint are expected to be in the formats

defined by ./pkg/model/v1

This push function is extremely inefficient and is only provided as a migration path from the v1->v2 encodings

func (*Ingester) PushBytesV2

func (i *Ingester) PushBytesV2(ctx context.Context, req *tempopb.PushBytesRequest) (*tempopb.PushResponse, error)

PushBytes implements tempopb.Pusher.PushBytes. Traces pushed to this endpoint are expected to be in the formats

defined by ./pkg/model/v2

func (*Ingester) SearchBlock

func (i *Ingester) SearchBlock(context.Context, *tempopb.SearchBlockRequest) (*tempopb.SearchResponse, error)

SearchBlock only exists here to fulfill the protobuf interface. The ingester will never support backend search

func (*Ingester) SearchRecent

func (i *Ingester) SearchRecent(ctx context.Context, req *tempopb.SearchRequest) (*tempopb.SearchResponse, error)

func (*Ingester) SearchTagValues

func (i *Ingester) SearchTagValues(ctx context.Context, req *tempopb.SearchTagValuesRequest) (*tempopb.SearchTagValuesResponse, error)

func (*Ingester) SearchTags

func (i *Ingester) SearchTags(ctx context.Context, req *tempopb.SearchTagsRequest) (*tempopb.SearchTagsResponse, error)

func (*Ingester) ShutdownHandler

func (i *Ingester) ShutdownHandler(w http.ResponseWriter, _ *http.Request)

ShutdownHandler handles a graceful shutdown for an ingester. It does the following things in order * Stop incoming writes by exiting from the ring * Flush all blocks to backend

func (*Ingester) TransferOut

func (i *Ingester) TransferOut(ctx context.Context) error

TransferOut implements ring.Lifecycler.

type Limiter

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

Limiter implements primitives to get the maximum number of traces an ingester can handle for a specific tenant

func NewLimiter

func NewLimiter(limits *overrides.Overrides, ring RingCount, replicationFactor int) *Limiter

NewLimiter makes a new limiter

func (*Limiter) AssertMaxTracesPerUser

func (l *Limiter) AssertMaxTracesPerUser(userID string, traces int) error

AssertMaxTracesPerUser ensures limit has not been reached compared to the current number of streams in input and returns an error if so.

type RingCount

type RingCount interface {
	HealthyInstancesCount() int
}

RingCount is the interface exposed by a ring implementation which allows to count members