NestJS Profiler
Packages

nest-profiler-mikro-orm

Profile MikroORM SQL queries in the Database panel.

@eleven-labs/nest-profiler-mikro-orm

@eleven-labs/nest-profiler-mikro-orm captures every SQL query executed by MikroORM during a profiled execution and displays them in a dedicated Database panel.

Database panel — MikroORM SQL queries with type badge, duration bar and slow-query highlighting

Installation

pnpm add -D @eleven-labs/nest-profiler-mikro-orm

Peer dependencies: @mikro-orm/core ^7.0.0, @mikro-orm/nestjs ^7.0.0 (7.1+ on NestJS 12) — your app's own dependencies, installed with a plain pnpm add.

Setup

Keep MikroOrmModule.forRoot({ ... }) in your application module and register MikroOrmCollectorModule in the dev-only profiling bundle. No extra MikroORM configuration is required — the collector wraps the ORM logger automatically:

profiling/profiling.module.ts
import { Module } from '@nestjs/common';
import { ProfilerModule } from '@eleven-labs/nest-profiler';
import { MikroOrmCollectorModule } from '@eleven-labs/nest-profiler-mikro-orm';

@Module({
  imports: [
    ProfilerModule.forRoot({ isGlobal: true }),
    MikroOrmCollectorModule.forRoot({
      slowThreshold: 100,
      nPlusOneThreshold: 2,
      slowSeverity: 'warning',
    }), // slow/N+1 tagging + severity
  ],
})
export class ProfilingModule {}

ProfilingModule is the dev-only bundle loaded by main-dev.ts — see Enabling and disabling the profiler. If the profiler is installed as a production dependency behind the runtime gate, wrap the same call in ConditionalModule.registerWhen(..., isProfilerEnabled).

The collector resolves the MikroORM instance by its injection token (pass connectionName for a named context), and AppDevModule imports the bundle after AppModule, so the ORM already exists when the collector wraps its logger.

What it collects

For each SQL query executed during a request:

FieldDescription
sqlThe SQL query string (with keyword highlighting)
parametersBound parameters
durationExecution time in ms (from MikroORM's took)
typeSELECT, INSERT, UPDATE, DELETE, OTHER
startedAtUnix timestamp
errorSet when MikroORM reports the query at error level
streamingtrue for streaming reads (QueryBuilder.stream(), duration: 0)
rowCountRows affected (affected) or returned (results), from the log
connectionConnection endpoint host:port, else the log's connection name
databaseTarget database name (dbName)
fingerprintParameter-free normalized SQL, used to group N+1s
tagsPerformance tags applied by the core rule engine

Slow queries, N+1 patterns and silent zero-row UPDATE/DELETEs (the zero-rows tag) are flagged by the core rule engine and shown as coloured pills (and filterable on the list page). See Performance tags.

Toolbar badge

The toolbar badge shows: {n}q (e.g., 5q). When slow queries are present: 5q (2 slow).

How it works

The collector wraps MikroORM's Logger.logQuery at module initialization (OnModuleInit). MikroORM's SQL connection always measures execution time and calls logQuery with the query, its parameters and the elapsed took; the collector pushes a query entry into the active request profile (resolved via nestjs-cls) and lets the original logger handle console output only if you had query logging enabled. Queries executed outside a request context (startup, background jobs) are silently ignored.

This captures all queries issued through the EntityManager, repositories and the QueryBuilder.

Streaming reads — QueryBuilder.stream() is captured too, since MikroORM's SQL connection calls logQuery for it like any other query. It is logged at stream start (before rows are consumed) with no took; a SELECT logged without took is therefore detected as a streaming read and flagged streaming: true (a normal query always carries took, and transaction/savepoint control is type OTHER). Its duration stays 0 — measuring the real value would require intrusively wrapping MikroORM's internal row generator, so it is left as a documented limitation. The panel labels such rows not timed (stream).

Schema panel

MikroOrmSchemaCollectorModule adds a global Schemas / MikroORM view to the profiler home page, listing every registered entity with its columns (type, nullable, primary key, generated, default), relations (kind → target) and indexes (name, columns, unique). Unlike the per-request Database panel, this is static process-level data introspected once at startup — so it renders on the home page, under the sidebar's Schemas heading, not inside a profile.

Add it to the profiling bundle's imports:

profiling/profiling.module.ts
import { MikroOrmSchemaCollectorModule } from '@eleven-labs/nest-profiler-mikro-orm';

MikroOrmSchemaCollectorModule.forRoot(),

Pass connectionName to introspect a named MikroORM context (omit it for the default), and enabled: false to disable per environment. The panel reads orm.getMetadata() and never touches data; column defaults are passed through the profiler's redactString, so a default embedding a secret is masked. The panel no-ops (does not appear) when no MikroORM context is wired.

Entity relationship diagram

The panel opens with a collapsible Entity relationship diagram section: a Mermaid erDiagram of the registered entities, with their columns (PK / UK keys) and one line per relation in crow's-foot notation. Both sides of a bidirectional relation (paired through mappedBy / inversedBy, declared on either side) are drawn as a single line labelled with the two property names.

The diagram is rendered in the browser and nothing has to be installed: the first time the section is opened, the profiler page loads Mermaid from jsDelivr — a single, version-pinned file checked against its Subresource Integrity hash, and the only third-party URL the profiler's CSP allows. When the CDN is unreachable (offline or air-gapped machines), the section shows the Mermaid source instead. Copy Mermaid copies that source in every case, ready to paste into a README, a GitHub comment or mermaid.live.

The diagram is drawn in a pannable, zoomable viewport so large schemas stay legible: drag to pan, Ctrl / ⌘ + scroll (or pinch, or double-click) to zoom around the cursor, and use the toolbar to zoom, return to 100 %, fit the whole diagram or expand it to the full window (Esc to leave). Go to entity centres and highlights one entity. While the diagram has focus, + / - zoom, 0 fits, 1 returns to 100 % and the arrow keys pan.

Powered & maintained by

On this page