HealthCheckConfig
Defined in: health.ts:66
Health check configuration
Properties
Section titled “Properties”checkBackends?
Section titled “checkBackends?”
optionalcheckBackends:boolean
Defined in: health.ts:100
Check backend health (for routers)
Default
Section titled “Default”truecustomChecks?
Section titled “customChecks?”
optionalcustomChecks:Record<string, () =>Promise<ComponentHealth>>
Defined in: health.ts:94
Custom health checks
includeChecks?
Section titled “includeChecks?”
optionalincludeChecks:boolean
Defined in: health.ts:89
Include component checks
Default
Section titled “Default”trueincludeUptime?
Section titled “includeUptime?”
optionalincludeUptime:boolean
Defined in: health.ts:83
Include uptime in response
Default
Section titled “Default”truemetadata?
Section titled “metadata?”
optionalmetadata:Record<string,unknown>
Defined in: health.ts:105
Additional metadata to include
serviceName?
Section titled “serviceName?”
optionalserviceName:string
Defined in: health.ts:71
Service name
Default
Section titled “Default”'ai.matey'version?
Section titled “version?”
optionalversion:string
Defined in: health.ts:77
Service version
Default
Section titled “Default”'1.0.0'