Reference
Java reference
The parameters of the Apitally SDK for Java.
Configuration options
The following parameters apply when configuring the Apitally client in your application.yml
file.
Parameter | Description | Type |
---|---|---|
client-id | Client ID for your application. Find it on the Setup instructions page for your app. | string |
env | Name of the environment, e.g. prod or dev . The environment will be automatically created if it doesn’t exist. | string |
request-logging | Configuration for request logging. See table below. | object |
Request logging config
The following are the properties of the request-logging
configuration object.
Parameter | Description | Type | Default |
---|---|---|---|
enabled | Whether request logging is enabled. | boolean | false |
query-params-included | Whether to include query parameters in the logs. If disabled, these will be stripped from the request URLs logged. | boolean | true |
request-headers-included | Whether to include request headers in the logs. Default masking for common sensitive headers (e.g. Authorization ) applies. | boolean | false |
request-body-included | Whether to include the request body in the logs. Only JSON and text are supported, up to 50 KB. | boolean | false |
response-headers-included | Whether to include response headers in the logs. | boolean | true |
response-body-included | Whether to include the response body in the logs. Only JSON and text are supported, up to 50 KB. | boolean | false |
query-param-mask-patterns | List of regular expressions for matching query parameters to mask. These are in addition to the default masking patterns. | List<String> | [] |
header-mask-patterns | List of regular expressions for matching headers to mask. These are in addition to the default masking patterns. | List<String> | [] |
body-field-mask-patterns | List of regular expressions for matching request/response body fields to mask. These are in addition to the default masking patterns. | List<String> | [] |
path-exclude-patterns | List of regular expressions for matching paths to exclude from logging. | List<String> | [] |
callbacks-class | Fully qualified name of a class implementing RequestLoggingCallbacks for custom masking and exclusion logic. | string | - |
Request object
Below are the properties of the Request
objects that are passed to the callback methods.
Property | Description | Type |
---|---|---|
timestamp | Unix timestamp of the request. | double |
method | HTTP method of the request. | string |
path | Path of the request. | string |
url | Full URL of the request. | string |
headers | Array of key-value pairs representing the request headers. | Header[] |
size | Size of the request body in bytes. | long |
consumer | Identifier of the consumer making the request. | string |
body | Raw request body as bytes. | byte[] |
Response object
Below are the properties of the Response
objects that are passed to some of the callback methods.
Property | Description | Type |
---|---|---|
statusCode | HTTP status code of the response. | int |
responseTime | Time taken to respond to the request in seconds. | double |
headers | Array of key-value pairs representing the response headers. | Header[] |
size | Size of the response body in bytes. | long |
body | Raw response body as bytes. | byte[] |
Default masking
The below regular expressions are used to mask sensitive query parameters, headers and request/response body fields.
Default exclusions
The below regular expressions are used to exclude common health check endpoints from logging. They are applied to the request path.