UNPKG

@dudousxd/nestjs-telescope

Version:

Laravel Telescope-style observability console for NestJS — core: watchers, recorder, correlation, SQLite store, headless API.

53 lines 3.11 kB
import { type CallHandler, type ExecutionContext, type NestInterceptor } from '@nestjs/common'; import { type Observable } from 'rxjs'; import { type TelescopeModuleOptions } from './telescope.options.js'; import { TelescopeService } from './telescope.service.js'; /** * Captures exceptions thrown out of route handlers as `exception` entries so * they group into families, drive the `new-exception` alert, and feed AI * diagnosis. * * WHY a 4xx default-skip: expected 4xx control flow is NOT an incident. A * `ForbiddenException` (403), `NotFoundException` (404) or a validation 400 is * the framework doing its job — permission denied, resource missing, bad input. * Recording those as exception entries means every permission denial in * production opens a NEW exception family (the family hash keys on * name+message+top-frame, so each call site is its own family), which fires the * `new-exception` Slack alert and, in AI auto-mode, spends Bedrock tokens on a * "diagnosis" of intended behaviour. We hit exactly this: Telescope's own * client-errors `authorize` gate threw a 403, the interceptor captured it as a * brand-new family, paged Slack, and burned an AI diagnosis. So by default a * NestJS `HttpException` whose status is < 500 is dropped here. * * The information is NOT lost: the request-capture middleware records the 4xx * `statusCode` on its own `request` entry (independently, on the response * `finish` event), so the dashboard still shows the 4xx — it just doesn't spawn * an exception family, can't fire `new-exception`, and can't trigger diagnosis. * * The escape hatch is `exceptions.captureHttp4xx: true`, which restores the * pre-change behaviour (capture everything) for hosts that genuinely treat 4xx * as exceptions worth grouping/alerting on. * * NOT affected by this filter: 5xx HttpExceptions (real server errors), * non-HTTP errors (any thrown `Error` that isn't an `HttpException`), and the * client-errors ingestion endpoint's `client_exception` entries (recorded * directly in the controller, never through this interceptor — those are * deliberate browser reports and are always kept). */ export declare class TelescopeExceptionInterceptor implements NestInterceptor { private readonly service; private readonly options; constructor(service: TelescopeService, options: TelescopeModuleOptions); intercept(_context: ExecutionContext, next: CallHandler): Observable<unknown>; /** * Decides whether a thrown error is expected 4xx control flow that should NOT * become an exception entry. True only for a NestJS `HttpException` whose * `getStatus()` is a 4xx (>= 400 and < 500), and only while the * `captureHttp4xx` escape hatch is off (the default). Detected via * `instanceof HttpException` from `@nestjs/common` (a peer dep), which also * covers all the built-in subclasses (`ForbiddenException`, * `NotFoundException`, `BadRequestException`, the validation-pipe 400, …). */ private shouldSkipAsControlFlow; } //# sourceMappingURL=telescope-exception.interceptor.d.ts.map