configuration.md

Configuration

This page describes possible parameter configurations. Pass any desired configuration to the Client.

flushInterval

Default: 1000

Time in milliseconds between cache flushes. Smaller intervals are advised for larger traffic volumes. Represented as an integer.

Example:

Client.initialize(config={ "flushInterval": 1000 })

configInterval

Default: 10000

Time in milliseconds between fetching the remote config from the Supergood wizard. Represented as an integer.

Example:

Client.initialize(config={ "configInterval": 5000 })

ignoredDomains

Default: []

An array of domains to ignore when caching traffic.

In the format of:<domain-name>.<top-level-domain>

Example:

Client.initialize(config={ ignoredDomains: ['amazon.com', 'google.com', 'bbc.co.uk'] })

forceRedactAll

Default: False

Redacts all leaf values from all payloads. Ignores allowed sensitive keys

Example:

Client.initialize(config={ "forceRedactAll": True })

log{Request|Response}{Headers|Body}

Defaults: True

4 Boolean parameters that allow for more fine-tuned control over what gets removed from the payload. Setting any to false will remove values from the respective object.

Examples:

# Example 1: Log everything except responseHeaders
Client.initialize(config={ "logResponseHeaders": False })
# Example 2: Only log requests
Client.initialize(config={ "logResponseHeaders": False, "logResponseBody": False}

ignoreRedaction

Default: False

Boolean to override the redaction of all values.

Example:

Client.initialize(config={ "ignoreRedaction": True })

useRemoteConfig

Default: True

Can be set to False to ignore reading from remote config. Generally only used in a few serverless applications.

Example:

Client.initialize(config={ "useRemoteConfig": False })

runThreads

Default: True

Can be set to False to stop running background threads. Generally only used in a few serverless applications.

Example:

Client.initialize(config={ "runThreads": False })

redactByDefault

Default: False

Redacts full payloads excepting for any keys explicitly marked as Allow via the Supergood UI. Used for more data-sensitive flows that want to allow-list as opposed to disallow-list keys.

Example:

Client.initialize(config={ "redactByDefault": True })