client

Documentation

Overview

This file was copied from the grafana/loki project https://github.com/grafana/loki/blob/v1.6.0/cmd/fluent-bit/buffer.go

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

Index

• Constants
• func NewBufferDecorator(cfg config.Config, newClientFunc NewLokiClientFunc, logger log.Logger) (types.LokiClient, error)
• func NewClient(cfg config.Config, logger log.Logger, options Options) (types.LokiClient, error)
• func NewMultiTenantClientDecorator(cfg config.Config, newClient NewLokiClientFunc, logger log.Logger) (types.LokiClient, error)
• func NewPackClientDecorator(cfg config.Config, newClient NewLokiClientFunc, logger log.Logger) (types.LokiClient, error)
• func NewPromtailClient(cfg client.Config, logger log.Logger) (types.LokiClient, error)
• func NewRemoveMultiTenantIdClientDecorator(cfg config.Config, newClient NewLokiClientFunc, logger log.Logger) (types.LokiClient, error)
• func NewRemoveTenantIdClientDecorator(cfg config.Config, newClient NewLokiClientFunc, logger log.Logger) (types.LokiClient, error)
• func NewSortedClientDecorator(cfg config.Config, newClient NewLokiClientFunc, logger log.Logger) (types.LokiClient, error)
• type Entry
• type FakeLokiClient
  • func (c *FakeLokiClient) Handle(labels model.LabelSet, timestamp time.Time, line string) error
  • func (c *FakeLokiClient) Stop()
  • func (c *FakeLokiClient) StopWait()
• type LokiClient
• type NewLokiClientDecoratorFunc
• type NewLokiClientFunc
• type Options

Constants

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

Functions

func NewBufferDecorator

func NewBufferDecorator(cfg config.Config, newClientFunc NewLokiClientFunc, logger log.Logger) (types.LokiClient, error)

NewBufferDecorator makes a new buffered Client.

func NewClient

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

NewClient creates a new client based on the fluentbit configuration.

func NewMultiTenantClientDecorator

func NewMultiTenantClientDecorator(cfg config.Config, newClient NewLokiClientFunc, logger log.Logger) (types.LokiClient, error)

NewMultiTenantClientDecorator returns Loki 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 NewLokiClientFunc, logger log.Logger) (types.LokiClient, error)

NewPackClientDecorator return loki 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) (types.LokiClient, error)

NewPromtailClient return LokiClient 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 NewLokiClientFunc, logger log.Logger) (types.LokiClient, error)

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

func NewRemoveTenantIdClientDecorator

func NewRemoveTenantIdClientDecorator(cfg config.Config, newClient NewLokiClientFunc, logger log.Logger) (types.LokiClient, error)

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

func NewSortedClientDecorator

func NewSortedClientDecorator(cfg config.Config, newClient NewLokiClientFunc, logger log.Logger) (types.LokiClient, error)

NewSortedClientDecorator returns client which sorts the logs based their timestamp.

Types

type Entry

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

Entry represent a Loki log record.

type FakeLokiClient

type FakeLokiClient 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
}

FakeLokiClient mocks LokiClient

func (*FakeLokiClient) Handle

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

Handle processes and stores the received entries.

func (*FakeLokiClient) Stop

func (c *FakeLokiClient) Stop()

Stop stops the client

func (*FakeLokiClient) StopWait

func (c *FakeLokiClient) StopWait()

StopWait gracefully stops the client

type LokiClient

type LokiClient interface {
	// Handle processes logs and then sends them to Loki 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()
}

LokiClient represents an instance which sends logs to Loki ingester

type NewLokiClientDecoratorFunc

type NewLokiClientDecoratorFunc func(cfg config.Config, client LokiClient, logger log.Logger) (types.LokiClient, error)

NewLokiClientDecoratorFunc return LokiClient which wraps another LokiClient

type NewLokiClientFunc

type NewLokiClientFunc func(cfg config.Config, logger log.Logger) (types.LokiClient, error)

NewLokiClientFunc returns a LokiClient 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 Loki client