Reference
Python reference
The parameters of the Apitally SDK for Python.
Parameters
The following parameters apply for all integrations.
Parameter | Description | Type | Default |
---|---|---|---|
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 | dev |
app_version | The current version of your application, e.g. 1.0.0 . | string | None |
enable_request_logging | Whether request logging is enabled. | bool | False |
log_query_params | Whether to include query parameters in the logs. If disabled, these will be stripped from the request URLs logged. | bool | True |
log_request_headers | Whether to include request headers in the logs. Default masking for common sensitive headers (e.g. Authorization ) applies. | bool | False |
log_request_body | Whether to include the request body in the logs. Only JSON and text are supported, up to 50 KB. | bool | False |
log_response_headers | Whether to include response headers in the logs. | bool | True |
log_response_body | Whether to include the response body in the logs. Only JSON and text are supported, up to 50 KB. | bool | False |
log_exception | Whether to include exception details in the logs. | bool | True |
mask_query_params | List of regular expressions for matching query parameters to mask. These are in addition to the default masking patterns. | list[str] | [] |
mask_headers | List of regular expressions for matching headers to mask. These are in addition to the default masking patterns. | list[str] | [] |
mask_body_fields | List of regular expressions for matching request/response body fields to mask. These are in addition to the default masking patterns. | list[str] | [] |
mask_request_body_callback | Callback function for masking the request body. Takes one parameter request and returns the request body as bytes or None . | Callable | None |
mask_response_body_callback | Callback function for masking the response body. Takes two parameters request and response and returns the response body as bytes or None . | Callable | None |
exclude_paths | List of regular expressions for matching paths to exclude from logging. | list[str] | [] |
exclude_callback | Callback function for excluding requests from logging. Takes two parameters request and response and returns True , if the request should be excluded, or False otherwise. | Callable | None |
Request dict
Below are the keys of the request
dicts that are passed to the user-provided callback functions.
Key | Description | Type |
---|---|---|
timestamp | Unix timestamp of the request. | float |
method | HTTP method of the request. | str |
path | Path of the request. | str |
url | Full URL of the request. | str |
headers | Array of key-value pairs representing the request headers. | list[tuple[str, str]] |
size | Size of the request body in bytes. | int |
consumer | Identifier of the consumer making the request. | str |
body | Raw request body. | bytes |
Response dict
Below are the keys of the response
dicts that are passed to some of the user-provided callback functions.
Key | Description | Type |
---|---|---|
status_code | HTTP status code of the response. | int |
response_time | Time taken to respond to the request in seconds. | float |
headers | Array of key-value pairs representing the response headers. | list[tuple[str, str]] |
size | Size of the response body in bytes. | int |
body | Raw response body. | bytes |
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.