Skip to content

Latest commit

 

History

History
81 lines (48 loc) · 2.65 KB

configuration.md

File metadata and controls

81 lines (48 loc) · 2.65 KB
Raw

Configuration

Go Client Instantiation

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

ClientID

Default: ""

ClientID can be found on https://dashboard.supergood.ai/api-keys. It defaults to the SUPERGOOD_CLIENT_ID environment variable if not provided.

ClientSecret

ClientSecret can be found on https://dashboard.supergood.ai/api-keys. It defaults to the SUPERGOOD_CLIENT_SECRET environment variable if not provided.

{% hint style="warning" %} The following parameters in this guide can bee configured directly in the Supergood dashboard without having to explicitly set it in the Go client constructor. https://dashboard.supergood.ai/endpoints {% endhint %}

ForceRedactAll

Default: False

ForceRedactAll is a boolean which when enabled will remove all values from the leaves of the request and response bodies as well as any headers in your payload. Supergood will still forward the keys of the request and response bodies.

RedactRequestBodyKeys

RedactRequestBodyKeys is a map of top level domains to a list of key paths within the request body of values to be redacted. 

RedactRequestBodyKeys: map[string][]string{
	"plaid.com": []string{"path.to.redacted.[].field"},
},

RedactRequestHeaderKeys

RedactRequestHeaderKeys is a map of top level domains to a list of keys within the request headers of values to be redacted

RedactRequestHeaderKeys: map[string][]string{
	"plaid.com": []string{"client-id", "client-secret},
},

RedactResponseBodyKeys

RedactResponseBodyKeys is a map of top level domains to a list of key paths within the response body of values to be redacted.

RedactResponseBodyKeys: map[string][]string{
	"plaid.com": []string{"path.to.redacted.[].field"},
},

RedactResponseHeaderKeys

RedactResponseHeaderKeys is a map of top level domains to a list of keys within the response headers of values to be redacted

RedactResponseHeaderKeys: map[string][]string{
	"plaid.com": []string{"client-id", "client-secret},
},

AllowedDomains

Default: []

List of strings to match against the host of the request URL in order to determine whether or not to log the request to Supergood, based on the domain. Case sensitive. By default, requests from all domains are logged.

FlushInterval

Default: 1 * time.Second

FlushInterval configures how frequently Supergood sends batches of logs to the API. This parameter cannot be set directly in the Supergood dashboard and must be configured on the client.