Configuration

You can configure Apitally in your application.yml file.

application.yml

apitally:
  client-id: "your-client-id"
  env: "dev"
  request-logging:
    enabled: true
    # other parameters ...

Parameters

The following configuration parameters are available. Only client-id and env are required.

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`

The request-logging parameter is an object with the following properties:

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`
`log-capture-enabled`	Whether to capture application logs emitted during request handling.	`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`	-

SDK reference

Standard SDKs

Serverless SDKs

Parameters

​Parameters

Parameters