Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.apitally.io/llms.txt

Use this file to discover all available pages before exploring further.

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.
ParameterDescriptionType
client-idClient ID for your application. Find it on the Setup instructions page for your app.string
envName of the environment, e.g. prod or dev. The environment will be automatically created if it doesn’t exist.string
request-loggingConfiguration for request logging. See table below.object
The request-logging parameter is an object with the following properties:
ParameterDescriptionTypeDefault
enabledWhether request logging is enabled.booleanfalse
query-params-includedWhether to include query parameters in the logs. If disabled, these will be stripped from the request URLs logged.booleantrue
request-headers-includedWhether to include request headers in the logs. Default masking for common sensitive headers (e.g. Authorization) applies.booleanfalse
request-body-includedWhether to include the request body in the logs. Only JSON and text are supported, up to 50 KB.booleanfalse
response-headers-includedWhether to include response headers in the logs.booleantrue
response-body-includedWhether to include the response body in the logs. Only JSON and text are supported, up to 50 KB.booleanfalse
log-capture-enabledWhether to capture application logs emitted during request handling.booleanfalse
query-param-mask-patternsList of regular expressions for matching query parameters to mask. These are in addition to the default masking patterns.List<String>[]
header-mask-patternsList of regular expressions for matching headers to mask. These are in addition to the default masking patterns.List<String>[]
body-field-mask-patternsList of regular expressions for matching request/response body fields to mask. These are in addition to the default masking patterns.List<String>[]
path-exclude-patternsList of regular expressions for matching paths to exclude from logging.List<String>[]
callbacks-classFully qualified name of a class implementing RequestLoggingCallbacks for custom masking and exclusion logic.string-