Skip to main content

Interface: SignozSessionOptions

Defined in: src/client.ts:17

Authentication through the browser session: Bearer, with an automatic rotate on 401.

Extends​

  • CommonOptions

Properties​

apiKey?​

optional apiKey?: undefined

Defined in: src/client.ts:26

authToken​

authToken: string

Defined in: src/client.ts:19

The value of SigNoz's AUTH_TOKEN localStorage key.

baseUrl​

baseUrl: string

Defined in: src/client.ts:9

The instance URL, with its base path if any (e.g. https://example.com/signoz).

Inherited from​

CommonOptions.baseUrl

fetch?​

optional fetch?: (input, init?) => Promise<Response>

Defined in: src/client.ts:13

An alternative fetch (tests, proxy).

Parameters​

input​

string | URL | Request

init?​

RequestInit

Returns​

Promise<Response>

Inherited from​

CommonOptions.fetch

onTokensRotated?​

optional onTokensRotated?: OnTokensRotated

Defined in: src/client.ts:23

Called on every rotate with the new pair (to persist it yourself).

refreshAuthToken​

refreshAuthToken: string

Defined in: src/client.ts:21

The value of SigNoz's REFRESH_AUTH_TOKEN localStorage key.

timeoutMs?​

optional timeoutMs?: number

Defined in: src/client.ts:11

Timeout per attempt, in ms (default 30000; 0 or Infinity turn it off).

Inherited from​

CommonOptions.timeoutMs

tokenStore?​

optional tokenStore?: TokenStore

Defined in: src/client.ts:25

Persists the rotated pair (e.g. new FileTokenStore()).