docs(metrics): remove metrics API

[mhartington]

Summary by CodeRabbit

Documentation

• Updated observability guidance: Removed metrics feature documentation and directed users toward native database driver metrics and OpenTelemetry for observability.
• Connection pool documentation: Clarified viewing pool size through logging and built-in driver adapter APIs.
• API reference updates: Removed metrics-related sections from Prisma Client reference documentation.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This PR removes Prisma Client's built-in metrics feature from documentation. It replaces metric-based code examples with counter-based alternatives, removes $metrics from the API reference, redirects users toward driver-native metrics and OpenTelemetry for observability, and updates connection pooling guidance accordingly.

Changes

Cohort / File(s)	Summary
Metrics deprecation & removal content/200-orm/200-prisma-client/600-observability-and-logging/240-metrics.mdx, content/200-orm/500-reference/050-prisma-client-reference.mdx	Replaces detailed metrics documentation with removal notice; removes $metrics subsection and methods ($metrics.json(), $metrics.prometheus()) from API reference; directs users to alternative observability approaches
Client extension refactor content/200-orm/200-prisma-client/300-client-extensions/110-client.mdx	Replaces metric-based $totalQueries implementation with counter-based approach; adds query.$allModels.$allOperations hook; updates example to reflect new counter behavior
Connection pooling clarification content/200-orm/200-prisma-client/000-setup-and-configuration/050-databases-connections/115-connection-pool.mdx	Updates wording to reference logging and driver-adapter built-in APIs instead of metrics
Observability guidance updates content/200-orm/200-prisma-client/600-observability-and-logging/250-opentelemetry-tracing.mdx, content/200-orm/800-more/400-comparisons/04-prisma-and-drizzle.mdx, content/250-postgres/1200-more/1000-faq.mdx	Removes references to aggregated metrics; eliminates per-query observability details from comparisons; simplifies operation estimation guidance without metrics

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Areas requiring attention:

• Verify no broken internal documentation links result from $metrics removal
• Validate that the new counter-based example in 110-client.mdx provides functional parity with the old metric-driven approach
• Confirm redirect guidance to OpenTelemetry and driver-native metrics is sufficiently detailed for migration
• Check that FAQ changes accurately reflect the new supported observability story
• Ensure connection pooling updates maintain clarity for users deploying with different driver adapters

Possibly related PRs

• feat: update serverless driver docs #7272: Updates same connection-pool documentation and driver-adapter guidance
• feat: add deprecation warning for metrics #7151: Modifies metrics documentation with related removal/deprecation rationale
• Docs for Prisma ORM v6.16.0 #7096: Edits same connection-pool docs file

Pre-merge checks

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title 'docs(metrics): remove metrics API' directly and accurately describes the main objective of the changeset—removing metrics-related documentation and API references across multiple files.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ef1bea8 and 8c77313.

📒 Files selected for processing (5)

• content/200-orm/200-prisma-client/000-setup-and-configuration/050-databases-connections/115-connection-pool.mdx (1 hunks)
• content/200-orm/200-prisma-client/300-client-extensions/110-client.mdx (1 hunks)
• content/200-orm/200-prisma-client/600-observability-and-logging/240-metrics.mdx (8 hunks)
• content/200-orm/200-prisma-client/600-observability-and-logging/250-opentelemetry-tracing.mdx (2 hunks)
• content/200-orm/500-reference/050-prisma-client-reference.mdx (0 hunks)

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

Dangerous URL check

No absolute URLs to prisma.io/docs found.
No local URLs found.

[github-actions]

Redirect check

This PR probably requires the following redirects to be added to static/_redirects:

• This PR does not change any pages in a way that would require a redirect.

[github-actions]

🍈 Lychee Link Check Report

Note: Links are cached for 5 minutes to avoid unnecessary requests, and speed up consecutive runs.

📊 Results Overview

Status	Count
🔍 Total	2384
✅ Successful	2109
⏳ Timeouts	0
🔀 Redirected	253
👻 Excluded	21
❓ Unknown	0
🚫 Errors	0
⛔ Unsupported	1

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

content/200-orm/200-prisma-client/000-setup-and-configuration/050-databases-connections/115-connection-pool.mdx (1)

89-89: Hyphenate compound adjective.

Change "built in APIs" to "built-in APIs" to follow standard English grammar for compound adjectives. As per coding guidelines, hyphens join compound modifiers that precede a noun.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3bf085d and 1b1cf8a.

📒 Files selected for processing (8)

• content/200-orm/200-prisma-client/000-setup-and-configuration/050-databases-connections/115-connection-pool.mdx (1 hunks)
• content/200-orm/200-prisma-client/300-client-extensions/110-client.mdx (1 hunks)
• content/200-orm/200-prisma-client/600-observability-and-logging/240-metrics.mdx (0 hunks)
• content/200-orm/200-prisma-client/600-observability-and-logging/250-opentelemetry-tracing.mdx (2 hunks)
• content/200-orm/500-reference/050-prisma-client-reference.mdx (0 hunks)
• content/200-orm/500-reference/500-preview-features/050-client-preview-features.mdx (1 hunks)
• content/200-orm/800-more/400-comparisons/04-prisma-and-drizzle.mdx (0 hunks)
• content/250-postgres/1200-more/1000-faq.mdx (1 hunks)

💤 Files with no reviewable changes (3)

• content/200-orm/800-more/400-comparisons/04-prisma-and-drizzle.mdx
• content/200-orm/200-prisma-client/600-observability-and-logging/240-metrics.mdx
• content/200-orm/500-reference/050-prisma-client-reference.mdx

🧰 Additional context used

🧠 Learnings (2)

📚 Learning: 2025-08-11T09:40:55.237Z

Learnt from: ankur-arch
Repo: prisma/docs PR: 7066
File: content/200-orm/200-prisma-client/700-debugging-and-troubleshooting/245-troubleshooting-binary-size-issues.mdx:8-22
Timestamp: 2025-08-11T09:40:55.237Z
Learning: When the queryCompiler preview feature is enabled in Prisma ORM (v6.7.0+), it does not require Rust engines for CLI tools like `prisma migrate` or `prisma db pull`. The previous understanding that CLI tools would still need Rust binaries even with queryCompiler enabled is incorrect.

Applied to files:

• content/200-orm/500-reference/500-preview-features/050-client-preview-features.mdx

📚 Learning: 2025-10-09T21:32:50.340Z

Learnt from: aidankmcalister
Repo: prisma/docs PR: 7167
File: content/900-ai/prompts/astro.mdx:84-84
Timestamp: 2025-10-09T21:32:50.340Z
Learning: The `npx prisma init` command supports the following flags: `--db` (shorthand for `--datasource-provider prisma+postgres`), `--output` (specifies output location for generated client), `--generator-provider` (defines the generator provider), `--datasource-provider`, `--url`, `--preview-feature`, and `--with-model`. These are documented valid CLI options for Prisma init command.

Applied to files:

• content/200-orm/500-reference/500-preview-features/050-client-preview-features.mdx

🪛 LanguageTool

content/200-orm/200-prisma-client/000-setup-and-configuration/050-databases-connections/115-connection-pool.mdx

[grammar] ~89-~89: Use a hyphen to join words.
Context: ...rvability-and-logging/logging) and built in APIs provided by the Prisma Postgres ...

(QB_NEW_EN_HYPHEN)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

• GitHub Check: runner / linkspector
• GitHub Check: Check internal links
• GitHub Check: Cloudflare Pages

🔇 Additional comments (6)

content/200-orm/200-prisma-client/600-observability-and-logging/250-opentelemetry-tracing.mdx (1)

10-14: Clean refinement of the info block.

The info block now focuses exclusively on tracing's operation-level insights, removing the competing reference to aggregated metrics. This improves clarity by keeping the message laser-focused on what the page covers.

content/200-orm/200-prisma-client/000-setup-and-configuration/050-databases-connections/115-connection-pool.mdx (1)

87-89: Content update appropriately redirects users to available APIs.

Shifting the documentation focus from metrics to "built-in APIs provided by the Prisma Postgres Driver" aligns with the PR's removal of metrics and properly guides users toward the actual observability mechanisms available in the connection pool section.

content/200-orm/500-reference/500-preview-features/050-client-preview-features.mdx (1)

15-23: Clean removal of metrics from active preview features.

The metrics preview feature row is removed and the table is reordered with no gaps or broken references. The remaining features are properly aligned with their release versions and feedback channels.

content/200-orm/200-prisma-client/300-client-extensions/110-client.mdx (2)

37-37: Updated description matches implementation.

The description now accurately reflects that $totalQueries returns the number of queries executed, aligning with the new counter-based implementation.

---

39-56: Well-designed migration pattern from metrics to simple counter.

The example elegantly demonstrates how users can replicate operation counting without the metrics API. Using a module-level counter and a query extension hook is:

• Straightforward and transparent
• Follows the extension pattern already shown for $log
• Provides a clear model for users to adapt to their own observability needs

The code is syntactically correct and the pattern is sound.

content/250-postgres/1200-more/1000-faq.mdx (1)

98-100: Appropriate simplification of operation-counting guidance.

The FAQ answer now provides general guidance on using APM tools like Prometheus, removing the metrics-specific walkthrough. This aligns with the metrics removal and respects that users have multiple observability strategies available—from the counter pattern shown in the client extensions guide to external APM integrations.

[cloudflare-workers-and-pages]

Deploying docs with    Cloudflare Pages

Latest commit:	8c77313
Status:	⚡️  Build in progress...

View logs

[coderabbitai]

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

content/200-orm/200-prisma-client/600-observability-and-logging/240-metrics.mdx (1)

13-19: Page structure undermines the removal notice—visible placeholder comments create confusing UX for users redirected here.

The danger admonition (lines 13–19) is clear and correct. However, the file contains approximately 13 instances of bare /* Lines X-Y omitted */ comments throughout the page that will render as visible text in the final output—these are not proper MDX comments (which would use {/* */} syntax).

Additionally, old section headers ("Prerequisites," "Retrieve metrics in JSON format," "Retrieve metrics in Prometheus format," "Global labels") remain intact with their content replaced by visible placeholders. The _redirects configuration routes old URLs directly to this page, meaning users arriving via redirects will see the removal notice followed by sections with visible placeholder text—creating an incomplete and confusing experience.

To fix:

1. Replace bare /* */ comments with proper hidden MDX syntax or remove entirely. The visible placeholders undermine clarity.
2. Choose one approach for the page structure:
   • Minimal removal page: Keep only the danger admonition (lines 13–19) and a brief "See alternatives" section with links to driver metrics docs and OpenTelemetry tracing. Delete all old headers and placeholders.
   • Complete removal: Delete the page entirely and ensure _redirects routes to the alternatives (e.g., observability documentation landing page).
3. Update the Prerequisites section if kept—it currently instructs users to install v3.15.0–6.13.x, which is now outdated and contradicts the removal notice.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1b1cf8a and ef1bea8.

📒 Files selected for processing (2)

• content/200-orm/200-prisma-client/000-setup-and-configuration/050-databases-connections/115-connection-pool.mdx (1 hunks)
• content/200-orm/200-prisma-client/600-observability-and-logging/240-metrics.mdx (9 hunks)

🧰 Additional context used

🧠 Learnings (5)

📓 Common learnings

Learnt from: aidankmcalister
Repo: prisma/docs PR: 7165
File: content/800-guides/550-test-guide.mdx:85-90
Timestamp: 2025-10-08T16:23:00.388Z
Learning: For .mdx files in the prisma/docs repository: Only flag code snippets for (1) exposed secrets with real-looking values that should be placeholders (e.g., API keys, database passwords, AWS credentials), or (2) blatant syntax errors like missing parentheses, brackets, braces, or mismatched delimiters. Do not flag code quality issues, anti-patterns, security vulnerabilities, missing error handling, unused variables, or any other bad practices, as documentation intentionally shows problematic code.

📚 Learning: 2025-10-08T16:23:00.388Z

Learnt from: aidankmcalister
Repo: prisma/docs PR: 7165
File: content/800-guides/550-test-guide.mdx:85-90
Timestamp: 2025-10-08T16:23:00.388Z
Learning: For .mdx files in the prisma/docs repository: Only flag code snippets for (1) exposed secrets with real-looking values that should be placeholders (e.g., API keys, database passwords, AWS credentials), or (2) blatant syntax errors like missing parentheses, brackets, braces, or mismatched delimiters. Do not flag code quality issues, anti-patterns, security vulnerabilities, missing error handling, unused variables, or any other bad practices, as documentation intentionally shows problematic code.

Applied to files:

• content/200-orm/200-prisma-client/600-observability-and-logging/240-metrics.mdx

📚 Learning: 2025-10-08T16:22:57.129Z

Learnt from: aidankmcalister
Repo: prisma/docs PR: 7165
File: content/800-guides/550-test-guide.mdx:50-66
Timestamp: 2025-10-08T16:22:57.129Z
Learning: In `.mdx` files, do NOT flag or suggest changes for the following code quality issues even if they represent poor practices: React anti-patterns (using var instead of useState, direct DOM manipulation), missing keys in .map() iterations, non-serializable props in getServerSideProps, unused variables, missing error handling, SQL injection vulnerabilities (unless actively showing how to fix them), insecure cookie settings, missing TypeScript types, PrismaClient instantiation patterns, or any other code quality, security, or performance issues. Documentation code snippets are copied from source code and often intentionally show "before" examples or common mistakes.

Applied to files:

• content/200-orm/200-prisma-client/600-observability-and-logging/240-metrics.mdx

📚 Learning: 2025-08-11T09:40:55.237Z

Learnt from: ankur-arch
Repo: prisma/docs PR: 7066
File: content/200-orm/200-prisma-client/700-debugging-and-troubleshooting/245-troubleshooting-binary-size-issues.mdx:8-22
Timestamp: 2025-08-11T09:40:55.237Z
Learning: When the queryCompiler preview feature is enabled in Prisma ORM (v6.7.0+), it does not require Rust engines for CLI tools like `prisma migrate` or `prisma db pull`. The previous understanding that CLI tools would still need Rust binaries even with queryCompiler enabled is incorrect.

Applied to files:

• content/200-orm/200-prisma-client/600-observability-and-logging/240-metrics.mdx

📚 Learning: 2025-10-09T21:32:50.340Z

Learnt from: aidankmcalister
Repo: prisma/docs PR: 7167
File: content/900-ai/prompts/astro.mdx:84-84
Timestamp: 2025-10-09T21:32:50.340Z
Learning: The `npx prisma init` command supports the following flags: `--db` (shorthand for `--datasource-provider prisma+postgres`), `--output` (specifies output location for generated client), `--generator-provider` (defines the generator provider), `--datasource-provider`, `--url`, `--preview-feature`, and `--with-model`. These are documented valid CLI options for Prisma init command.

Applied to files:

• content/200-orm/200-prisma-client/600-observability-and-logging/240-metrics.mdx

🪛 LanguageTool

content/200-orm/200-prisma-client/000-setup-and-configuration/050-databases-connections/115-connection-pool.mdx

[grammar] ~89-~89: Use a hyphen to join words.
Context: ...rvability-and-logging/logging) and built in APIs provided by the driver adapter b...

(QB_NEW_EN_HYPHEN)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Cloudflare Pages

[github-actions]

🍈 Lychee Link Check Report

Note: Links are cached for 5 minutes. Failed links (timeouts, rate limits) are retried in a second run with longer timeout.

📊 Results Overview

Status	Count
🔍 Total	2238
✅ Successful	2214
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	22
❓ Unknown	0
🚫 Errors	1
⛔ Unsupported	1

Errors per input

Errors in 200-orm/200-prisma-client/600-observability-and-logging/240-metrics.mdx

• [404] https://github.com/prisma/prisma/releases/tag/7.0.0 | Error (cached)
  Full Github Actions output

[github-actions]

🍈 Lychee Link Check Report

Note: Links are cached for 5 minutes. Failed links (timeouts, rate limits) are retried in a second run with longer timeout.

📊 Results Overview

Status	Count
🔍 Total	2232
✅ Successful	2203
⏳ Timeouts	0
🔀 Redirected	4
👻 Excluded	23
❓ Unknown	0
🚫 Errors	1
⛔ Unsupported	1

Errors per input

Errors in 200-orm/200-prisma-client/600-observability-and-logging/240-metrics.mdx

• [404] https://github.com/prisma/prisma/releases/tag/7.0.0 | Error (cached)