Skip to content

DashboardConfig

Defined in: src/plugins/application/dashboard/plugin.ts:123

Property Type Description Defined in

allowedReplayHosts?

string[] | (hostname) => boolean

Allowed hosts/IPs for the replay endpoint. Can be an array of glob patterns (e.g. ‘1.1.1.1’, ‘10.0.0.’, ‘192.168.1.’) or a custom function that receives the hostname and returns true if allowed. If not provided, private/internal addresses remain blocked by default.

src/plugins/application/dashboard/plugin.ts:182

disableReplay?

boolean

If true, the replay endpoint will be disabled.

src/plugins/application/dashboard/plugin.ts:134

getRequestHeaders?

() => HeadersInit

src/plugins/application/dashboard/plugin.ts:124

ignoreMethods?

string[]

Array of HTTP methods to not record (e.g. [‘OPTIONS’, ‘HEAD’])

src/plugins/application/dashboard/plugin.ts:142

ignorePatterns?

(string | RegExp | (req) => boolean)[]

patterns to ignore in the request list. Can be a glob pattern (string), regex, or a custom callback function.

src/plugins/application/dashboard/plugin.ts:130

ignoreStatusCodes?

number[]

Array of status codes to not record.

src/plugins/application/dashboard/plugin.ts:138

integrations?

object

src/plugins/application/dashboard/plugin.ts:147

integrations.apiExplorer?

boolean | { path?: string; }

src/plugins/application/dashboard/plugin.ts:150

integrations.asyncapi?

boolean | { path?: string; }

src/plugins/application/dashboard/plugin.ts:149

integrations.scalar?

boolean | { path?: string; }

src/plugins/application/dashboard/plugin.ts:148

maxLogEntries?

number

Maximum number of request logs to keep in memory.

Default

1000

src/plugins/application/dashboard/plugin.ts:168

path?

string

src/plugins/application/dashboard/plugin.ts:125

retentionMs?

number

Retention time in milliseconds

src/plugins/application/dashboard/plugin.ts:146

trackStateMutations?

boolean

Track and display state mutations made by middleware. Requires enableMiddlewareTracking to be enabled on the application. When enabled, the dashboard will show what properties each middleware added/modified on ctx.state.

Default

true (if enableMiddlewareTracking is enabled)

src/plugins/application/dashboard/plugin.ts:175

updateInterval?

number

Interval in milliseconds for pushing batched updates.

Default

10_000

src/plugins/application/dashboard/plugin.ts:163

updateStrategy?

"immediate" | "batched"

Strategy for pushing request updates to the dashboard. ‘immediate’ - pushes every request as soon as it completes. ‘batched’ - buffers requests and pushes them at the interval specified by updateInterval.

Default

'immediate'

src/plugins/application/dashboard/plugin.ts:158