SeeStack

Configuration Options

Detailed reference for all SDK initialization configuration options.

This page provides a complete reference for every option accepted by SeeStack.init().

All Options

Prop

Type

Required vs Optional

apiKey and host are the only required options. Without them, the SDK will not initialize and all methods will be no-ops. The SDK validates that apiKey is non-empty at init time.

Default Values Summary

OptionDefault
environmentNot set
releaseNot set
flushIntervalMs5000 (5 seconds)
bufferSize500 items per feature
debugfalse

Memory Impact

The buffer size directly affects SDK memory usage:

Buffer SizeItems (5 features)Estimated Heap
100500 total~3 MB
500 (default)2,500 total~15 MB
10005,000 total~30 MB

Each item is estimated at 1–5 KB depending on the event type and metadata size.

Initialization Behavior

ScenarioBehavior
First init() callSDK initializes normally
Second init() callWarning emitted, call ignored (idempotent)
SDK method called before init()Silent no-op — no error thrown
Empty apiKey passedSDK fails fast with an error at init time
HTTP host in productionSDK refuses to send data (HTTPS required)

Environment-Specific Recommendations

Development

{
  "debug": true,
  "environment": "development"
}

Staging

{
  "debug": false,
  "environment": "staging",
  "flushIntervalMs": 3000
}

Production

{
  "debug": false,
  "environment": "production",
  "flushIntervalMs": 5000,
  "bufferSize": 500
}

On this page