nest-profiler
API reference for @eleven-labs/nest-profiler — module options, profile structure, service, collector interface and storage adapters.
ProfilerModuleOptions
Options passed to ProfilerModule.forRoot().
Prop
Type
ProfilerModuleAsyncOptions
Options passed to ProfilerModule.forRootAsync().
Prop
Type
Profile
Full data structure for a collected request profile.
Prop
Type
RequestData
Prop
Type
ResponseData
Prop
Type
PerformanceData
Prop
Type
RouteInfo
Prop
Type
LogEntry
Prop
Type
ExceptionEntry
Prop
Type
TimelineSpan
Entry written by ProfilerService.startSpan().
Prop
Type
SecurityContext
Populated by the Auth collector when request.user is present.
Prop
Type
ProfilerService
Injectable facade. Inject it in any provider or controller to instrument your application.
Prop
Type
IProfilerCollector
Interface to implement when building a custom collector.
Prop
Type
IProfilerStorageAdapter
Interface for plugging in a custom storage backend.
Prop
Type
StorageFindOptions
Filter options accepted by IProfilerStorageAdapter.findAll().
Prop
Type
FileStorageAdapterOptions
Options for the built-in file-system storage adapter.
Prop
Type
CollectorPanelInfo
Panel metadata returned by CollectorRegistry.buildPanels(), passed to EJS templates and the toolbar.
Prop
Type
Public exports
import {
ProfilerModule,
ProfilerService,
ProfilerStorageService,
ProfilerViewsSetup,
CollectorRegistry,
ProfilerCollector,
TimelineCollector,
PROFILER_STORAGE_ADAPTER,
MemoryStorageAdapter,
FileStorageAdapter,
} from '@eleven-labs/nest-profiler';
import type {
ProfilerModuleOptions,
ProfilerModuleAsyncOptions,
IProfilerCollector,
IProfilerStorageAdapter,
StorageFindOptions,
FileStorageAdapterOptions,
MemoryStorageAdapterOptions,
CollectorPanelInfo,
Profile,
RequestData,
ResponseData,
PerformanceData,
RouteInfo,
LogEntry,
ExceptionEntry,
LogLevel,
TimelineSpan,
EventEntry,
SecurityContext,
} from '@eleven-labs/nest-profiler';