Correlation ID

Overview Examples Configuration reference Changelog

Configuration

configobject

Hide Child Parameters

echo_downstreamboolean

Whether to echo the header back to downstream (the client).

Default:false

generatorstring

The generator to use for the correlation ID. Accepted values are uuid, uuid#counter, and tracker. See Generators.

Allowed values:trackeruuiduuid#counter

Default:uuid#counter

header_namestring

The HTTP header name to use for the correlation ID.

Default:Kong-Request-ID

consumerobject

If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.

* Additional properties are NOT allowed.

Hide Child Parameters

idstring

protocolsarray[string]

A set of strings representing HTTP protocols.

Allowed values:grpcgrpcshttphttps

Default:grpc, grpcs, http, https

routeobject

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

* Additional properties are NOT allowed.

Hide Child Parameters

idstring

serviceobject

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

* Additional properties are NOT allowed.

Hide Child Parameters

idstring

Correlation ID

Configuration

Did this doc help?

Help us make these docs great!

Still need help