Dashboard
Defined in: src/plugins/application/dashboard/plugin.ts:221
The Dashboard plugin provides a web interface for monitoring and debugging the Shokupan application. It allows you to view request logs, metrics, and other debugging information. Additionally, this plugin shows the scalar, asyncapi and openapi plugins if they are enabled. It uses WebSockets to push updates to the dashboard in real-time.
This plugin will automatically enable the metrics plugin and the fetch interceptor. These are required for the dashboard to function. The fetch interceptor will track all requests and responses for use in the dashboard and Network tab.
When enabled, enableMiddlewareTracking will automatically be enabled on the application.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Dashboard(
dashboardConfig):Dashboard
Defined in: src/plugins/application/dashboard/plugin.ts:255
Parameters
Section titled “Parameters”dashboardConfig
Section titled “dashboardConfig”DashboardConfig = {}
Returns
Section titled “Returns”Dashboard
Properties
Section titled “Properties”metadata
Section titled “metadata”
readonlymetadata:object
Defined in: src/plugins/application/dashboard/plugin.ts:222
pluginName
Section titled “pluginName”pluginName:
string='Dashboard'
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get db():
DatastoreAdapter
Defined in: src/plugins/application/dashboard/plugin.ts:251
Returns
Section titled “Returns”DatastoreAdapter
Methods
Section titled “Methods”getHooks()
Section titled “getHooks()”getHooks():
ShokupanHooks
Defined in: src/plugins/application/dashboard/plugin.ts:1279
Returns
Section titled “Returns”onInit()
Section titled “onInit()”onInit(
app,options?):void
Defined in: src/plugins/application/dashboard/plugin.ts:258
Parameters
Section titled “Parameters”any
options?
Section titled “options?”string
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”recordEdgeMetric()
Section titled “recordEdgeMetric()”recordEdgeMetric(
from,to):void
Defined in: src/plugins/application/dashboard/plugin.ts:1270
Parameters
Section titled “Parameters”string
string
Returns
Section titled “Returns”void
recordNodeMetric()
Section titled “recordNodeMetric()”recordNodeMetric(
id,type,duration,isError):void
Defined in: src/plugins/application/dashboard/plugin.ts:1253
Parameters
Section titled “Parameters”string
string
duration
Section titled “duration”number
isError
Section titled “isError”boolean
Returns
Section titled “Returns”void
validateReplayUrl()
Section titled “validateReplayUrl()”
staticvalidateReplayUrl(url,mountPath,allowedReplayHosts?):object
Defined in: src/plugins/application/dashboard/plugin.ts:1699
Validates a URL for the replay endpoint to prevent SSRF attacks.
Returns an object with an error property if the URL is unsafe.
Parameters
Section titled “Parameters”string
mountPath
Section titled “mountPath”string
allowedReplayHosts?
Section titled “allowedReplayHosts?”string[] | (hostname) => boolean
Returns
Section titled “Returns”object
error?
Section titled “error?”
optionalerror:string