loggingmiddleware

type Config struct {
	// Name is the name of the endpoint.
	// It must not be empty and will be logged as endpoint_name.
	Name string

	// TruncRequestAt will truncate the serialized request if
	// the string length is above this value.
	// Setting to zero disables truncating.
	TruncRequestAt int

	// TruncResponseAt will truncate the serialized request if
	// the string length is above this value.
	// Setting to zero disables truncating.
	TruncResponseAt int

	// LogRequestIfLevel will log the request if this
	// log level is enabled in the logger.
	LogRequestIfLevel zerolog.Level

	// LogResponseIfLevel will log the response if this
	// log level is enabled in the logger.
	LogResponseIfLevel zerolog.Level

	// SuccessLevel is the log level of requests that are processed without error.
	SuccessLevel zerolog.Level

	// DefaultErrorLevel is the log level of requests that finished with some error.
	// May be override by ErrorCodeMapLevel or SeverityMapLevel
	DefaultErrorLevel zerolog.Level

	// ErrorCodeMapLevel is used to override the error level using the error code.
	// This is optional
	ErrorCodeMapLevel map[errors.Code]zerolog.Level

	// SeverityMapLevel is used to override the error level using the error severity.
	// This is optional
	SeverityMapLevel map[errors.Severity]zerolog.Level

	// Logger is the default logger to be put in the context.
	// If there is already a logger in the context, the context
	// is not updated and the existing logger is used.
	Logger *zerolog.Logger

	// Meta are extra keys logged under 'endpoint_meta' key.
	Meta Meta

	// EnrichRequestFunc is used to enrich the logger context with the request.
	//
	// It is called by the middleware to enrich the logger with information from
	// inside the request just before calling the next endpoint. This function should
	// interpret the request and extract information and return the new zerolog context.
	//
	// Remember that the request can be logged as a whole by using LogRequestIfLevel and
	// TruncRequestAt.
	//
	// If set to 'nil' it is disabled.
	EnrichLogWithRequest EnrichLogWithRequestFunc

	// EnrichLogWithResponse is used to enrich the logger context with the response and error.
	//
	// It is called by the middleware to enrich the logger with information from
	// inside the respose and error after calling the next endpoint. This function should
	// interpret the response and error and extract information and return the new zerolog context.
	//
	// Remember that the response can be logged as a whole by using LogResponseIfLevel and
	// TruncResponseAt.
	//
	// If set to 'nil' it is disabled.
	EnrichLogWithResponse EnrichLogWithResponseFunc
}

type EnrichLogWithRequestFunc func(ctx context.Context, zctx zerolog.Context, request interface{}) (context.Context, zerolog.Context)

type EnrichLogWithResponseFunc func(ctx context.Context, zctx zerolog.Context, response interface{}, err error) zerolog.Context

type LoggableEndpointRequest interface {
	// EnrichLog enriches the current log context @zctx with the request data.
	EnrichLog(
		ctx context.Context,
		zctx zerolog.Context,
	) (context.Context, zerolog.Context)
}

type LoggableEndpointResponse interface {
	// EnrichLog enriches the current log context @zctx with the response data.
	EnrichLog(
		ctx context.Context,
		zctx zerolog.Context,
	) zerolog.Context
}

type Meta map[string]string