Plugin Configuration

To not break backwards compatibility in a minor release, some behavior is behind configuration items.

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

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

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

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

       {plugins, [
           {pre_request, nova_correlation_plugin, #{
               request_correlation_header => <<"x-correlation-id">>,
               logger_metadata_key => correlation_id
           }}
       ]}