Skip to content

DashboardConfig

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

Property Type Description Defined in

disableReplay?

boolean

If true, the replay endpoint will be disabled.

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

getRequestHeaders?

() => HeadersInit

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

ignoreMethods?

string[]

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

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

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:74

ignoreStatusCodes?

number[]

Array of status codes to not record.

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

integrations?

object

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

integrations.apiExplorer?

boolean | { path?: string; }

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

integrations.asyncapi?

boolean | { path?: string; }

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

integrations.scalar?

boolean | { path?: string; }

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

maxLogEntries?

number

Maximum number of request logs to keep in memory.

Default

1000

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

path?

string

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

retentionMs?

number

Retention time in milliseconds

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

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:119

updateInterval?

number

Interval in milliseconds for pushing batched updates.

Default

10_000

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

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:102