client

Documentation

Index

• Constants
• func NewClient(cfg *config.Config, logger log.Logger) (types.LokiClient, error)
• func NewMultiTenantClientWrapper(clientToWrap types.LokiClient, copyLabelSet bool) types.LokiClient
• func NewPromtailClient(cfg client.Config, logger log.Logger) (types.LokiClient, error)
• func NewRemoveTenantIdClient(clientToWrap types.LokiClient) types.LokiClient
• 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

Constants

const (
	MultiTenantClientLabel      = "__gardener_multitenant_id__"
	MultiTenantClientsSeparator = ";"
)

Functions

func NewClient

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

NewClient creates a new client based on the fluentbit configuration.

func NewMultiTenantClientWrapper

func NewMultiTenantClientWrapper(clientToWrap types.LokiClient, copyLabelSet bool) types.LokiClient

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

func NewPromtailClient

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

NewPromtailClient return promtail client which increments the ForwardedLogs counter on successful call of the Handle function

func NewRemoveTenantIdClient

func NewRemoveTenantIdClient(clientToWrap types.LokiClient) types.LokiClient

NewRemoveTenantIdClient return loki client wich removes the __tenant_id__ value fro the label set

Types

type Entry

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

type FakeLokiClient

type FakeLokiClient struct {
	IsStopped           bool
	IsGracefullyStopped bool
	Entries             []Entry
}

func (*FakeLokiClient) Handle

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

func (*FakeLokiClient) Stop

func (c *FakeLokiClient) Stop()

func (*FakeLokiClient) StopWait

func (c *FakeLokiClient) StopWait()

type LokiClient

type LokiClient interface {
	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()
}