Skip to content

Conversation

@ankur-arch
Copy link
Contributor

@ankur-arch ankur-arch commented Oct 1, 2025

Summary by CodeRabbit

  • Documentation
    • Metrics docs now include a prominent deprecation warning: metrics preview deprecated in Prisma ORM v6.14.0 and planned for removal in v7.
    • Clarified compatibility: metrics supported only in Prisma ORM ≤6.13.x, unavailable in v6.14.0+; metrics blocked when engineType uses the client query compiler.
    • Installation and prerequisites updated with explicit bounded version guidance (e.g., 3.15.0–6.13.x) and concrete install commands; recommends native DB driver metrics or OpenTelemetry as alternatives.

@ankur-arch ankur-arch self-assigned this Oct 1, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 1, 2025

Walkthrough

Updates the Prisma metrics documentation: replaces the initial info block with a standardized info + deprecation warning tied to Prisma ORM v6.14.0 (removal in v7); restricts metrics to Prisma ≤6.13.x; blocks metrics when engineType is 'client'; updates install/compatibility guidance and recommends alternatives (native drivers, OpenTelemetry).

Changes

Cohort / File(s) Summary
Docs: Metrics deprecation & compatibility
content/200-orm/200-prisma-client/600-observability-and-logging/240-metrics.mdx
Replaced initial info admonition with a combined info and deprecation warning; added deprecation tied to v6.14.0 (removed in v7); documented version compatibility (metrics supported only for Prisma ≤6.13.x; $metrics unavailable in v6.14.0+); added blocking condition for engineType: 'client'; updated prerequisites and install commands to require bounded Prisma versions (examples for 6.13.0); advised native DB driver metrics and OpenTelemetry as alternatives; preserved examples/links.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title “feat: add deprecation warning for metrics” succinctly captures the primary change of introducing a deprecation warning for the metrics feature and aligns directly with the documented updates. It is clear, concise, and specific to the main change without unnecessary detail.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch DC-5528-metrics-deprecation

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

@github-actions
Copy link
Contributor

github-actions bot commented Oct 1, 2025

Dangerous URL check

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

@github-actions
Copy link
Contributor

github-actions bot commented Oct 1, 2025

@github-actions
Copy link
Contributor

github-actions bot commented Oct 1, 2025

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.

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Oct 1, 2025

Deploying docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 32e2ff5
Status: ✅  Deploy successful!
Preview URL: https://9f9f42c2.docs-51g.pages.dev
Branch Preview URL: https://dc-5528-metrics-deprecation.docs-51g.pages.dev

View logs

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

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

20-24: Remove removal-version mention from the warning.

The docs style guide says deprecation notices should name the version where the feature was deprecated but must not promise a future removal version, because plans change and become outdated quickly. Please drop the “will be removed in Prisma ORM v7” sentence from this block to stay compliant. As per coding guidelines.(prisma.io)

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 09ceaf5 and 253c34e.

📒 Files selected for processing (1)
  • content/200-orm/200-prisma-client/600-observability-and-logging/240-metrics.mdx (1 hunks)
⏰ 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). (4)
  • GitHub Check: Check internal links
  • GitHub Check: runner / linkspector
  • GitHub Check: Lost Pixel
  • GitHub Check: Cloudflare Pages

@FGoessler
Copy link
Contributor

@ankur-arch can we also add a note that it is not supported at all when using engineType='client' aka the query compiler?

mhessdev
mhessdev previously approved these changes Oct 1, 2025
coderabbitai[bot]
coderabbitai bot previously approved these changes Oct 6, 2025
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

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

74-83: Align the install step heading with the compatibility guidance.

The list link already says “Install compatible…”, but the anchor slug and heading still read “up-to-date”. Renaming both keeps the messaging consistent and prevents broken anchors once the slug updates.

-1. [Install compatible Prisma ORM dependencies](#1-install-up-to-date-prisma-orm-dependencies).
+1. [Install compatible Prisma ORM dependencies](#1-install-compatible-prisma-orm-dependencies).
...
-### 1. Install up-to-date Prisma ORM dependencies
+### 1. Install compatible Prisma ORM dependencies
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 69fc2ca and 32e2ff5.

📒 Files selected for processing (1)
  • content/200-orm/200-prisma-client/600-observability-and-logging/240-metrics.mdx (2 hunks)
⏰ 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). (4)
  • GitHub Check: runner / linkspector
  • GitHub Check: Check internal links
  • GitHub Check: Lost Pixel
  • GitHub Check: Cloudflare Pages

@ankur-arch ankur-arch merged commit fefe8d7 into main Oct 6, 2025
9 of 11 checks passed
@ankur-arch ankur-arch deleted the DC-5528-metrics-deprecation branch October 6, 2025 09:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants