Skip to content

Request Logging

Every request the WebAPI handles is logged to the IMan database twice: once on arrival, with the request as the listener parsed it, and once on completion, with the response body. Both entries carry the endpoint's integration as their process id and the request's correlation id as their source, which ties the pair together and to the integration's own audit entries for the run.

A query result of the log table: four rows for the integration HTTPS300ORDPOST, in pairs, each pair sharing a correlation id in the Source column; the earlier row of each pair holds the parsed request as JSON, beginning with its Method and Route, and the later one the JSON response

The request entry is the record the WebAPI Reader sees: method, route, parameters, headers, the web user and the body. The Authorization header is never logged.

Correlation id

Each request is given a new GUID when it arrives. It is returned to the caller in the X-Correlation-Id response header, on every response including an error or a refusal, and it is inside the body of an error response as correlationId. In the integration it is the Http.CorrelationId field. A correlation id sent by the caller is ignored; the WebAPI always issues its own.

Quote it when raising a query about a request. It finds the request, its response and the integration's audit entries in one search of the log.