Skip to content
Telemetry
Integration guide

Prisma ORM database telemetry

Measure Prisma operation fingerprints, model and method latency, failures, result counts, releases, and database-dependent workflows without collecting raw query parameters.

Reviewed by the Telemetry product team on . We checked which events to send, which data to exclude, and how to add the code. Who reviews this page

Useful for
  • Prisma operation latency
  • Release regression analysis
  • Database-dependent workflow debugging
Test the integration

Send and verify events with Prisma ORM database telemetry

Use Prisma ORM database telemetry where your app knows the final result. Collect only the fields you need, then verify a test event before building charts.

  1. 1

    Choose the outcome

    Prisma operation latency

  2. 2

    Define the contract

    query_fingerprint, prisma_model, prisma_operation, and workflow

  3. 3

    Log the final result

    Wrap product-level Prisma calls with an explicit fingerprint such as User.findMany.active instead of forwarding emitted SQL.

  4. 4

    Check the stored event

    Exercise a known fixture, then inspect database_query_completed for one correctly typed terminal row.

Before you start

Before you start

  • Prisma Client initialized on the server
  • Stable operation names chosen at application call sites
  • A server-side TELEMETRY_API_KEY

Delivery setup

Install and initialize server-side

Import telemetry-sh in server-only code and initialize it once with process.env.TELEMETRY_API_KEY. Keep ingestion credentials out of browser bundles, client-visible environment variables, source control, logs, and exception messages.

prisma-install

npm installation

bash
npm install telemetry-sh
  1. 1Create one reusable server-side client. Set its timeout and retry limit.
  2. 2Log an event when the operation succeeds, fails, retries, or times out.
  3. 3Send test events with known results and inspect the stored rows before enabling an alert.

Snippet

Start with one structured event

Add this shape where the workflow completes, fails, or retries. Then build the dashboard from real fields.

prisma

Prisma ORM database telemetry event

javascript
import telemetry from "telemetry-sh";

const SAFE_DATABASE_ERROR_CODES = new Set(["P2024", "P2034"]);

function classifyDatabaseError(error) {
  return error && typeof error === "object" &&
    "code" in error &&
    SAFE_DATABASE_ERROR_CODES.has(String(error.code))
    ? String(error.code)
    : "database_error";
}

async function observePrismaOperation({
  queryFingerprint,
  model,
  operation,
  workflow,
  run,
}) {
  const startedAt = performance.now();
  try {
    const result = await run();
    await telemetry.log("database_query_completed", {
      query_fingerprint: queryFingerprint,
      prisma_model: model,
      prisma_operation: operation,
      workflow,
      database_name: "app_production",
      status: "success",
      duration_ms: Math.round(performance.now() - startedAt),
      rows_returned: Array.isArray(result) ? result.length : 1,
      release: process.env.APP_RELEASE,
      environment: process.env.NODE_ENV,
    });
    return result;
  } catch (error) {
    await telemetry.log("database_query_completed", {
      query_fingerprint: queryFingerprint,
      prisma_model: model,
      prisma_operation: operation,
      workflow,
      database_name: "app_production",
      status: "failed",
      duration_ms: Math.round(performance.now() - startedAt),
      error_type: classifyDatabaseError(error),
      release: process.env.APP_RELEASE,
      environment: process.env.NODE_ENV,
    });
    throw error;
  }
}

const users = await observePrismaOperation({
  queryFingerprint: "User.findMany.active",
  model: "User",
  operation: "findMany",
  workflow: "account_directory",
  run: () => prisma.user.findMany({ where: { active: true } }),
});

Event schema

query_fingerprint, prisma_model, prisma_operation, and workflow

status, duration_ms, rows_returned, controlled error_type, and account_id

database_name, release, environment, and safe correlation identifiers

Check your setup

Checkpoint 1

Wrap product-level Prisma calls with an explicit fingerprint such as User.findMany.active instead of forwarding emitted SQL.

Checkpoint 2

Keep model, operation, and workflow separate so a database regression can be connected to customer-visible behavior.

Checkpoint 3

Prisma query events expose SQL and parameters; do not send either field to Telemetry.

Verification

Prove the event arrived

Run this after exercising known success and failure cases. Replace the fallback table name if your final event contract differs from the snippet.

prisma-verification

Prisma ORM database telemetry verification query

sql
SELECT *
FROM database_query_completed
ORDER BY timestamp_utc DESC
LIMIT 20;
Confirm one terminal row per logical outcome, with the expected status, identifiers, units, and UTC time.
Inspect the inferred schema and verify that retries do not change field types or generate a new logical event ID.
Search the stored fields for credentials, raw payloads, prompts, private content, and unbounded error messages.
Exercise a provider timeout, ingestion rejection, and process shutdown before treating the dashboard as complete.

Implementation references

Review the event contract, data-safety guidance, and upstream primary documentation before enabling a new production path.

Where to log

Keep the outcome event small and recoverable

This pattern provides

  • Record the outcome as an event you can query with SQL.
  • Stable fields for dashboards, alerts, and cross-event correlation.
  • Test events for checking success, failure, retries, and timeouts.

This pattern does not provide

  • An OTLP exporter, automatic collection pipeline, or replacement for detailed traces and diagnostic logs.
  • Exactly-once delivery merely because the payload contains an event ID.
  • Permission to collect raw provider payloads, user content, credentials, or regulated data.

Example event schemas

Check what each event records, when to send it, and which field types it needs. Review the example payload and privacy checklist before using it in production.

Use these queries in Telemetry

Learn about SQL query API

Run read-only DataFusion SQL over structured-event tables and reuse the result.

Related SQL recipes

More SQL recipes

Run the query using this workflow's event fields and check the example result. Save the result to a dashboard or set up an alert.

Browse all recipes
Recipe collectionsDatabase reliability SQL

Browse by implementation family

Compare related integration patterns

Templates to pair with this integration

More integrations