log

Documentation

Overview

Package log provides a logging middleware for client.

Index

• Constants
• func Provide(config map[string]any, _ client.Type, logger log.Logger) (client.Middleware, error)
• type Middleware
  • func (m *Middleware) Request(next client.MiddlewareRequestHandler) client.MiddlewareRequestHandler
  • func (m *Middleware) Start(_ context.Context) error
  • func (m *Middleware) Stop(_ context.Context) error
  • func (m *Middleware) String() string
  • func (m *Middleware) Type() string

Constants

const Name = "log"

Name is the middlewares name.

Functions

func Provide

func Provide(config map[string]any, _ client.Type, logger log.Logger) (client.Middleware, error)

Provide will be registered to client.Middlewares, it's a factory for this.

Types

type Middleware

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

Middleware is the log Middleware for client.

func (*Middleware) Request

func (m *Middleware) Request(
	next client.MiddlewareRequestHandler,
) client.MiddlewareRequestHandler

Request wraps the original RequestNoCodec method or other middlewares.

func (*Middleware) Start

func (m *Middleware) Start(_ context.Context) error

Start the component. E.g. connect to the broker.

func (*Middleware) Stop

func (m *Middleware) Stop(_ context.Context) error

Stop the component. E.g. disconnect from the broker. The context will contain a timeout, and cancelation should be respected.

func (*Middleware) String

func (m *Middleware) String() string

String returns the name of this middleware.

func (*Middleware) Type

func (m *Middleware) Type() string

Type returns the component type, e.g. broker.