Headers

The client stamps a set of identity and tracing headers onto every request, drawn from Config and the per-request ID and SessionID. Each header name is an exported constant, so a caller reads and sets the same name the client sends.

Client identity

Seeded from Config at construction time.

const ClientUserAgentHeaderName = "User-Agent"

Identifies the client software making the request, from Config.UserAgent.

const ClientPlatformHeaderName = "X-Client-Platform"

Identifies the kind of client (web, mobile, desktop, cli, service), from Config.Platform.

const ClientAppVersionHeaderName = "X-Client-Version"

Identifies the app version, from Config.AppVersion.

const ClientIDHeaderName = "X-Client-ID"

A persistent identifier for the client install or device, from Config.ClientID.

const ServiceNameHeaderName = "X-Service-Name"

Identifies the originating service in server-to-server calls, from Config.ServiceName.

Per-request tracing

Set on the Request and sent only when present.

const ClientRequestIDHeaderName = "X-Request-ID"

A unique identifier for the individual request, from Request.ID, for tracing one request across services.

const ClientSessionIDHeaderName = "X-Session-ID"

Correlates related requests within one user session, from Request.SessionID.