correlationid

package

v0.0.0-...-e7c744b Latest Latest Go to latest Published: Jun 21, 2023 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const ContextKey = "correlationid"

ContextKey is the key the retrieved (or generated) correlation ID is stored under in the gin Context.

This section is empty.

func Logger(logger common.Logger, ctx *gin.Context) common.Logger

Logger returns a new logger instance with a correlation ID in it.

func LogrusLogger(logger logrus.FieldLogger, ctx *gin.Context) logrus.FieldLogger

LogrusLogger returns a new logger instance with a correlation ID in it.

func Middleware(opts ...MiddlewareOption) gin.HandlerFunc

Middleware returns a gin compatible handler.

type Header string

Header configures the header from where the correlation ID will be retrieved.

type MiddlewareOption interface {
	// contains filtered or unexported methods
}

MiddlewareOption configures the correlation ID middleware.