View Source nova_correlation_plugin (nova v0.9.15)
plugin-configuration
Plugin Configuration
To not break backwards compatibility in a minor release, some behavior is behind configuration items.
request-correlation-header-name
Request Correlation Header Name
Set request_correlation_header
in the plugin config to read the correlation ID from the request headers.
Notice: Cowboy request headers are always in lowercase.
default-correlation-id-generation
Default Correlation ID Generation
If the header name is not defined or the request lacks a correlation ID header, then the plugin generates a v4 UUID automatically.
logger-metadata-key-override
Logger Metadata Key Override
Use logger_metadata_key
to customize the correlation ID key in OTP logger process metadata. By default it is set to <<"correlation-id">>
.
correlation-id-in-request-object
Correlation ID in Request Object
The plugin defines a field called correlation_id
in the request object for controller use if it makes further requests that it want to pass on the correlation id to.
example-configuration
Example configuration
{plugins, [
{pre_request, nova_correlation_plugin, #{
request_correlation_header => <<"x-correlation-id">>,
logger_metadata_key => correlation_id
}}
]}