Skip to content

Latest commit

 

History

History
59 lines (34 loc) · 1.47 KB

configuration.md

File metadata and controls

59 lines (34 loc) · 1.47 KB

Configuration

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

flushInterval

Default: 1000

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

Example:

Supergood.init({ flushInterval: 1000 })

forceRedactAll

Default: true

A flag, by default set to "true" will redact all the payload values for the request body, request headers, response body and response headers and send only the metadata of the payload value to the Supergood servers.

The metadata consists only of the data type and data length.

If this flag is set to "false", Supergood will attempt to redact values that it deems to represent sensitive keys. All sensitive keys are configurable in the Supergood Dashboard.

Example:

Supergood.init({ forceRedactAll: false })

ignoredDomains

Default: []

An array of domains to ignore when caching traffic.

Will pattern match on the hostname, as long as the input string is contained in the hostname.

Example:

Supergood.init({ ignoredDomains: ['amazon.com', 'google.com'] })

allowedDomains

Default: []

An array of domains to only allow when caching traffic, overrides any ignoredDomains set.

Will pattern match on the hostname, as long as the input string is contained in the hostname.

Example:

Supergood.init({ allowedDomains: ['amazon.com', 'google.com'] })