requestctx

package
v0.0.0-...-1f1dc5f Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 30, 2026 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Overview

Package requestctx carries request-scoped metadata without depending on an HTTP framework.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CleanMetadataID

func CleanMetadataID(value string) string

CleanMetadataID returns value only when it is short visible ASCII metadata.

func GetLoginSessionID

func GetLoginSessionID(ctx context.Context) string

GetLoginSessionID returns the login session ID stored in ctx.

func GetRequestID

func GetRequestID(ctx context.Context) string

GetRequestID returns the request ID stored in ctx.

func GetRoleID

func GetRoleID(ctx context.Context) string

GetRoleID returns the active role ID stored in ctx.

func GetStartTime

func GetStartTime(ctx context.Context) time.Time

GetStartTime returns the request start time stored in ctx.

func GetTraceID

func GetTraceID(ctx context.Context) string

GetTraceID returns the trace ID stored in ctx.

func GetUserID

func GetUserID(ctx context.Context) string

GetUserID returns the user ID stored in ctx.

func WithInfo

func WithInfo(ctx context.Context, info Info) context.Context

WithInfo returns a child context carrying request metadata.

func WithLoginSessionID

func WithLoginSessionID(ctx context.Context, sessionID string) context.Context

WithLoginSessionID returns a child context carrying the authenticated login session identity. API-token requests intentionally leave this field empty.

func WithRoleID

func WithRoleID(ctx context.Context, roleID string) context.Context

WithRoleID returns a child context carrying the active authenticated role.

func WithTraceInfo

func WithTraceInfo(ctx context.Context, traceID, spanID, requestID string) context.Context

WithTraceInfo returns a child context carrying common trace metadata.

func WithTraceSpan

func WithTraceSpan(ctx context.Context, traceID, spanID string) context.Context

WithTraceSpan returns a child context with updated trace metadata while preserving existing request metadata.

func WithUserID

func WithUserID(ctx context.Context, userID string) context.Context

WithUserID returns a child context carrying authenticated user identity.

Types

type Info

type Info struct {
	TraceID        string
	SpanID         string
	RequestID      string
	UserID         string
	RoleID         string
	LoginSessionID string
	StartTime      time.Time
}

Info is metadata extracted at a delivery boundary and passed through request-scoped work.

func FromContext

func FromContext(ctx context.Context) (Info, bool)

FromContext returns request metadata from ctx.

Jump to

Keyboard shortcuts

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