Documentation / @zerotal/telemetry / TelemetryMiddleware
Class: TelemetryMiddleware
Defined in: telemetry/src/middleware/TelemetryMiddleware.ts:27
Creates a server-kind root span for every incoming HTTP request.
Standard http.* attributes are set automatically:
http.method,http.url,http.route,http.status_codehttp.request_id
Any child spans created with withSpan() inside route handlers or
downstream middleware will automatically attach to this root span.
Register near the top of the middleware stack, after LoggerMiddleware:
app.use([LoggerMiddleware, TelemetryMiddleware, ...])
Extends
Constructors
Constructor
new TelemetryMiddleware():
TelemetryMiddleware
Defined in: core/src/middleware/BaseMiddleware.ts:36
Returns
TelemetryMiddleware
Inherited from
Properties
options
protectedoptions:TelemetryOptions={}
Defined in: telemetry/src/middleware/TelemetryMiddleware.ts:28
Subclasses must declare this with their default option values. TypeScript enforces this at compile time — forgetting it is a type error.
Overrides
Methods
with()
staticwith<T,Opts>(this,options): () =>InstanceType<T>
Defined in: core/src/middleware/BaseMiddleware.ts:48
Returns a zero-arg subclass with the given options deep-merged on top of the subclass defaults, usable directly in app.use([...]).
Type Parameters
T
T extends (...args) => BaseMiddleware<any>
Opts
Opts = T extends (...args) => BaseMiddleware<U> ? U : object
Parameters
this
T
options
Partial<Opts>
Returns
() => InstanceType<T>
Inherited from
afterResponse()?
optionalafterResponse(ctx):Promise<void>
Defined in: core/src/middleware/BaseMiddleware.ts:70
Parameters
ctx
Returns
Promise<void>
Inherited from
onError()?
optionalonError(ctx,error):Promise<void>
Defined in: core/src/middleware/BaseMiddleware.ts:71
Parameters
ctx
error
Error
Returns
Promise<void>
Inherited from
handle()
handle(
http,next):Promise<void|Response>
Defined in: telemetry/src/middleware/TelemetryMiddleware.ts:30
Parameters
http
next
Returns
Promise<void | Response>