requestid

package

v0.3.4 Latest Latest Go to latest Published: Sep 23, 2026 License: Apache-2.0 Imports: 3 Imported by: 8

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/gorbital/gorbital

Links

Open Source Insights

Documentation ¶

Overview ¶

Package requestid generates, validates and carries request IDs in a context.Context, so HTTP middleware, logging, audit and jobs share one correlation value (ADR-0030).

Stability: stable (ADR-0015, ADR-0054).

Index ¶

Constants
func From(ctx context.Context) string
func New() string
func Valid(id string) bool
func With(ctx context.Context, id string) context.Context

Constants ¶

View Source

const Header = "X-Request-ID"

Header is the HTTP header carrying the request ID.

View Source

const MaxLength = 128

MaxLength is the longest accepted incoming request ID.

Variables ¶

This section is empty.

Functions ¶

func From ¶

func From(ctx context.Context) string

From returns the request ID in ctx, or "".

func New ¶

func New() string

New returns a random request ID such as "req_9f86d081884c7d65".

func Valid ¶

func Valid(id string) bool

Valid reports whether id is safe to accept from a client: 1 to MaxLength characters of letters, digits, '-', '_', '.' or ':'. This keeps untrusted IDs from injecting content into logs.

func With ¶

func With(ctx context.Context, id string) context.Context

With returns a copy of ctx carrying id.

Types ¶

This section is empty.

Source Files ¶

View all Source files

requestid.go

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