Reliability and Observability
Learn about reliability and observability in your app.
Reliability & observability
The SDK treats production concerns as first-class features.
Built-in behaviors
-
Timeouts
- Default timeout per request (configurable)
- Per-request override supported
-
Retries
- Conservative defaults; retries are opt-in via configuration
- Exponential backoff with jitter to reduce retry storms
-
Idempotency keys
- You can supply an
idempotencyKeyfor non-GET operations - Helps prevent duplicate “create” operations in retry scenarios
- You can supply an
-
Correlation IDs
- Every request includes a correlation ID you can log and trace
- The SDK returns the correlation ID in its response payload for easy logging
-
Cancellation
AbortSignalsupport for route changes, user cancel, or query cancellation
Default headers (can be customized)
| Concern | Default header | Purpose |
|---|---|---|
| Tenant | x-tenant-id | Tenant scoping |
| Auth | authorization (Bearer <token>) | Access control |
| Correlation | x-correlation-id | Traceability |
| Idempotency | idempotency-key | Safe writes |
| Client info | x-client-info | Debug/analytics without relying on User-Agent |
Request lifecycle (high-level)
sequenceDiagram
autonumber
participant App as Your App
participant SDK as Aarthik Credit SDK
participant Platform as Credit Platform
App->>SDK: Make a request (tenant + auth already configured)
SDK->>Platform: HTTPS request + tenant + auth + correlation
Platform-->>SDK: Response (success or error)
SDK-->>App: { data, error, status, correlationID }