Request-log (Section)#
Path: /environments/environment/logging/request-log
The fields included in the request log. A field is included when its configured Level is the same, or finer, than the RequestReceiver Logger Level.
Parameters#
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| client | enumeration (info, debug, off) | optional | debug | The IP address of the caller (potentially that of a reverse proxy) |
| location | enumeration (info, debug, off) | optional | debug | The geolocation of the client, when a geolocation provider is available |
| params | enumeration (info, debug, off) | optional | debug | The HTTP query string and form parameters, or the JSON request body. Any other body is logged as a placeholder, unless log-unparsed-request-body is enabled. This may contain sensitive data, use masked-parameter-pattern to hide the values of such parameters |
| masked-parameter-pattern | string (length: 1..9223372036854775807) | optional | - | A Java regular expression selecting the request parameters whose values are replaced by a fixed mask in the params field. The expression matches each parameter name anywhere unless it is anchored: for example, ‘password’ hides both ‘password’ and ‘new_password’. Use ’(?i)’ to ignore case, or ’^’ and ’$’ to match the whole name. Parameters can come from the query string, a form body or a JSON body, where the names of nested objects are matched as well. When not configured, no parameter is masked. |
| log-unparsed-request-body | boolean | optional | false | WARNING: this is potentially dangerous, and should only be enabled temporarily, to debug a problem. When enabled, a request body that cannot be read as parameters is logged as it is in the params field: a body declared as JSON that is not valid JSON, or a body whose content type is neither JSON nor an HTML form. Such a body may contain passwords, tokens and personal data, which are written to the request log without any masking. For that reason, this cannot be enabled together with masked-parameter-pattern. When disabled, such a body is not logged: params is logged as ‘<INVALID JSON>’, ‘<UNLOGGABLE JSON>’ or ‘<UNSUPPORTED CONTENT TYPE>’ instead. |
| protocol | enumeration (info, debug, off) | optional | info | The HTTP protocol used |
| lang | enumeration (info, debug, off) | optional | info | The value of the Accept-Language request header |
| accept | enumeration (info, debug, off) | optional | info | The value of the Accept request header |
| request-headers | enumeration (info, debug, off) | optional | debug | All HTTP request headers. This may contain sensitive data |
| response-headers | enumeration (info, debug, off) | optional | debug | All HTTP response headers. This may contain sensitive data |
| size | enumeration (info, debug, off) | optional | info | The size of the HTTP response body |
| content-type | enumeration (info, debug, off) | optional | info | The content type of the HTTP response body |
| secure | enumeration (info, debug, off) | optional | info | Whether the connection was made over HTTPS, and if so, whether a client certificate was used |
| duration | enumeration (info, debug, off) | optional | info | How long the request took to process, in milliseconds |