client

Documentation

Overview

This file was copied from the grafana/vali project https://github.com/credativ/vali/blob/v2.2.4/cmd/fluent-bit/buffer.go

Modifications Copyright (c) 2020 SAP SE or an SAP affiliate company. All rights reserved.

This file was copied from the grafana/vali project https://github.com/credativ/vali/blob/v2.2.4/cmd/fluent-bit/buffer.go

Modifications Copyright (c) 2022 SAP SE or an SAP affiliate company. All rights reserved.

This file was copied from the grafana/vali project https://github.com/credativ/vali/blob/v2.2.4/cmd/fluent-bit/dque.go

Modifications Copyright (c) 2021 SAP SE or an SAP affiliate company. All rights reserved.

Index

• Constants
• type Entry
• type FakeValiClient
  • func (c *FakeValiClient) GetEndPoint() string
  • func (c *FakeValiClient) Handle(labels model.LabelSet, timestamp time.Time, line string) error
  • func (c *FakeValiClient) Stop()
  • func (c *FakeValiClient) StopWait()
• type NewValiClientDecoratorFunc
• type NewValiClientFunc
• type Options
• type ValiClient
  • func NewBuffer(cfg config.Config, logger log.Logger, ...) (ValiClient, error)
  • func NewBufferDecorator(cfg config.Config, newClientFunc NewValiClientFunc, logger log.Logger) (ValiClient, error)
  • func NewClient(cfg config.Config, logger log.Logger, options Options) (ValiClient, error)
  • func NewDque(cfg config.Config, logger log.Logger, ...) (ValiClient, error)
  • func NewMultiTenantClientDecorator(cfg config.Config, newClient NewValiClientFunc, logger log.Logger) (ValiClient, error)
  • func NewPackClientDecorator(cfg config.Config, newClient NewValiClientFunc, logger log.Logger) (ValiClient, error)
  • func NewPromtailClient(cfg client.Config, logger log.Logger) (ValiClient, error)
  • func NewRemoveMultiTenantIdClientDecorator(cfg config.Config, newClient NewValiClientFunc, logger log.Logger) (ValiClient, error)
  • func NewRemoveTenantIdClientDecorator(cfg config.Config, newClient NewValiClientFunc, logger log.Logger) (ValiClient, error)
  • func NewSortedClientDecorator(cfg config.Config, newClient NewValiClientFunc, logger log.Logger) (ValiClient, error)

Constants

const (
	// MultiTenantClientLabel is the reserved label for multiple client specification
	MultiTenantClientLabel = "__gardener_multitenant_id__"
	// MultiTenantClientsSeparator separates the client names in MultiTenantClientLabel
	MultiTenantClientsSeparator = ";"
)

Types

type Entry

type Entry struct {
	Labels model.LabelSet
	logproto.Entry
}

Entry represent a Vali log record.

type FakeValiClient

type FakeValiClient struct {
	// IsStopped show whether the client is stopped or not
	IsStopped bool
	// IsGracefullyStopped show whether the client is gracefully topped or not
	IsGracefullyStopped bool
	// Entries is slice of all received entries
	Entries []Entry
	Mu      sync.Mutex
}

FakeValiClient mocks ValiClient

func (*FakeValiClient) GetEndPoint

func (c *FakeValiClient) GetEndPoint() string

GetEndPoint returns the target logging backend endpoint

func (*FakeValiClient) Handle

func (c *FakeValiClient) Handle(labels model.LabelSet, timestamp time.Time, line string) error

Handle processes and stores the received entries.

func (*FakeValiClient) Stop

func (c *FakeValiClient) Stop()

Stop stops the client

func (*FakeValiClient) StopWait

func (c *FakeValiClient) StopWait()

StopWait gracefully stops the client

type NewValiClientDecoratorFunc

type NewValiClientDecoratorFunc func(cfg config.Config, client ValiClient, logger log.Logger) (ValiClient, error)

NewValiClientDecoratorFunc return ValiClient which wraps another ValiClient

type NewValiClientFunc

type NewValiClientFunc func(cfg config.Config, logger log.Logger) (ValiClient, error)

NewValiClientFunc returns a ValiClient on success.

type Options

type Options struct {
	// RemoveTenantID flag removes the "__tenant_id_" label
	RemoveTenantID bool
	// MultiTenantClient glaf removes the "__gardener_multitenant_id__" label
	MultiTenantClient bool
	// PreservedLabels is the labels to preserve
	PreservedLabels model.LabelSet
}

Options for creating a Vali client

type ValiClient

type ValiClient interface {
	// Handle processes logs and then sends them to Vali ingester
	Handle(labels model.LabelSet, time time.Time, entry string) error
	// Stop shut down the client immediately without waiting to send the saved logs
	Stop()
	// StopWait stops the client of receiving new logs and waits all saved logs to be sent until shuting down
	StopWait()
	// GetEndPoint returns the target logging backend endpoint
	GetEndPoint() string
}

ValiClient represents an instance which sends logs to Vali ingester

func NewBuffer

func NewBuffer(cfg config.Config, logger log.Logger, newClientFunc func(cfg config.Config, logger log.Logger) (ValiClient, error)) (ValiClient, error)

NewBuffer makes a new buffered Client.

func NewBufferDecorator

func NewBufferDecorator(cfg config.Config, newClientFunc NewValiClientFunc, logger log.Logger) (ValiClient, error)

NewBufferDecorator makes a new buffered Client.

func NewClient

func NewClient(cfg config.Config, logger log.Logger, options Options) (ValiClient, error)

NewClient creates a new client based on the fluentbit configuration.

func NewDque

func NewDque(cfg config.Config, logger log.Logger, newClientFunc func(cfg config.Config,
	logger log.Logger) (ValiClient, error)) (ValiClient, error)

NewDque makes a new dque vali client

func NewMultiTenantClientDecorator

func NewMultiTenantClientDecorator(cfg config.Config, newClient NewValiClientFunc, logger log.Logger) (ValiClient, error)

NewMultiTenantClientDecorator returns Vali client which supports more than one tenant id specified under `_gardener_multitenamt_id__` label. The tenants are separated by semicolon.

func NewPackClientDecorator

func NewPackClientDecorator(cfg config.Config, newClient NewValiClientFunc, logger log.Logger) (ValiClient, error)

NewPackClientDecorator return vali client which pack all the labels except the explicitly excluded ones and forward them the the wrapped client.

func NewPromtailClient

func NewPromtailClient(cfg client.Config, logger log.Logger) (ValiClient, error)

NewPromtailClient return ValiClient which wraps the original Promtail client. It increments the ForwardedLogs counter on successful call of the Handle function. !!!This must be the bottom wrapper!!!

func NewRemoveMultiTenantIdClientDecorator

func NewRemoveMultiTenantIdClientDecorator(cfg config.Config, newClient NewValiClientFunc, logger log.Logger) (ValiClient, error)

NewRemoveMultiTenantIdClientDecorator wraps vali client which removes the __gardener_multitenant_id__ label from the label set

func NewRemoveTenantIdClientDecorator

func NewRemoveTenantIdClientDecorator(cfg config.Config, newClient NewValiClientFunc, logger log.Logger) (ValiClient, error)

NewRemoveTenantIdClientDecorator return vali client which removes the __tenant_id__ value fro the label set

func NewSortedClientDecorator

func NewSortedClientDecorator(cfg config.Config, newClient NewValiClientFunc, logger log.Logger) (ValiClient, error)

NewSortedClientDecorator returns client which sorts the logs based their timestamp.