The highest tagged major version is v12.

requestid

package

v0.0.2 Latest Latest Go to latest Published: Sep 3, 2020 License: BSD-3-Clause Imports: 5 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

Repository

github.com/kataras/iris

Links

Open Source Insights

Documentation ¶

Index ¶

func Get(ctx *context.Context) string
func Hash(ctx *context.Context, includeBody bool) string
func New(generator ...Generator) context.Handler
type Generator
- func HashGenerator(includeBody bool) Generator

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Get ¶

func Get(ctx *context.Context) string

Get returns the Request ID or empty string.

A shortcut of `context.GetID().(string)`.

func Hash ¶

func Hash(ctx *context.Context, includeBody bool) string

Hash returns the sha1 hash of the request. It does not capture error, instead it returns an empty string.

func New ¶

func New(generator ...Generator) context.Handler

New returns a new request id middleware. It optionally accepts an ID Generator. The Generator can stop the handlers chain with an error or return a valid ID (string). If it's nil then the `DefaultGenerator` will be used instead.

Types ¶

type Generator ¶

type Generator func(ctx *context.Context) string

Generator defines the function which should extract or generate a Request ID. See `DefaultGenerator` and `New` package-level functions.

var DefaultGenerator Generator = func(ctx *context.Context) string {
	id := ctx.ResponseWriter().Header().Get(xRequestIDHeaderKey)
	if id != "" {
		return id
	}

	id = ctx.GetHeader(xRequestIDHeaderKey)
	if id == "" {
		uid, err := uuid.NewRandom()
		if err != nil {
			ctx.StopWithStatus(500)
			return ""
		}

		id = uid.String()
	}

	ctx.Header(xRequestIDHeaderKey, id)
	return id
}

DefaultGenerator is the default `Generator` that is used when nil is passed on `New` package-level function. It extracts the ID from the "X-Request-ID" request header value or, if missing, it generates a new UUID(v4) and sets the header and context value.

See `Get` package-level function too.

func HashGenerator ¶

func HashGenerator(includeBody bool) Generator

HashGenerator uses the request's hash to generate a fixed-length Request ID. Note that one or many requests may contain the same ID, so it's not unique.

Source Files ¶

View all Source files

requestid.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL