diff --git a/content/200-orm/200-prisma-client/000-setup-and-configuration/050-databases-connections/115-connection-pool.mdx b/content/200-orm/200-prisma-client/000-setup-and-configuration/050-databases-connections/115-connection-pool.mdx index 632ecd38f2..6978e7448f 100644 --- a/content/200-orm/200-prisma-client/000-setup-and-configuration/050-databases-connections/115-connection-pool.mdx +++ b/content/200-orm/200-prisma-client/000-setup-and-configuration/050-databases-connections/115-connection-pool.mdx @@ -145,7 +145,7 @@ datasource db { #### Viewing the connection pool size -The number of connections Prisma Client uses can be viewed using [logging](/orm/prisma-client/observability-and-logging/logging) and [metrics](/orm/prisma-client/observability-and-logging/metrics). +The number of connections Prisma Client uses can be viewed using [logging](/orm/prisma-client/observability-and-logging/logging) and built-in APIs provided by the driver adapter being used. Using the `info` [logging level](/orm/reference/prisma-client-reference#log-levels), you can log the number of connections in a connection pool that are opened when Prisma Client is instantiated. diff --git a/content/200-orm/200-prisma-client/300-client-extensions/110-client.mdx b/content/200-orm/200-prisma-client/300-client-extensions/110-client.mdx index 5b1672e143..c530b6f78f 100644 --- a/content/200-orm/200-prisma-client/300-client-extensions/110-client.mdx +++ b/content/200-orm/200-prisma-client/300-client-extensions/110-client.mdx @@ -34,7 +34,7 @@ const prisma = new PrismaClient().$extends({ The following example uses the `client` component to add two methods to Prisma Client: - `$log` outputs a message. -- `$totalQueries` returns the number of queries executed by the current client instance. It uses the [metrics](/orm/prisma-client/observability-and-logging/metrics) feature to collect this information. +- `$totalQueries` returns the number of queries executed by the current client instance. :::info @@ -42,21 +42,20 @@ To use metrics in your project, you must enable the `metrics` feature flag in th ::: -```ts +const total = 0 const prisma = new PrismaClient().$extends({ client: { $log: (s: string) => console.log(s), - async $totalQueries() { - const index_prisma_client_queries_total = 0 - // Prisma.getExtensionContext(this) in the following block - // returns the current client instance - const metricsCounters = await ( - await Prisma.getExtensionContext(this).$metrics.json() - ).counters - - return metricsCounters[index_prisma_client_queries_total].value - }, + async $totalQueries() { return total; }, }, + query: { + $allModels: { + async $allOperations({ query, args }) { + total += 1; + return query(args); + }, + }, + }, }) async function main() { diff --git a/content/200-orm/200-prisma-client/600-observability-and-logging/240-metrics.mdx b/content/200-orm/200-prisma-client/600-observability-and-logging/240-metrics.mdx index 65b0680781..0819f888c7 100644 --- a/content/200-orm/200-prisma-client/600-observability-and-logging/240-metrics.mdx +++ b/content/200-orm/200-prisma-client/600-observability-and-logging/240-metrics.mdx @@ -9,21 +9,10 @@ toc_max_heading_level: 4 Prisma Client metrics give you a detailed insight into how Prisma Client interacts with your database. You can use this insight to help diagnose performance issues with your application. -:::info -If you want an even more detailed insight into your Prisma Client's performance, at the level of individual operations, see [Tracing](/orm/prisma-client/observability-and-logging/opentelemetry-tracing). +:::danger[`metrics` preview feature has been removed ] -::: - -:::warning[`metrics` preview feature is deprecated] - -The `metrics` preview feature has been **deprecated** as of [Prisma ORM v6.14.0](https://github.com/prisma/prisma/releases/tag/6.14.0) and will be removed in Prisma ORM v7. - -**The `metrics` preview feature is only available in Prisma ORM versions ≤6.13.x.** If you are using Prisma ORM v6.14.0 or later, the `$metrics` API is no longer available. - -The feature is not supported when using Prisma ORM with the [query compiler architecture](/orm/prisma-client/setup-and-configuration/no-rust-engine) (setting `engineType` to 'client' in the `generator` block of your `schema.prisma` file). - -Metrics were originally introduced to provide insights into query and connection behavior. With the changes in the new [query compiler architecture](/orm/prisma-client/setup-and-configuration/no-rust-engine), these values no longer reflect the system reliably. Because of this, we are not continuing support for this feature. +The `metrics` preview feature has been **removed** as of [Prisma ORM v7.0.0](https://github.com/prisma/prisma/releases/tag/7.0.0). If you need visibility into query or connection pool behavior, we recommend using the *native metrics provided by your database driver* (for example, pool statistics) or setting up *OpenTelemetry* for a more complete observability solution. @@ -50,25 +39,15 @@ Prisma Client provides the following metrics: - `prisma_client_queries_active`: The number of currently active Prisma Client queries. - `prisma_client_queries_wait`: The number of Prisma Client queries currently waiting for a connection because all connections are in use. - `prisma_pool_connections_busy`: The number of currently busy pool connections. These pool connections are currently executing a datasource query. - - `prisma_pool_connections_idle`: The number of pool connections that are not currently being used. These pool connections are waiting for the next datasource query to run. - - `prisma_pool_connections_open`: The number of [pool connections](/orm/prisma-client/setup-and-configuration/databases-connections/connection-pool#default-connection-pool-size) open. + /* Lines 53-55 omitted */ - Histograms (metrics data divided into a collection of values; we call each container in the collection a "bucket"): - - - `prisma_client_queries_wait_histogram_ms`: The time waiting for a pool connection for all Prisma Client queries in ms. - - `prisma_client_queries_duration_histogram_ms`: The execution time for all executed Prisma Client queries in ms. This includes the time taken to execute all database queries, and to carry out all database engine activities, such as joining data and transforming data to the correct format. - - `prisma_datasource_queries_duration_histogram_ms`: The execution time for all executed Datasource queries in ms. +/* Lines 57-61 omitted */ You can [add global labels to your metrics data](#global-labels) to help you group and separate your metrics, for example by infrastructure region or server. ## Prerequisites -:::warning[Version compatibility] - -The `metrics` preview feature is **only available in Prisma ORM versions ≤6.13.x**. It has been removed in v6.14.0 and later versions. - -::: - To use Prisma Client metrics, you must do the following: 1. [Install compatible Prisma ORM dependencies](#1-install-up-to-date-prisma-orm-dependencies). @@ -118,41 +97,7 @@ console.log(metrics) This returns metrics as follows: ```json -{ - "counters": [ - { - "key": "prisma_client_queries_total", - "labels": {}, - "value": 0, - "description": "Total number of Prisma Client queries executed" - }, - { - "key": "prisma_datasource_queries_total", - "labels": {}, - "value": 0, - "description": "Total number of Datasource Queries executed" - }, - { - "key": "prisma_pool_connections_closed_total", - "labels": {}, - "value": 0, - "description": "Total number of Pool Connections closed" - }, - { - "key": "prisma_pool_connections_opened_total", - "labels": {}, - "value": 1, - "description": "Total number of Pool Connections opened" - } - ... - ], - "gauges": [ - ... - ], - "histograms": [ - ... - ] -} +{/* Lines 121-154 omitted */} ```
@@ -160,125 +105,7 @@ This returns metrics as follows: Expand to view the full output ```json no-copy -{ - "counters": [ - { - "key": "prisma_client_queries_total", - "labels": {}, - "value": 2, - "description": "Total number of Prisma Client queries executed" - }, - { - "key": "prisma_datasource_queries_total", - "labels": {}, - "value": 5, - "description": "Total number of Datasource Queries executed" - }, - { - "key": "prisma_pool_connections_open", - "labels": {}, - "value": 1, - "description": "Number of currently open Pool Connections" - } - ], - "gauges": [ - { - "key": "prisma_client_queries_active", - "labels": {}, - "value": 0, - "description": "Number of currently active Prisma Client queries" - }, - { - "key": "prisma_client_queries_wait", - "labels": {}, - "value": 0, - "description": "Number of Prisma Client queries currently waiting for a connection" - }, - { - "key": "prisma_pool_connections_busy", - "labels": {}, - "value": 0, - "description": "Number of currently busy Pool Connections (executing a datasource query)" - }, - { - "key": "prisma_pool_connections_idle", - "labels": {}, - "value": 21, - "description": "Number of currently unused Pool Connections (waiting for the next datasource query to run)" - }, - { - "key": "prisma_pool_connections_open", - "labels": {}, - "value": 1, - "description": "Number of currently open Pool Connections" - } - ], - "histograms": [ - { - "key": "prisma_client_queries_duration_histogram_ms", - "labels": {}, - "value": { - "buckets": [ - [0, 0], - [1, 0], - [5, 0], - [10, 1], - [50, 1], - [100, 0], - [500, 0], - [1000, 0], - [5000, 0], - [50000, 0] - ], - "sum": 47.430541000000005, - "count": 2 - }, - "description": "Histogram of the duration of all executed Prisma Client queries in ms" - }, - { - "key": "prisma_client_queries_wait_histogram_ms", - "labels": {}, - "value": { - "buckets": [ - [0, 0], - [1, 3], - [5, 0], - [10, 0], - [50, 0], - [100, 0], - [500, 0], - [1000, 0], - [5000, 0], - [50000, 0] - ], - "sum": 0.0015830000000000002, - "count": 3 - }, - "description": "Histogram of the wait time of all Prisma Client Queries in ms" - }, - { - "key": "prisma_datasource_queries_duration_histogram_ms", - "labels": {}, - "value": { - "buckets": [ - [0, 0], - [1, 0], - [5, 2], - [10, 2], - [50, 1], - [100, 0], - [500, 0], - [1000, 0], - [5000, 0], - [50000, 0] - ], - "sum": 47.134498, - "count": 5 - }, - "description": "Histogram of the duration of all executed Datasource Queries in ms" - } - ] -} +{/* Lines 163-280 omitted */} ```
@@ -313,61 +140,12 @@ let statsd = new StatsD({ port: 8125, }) -const diffMetrics = (metrics: Metric[]) => { - return metrics.map((metric) => { - let prev = 0; - - const diffBuckets = metric.value.buckets.map( - (values) => { - const [bucket, value] = values - const diff = value - prev - prev = value - return [bucket, diff] - } - ) - - metric.value.buckets = diffBuckets - return metric - }) -} +const diffMetrics = (metrics: Metric[]) => {/* Lines 316-331 omitted */} let previousHistograms: Metric[] = [] -const statsdSender = async () => { - const metrics = await prisma.$metrics.json() - - metrics.counters.forEach((counter: any) => { - statsd.gauge('prisma.' + counter.key, counter.value, (...res) => {}) - }); - - metrics.gauges.forEach((counter: any) => { - statsd.gauge('prisma.' + counter.key, counter.value, (...res) => {}) - }) - - if (!previousHistograms.length) { - previousHistograms = diffMetrics(metrics.histograms) - - return - } - - const diffHistograms = diffMetrics(metrics.histograms); - - diffHistograms.forEach((diffHistogram, histogramIndex) => { - diffHistogram.value.buckets.forEach((values, bucketIndex) => { - const [bucket, count] = values - const [_, prev] = - previousHistograms[histogramIndex].value.buckets[bucketIndex] - const change = count - prev - - for (let sendTimes = 0; sendTimes < change; sendTimes++) { - statsd.timing('prisma.' + diffHistograms.key, bucket) - } - }) - }) - - previousHistograms = diffHistograms -} +const statsdSender = async () => {/* Lines 337-369 omitted */} setInterval(async () => await statsdSender(), 10000) ``` @@ -500,8 +278,7 @@ prisma_datasource_queries_duration_histogram_ms_count 5 Metrics of type `histogram` expose three different class of values in the Prometheus format: 1. Multiple cumulative counters for observation buckets. These counters are suffixed with `_bucket{le=""}`. For example, `prisma_datasource_queries_duration_histogram_ms` has a counter exposed as `prisma_datasource_queries_duration_histogram_ms_bucket{le="1"}` - - When an observed value is less than or equal to the upper inclusive bound of a bucket, then Prisma Client metrics increments that bucket by 1. Suppose that you have buckets with the upper inclusive bounds 0, 1, 5, 10, and 50 respectively. If the observed value is 5 then Prisma Client metrics increments the third bucket onwards, because the value is greater than 0 and greater than 1, but less than or equal to 5, 10, and 50. +/* Lines 502-504 omitted */ 2. A single **total sum** for all observed values. This counter is suffixed with `_sum`. For example the total sum of `prisma_datasource_queries_duration_histogram_ms` is exposed as `prisma_datasource_queries_duration_histogram_ms_sum`. 3. The **count** of the number of events that have been observed. This counter is suffixed with `_count`. For example the total count of `prisma_datasource_queries_duration_histogram_ms` events is exposed as `prisma_datasource_queries_duration_histogram_ms_count`. @@ -521,7 +298,7 @@ const port = 4000 const prisma = new PrismaClient() app.get('/metrics', async (_req, res: Response) => { - const metrics = await prisma.$metrics.prometheus() + /* Lines 523-524 omitted */ res.end(metrics) }) @@ -545,8 +322,7 @@ const register = new prom.Registry() prom.collectDefaultMetrics({ register }) app.get('/metrics', async (_req, res: Response) => { - const prismaMetrics = await prisma.$metrics.prometheus() - const appMetrics = await register.metrics() + /* Lines 547-549 omitted */ res.end(prismaMetrics + appMetrics) }) @@ -573,29 +349,6 @@ console.log(metrics) This returns information in the following format: ```json highlight=5,11;add -{ - "counters": [ - { - "key": "query_total_operations", - //add-next-line - "labels": { "server": "us_server1", "app_version": "one" }, - "value": 0, - "description": "The total number of operations executed" - }, - { - "key": "prisma_datasource_queries_total", - //add-next-line - "labels": { "server": "us_server1", "app_version": "one" }, - "value": 0, - "description": "The total number of queries executed" - }, - ... - ], - "gauges": [ - ... - ], - "histograms": [ - ... - ] -} +{/* Lines 576-599 omitted */} ``` + diff --git a/content/200-orm/200-prisma-client/600-observability-and-logging/250-opentelemetry-tracing.mdx b/content/200-orm/200-prisma-client/600-observability-and-logging/250-opentelemetry-tracing.mdx index c3803e14ad..de98fb2b0d 100644 --- a/content/200-orm/200-prisma-client/600-observability-and-logging/250-opentelemetry-tracing.mdx +++ b/content/200-orm/200-prisma-client/600-observability-and-logging/250-opentelemetry-tracing.mdx @@ -9,7 +9,7 @@ Tracing provides a detailed log of the activity that Prisma Client carries out, :::info -Tracing gives you a highly detailed, operation-level insight into your Prisma ORM project. If you want aggregated numerical reporting, such as query counts, connection counts, and total query execution times, see [Metrics](/orm/prisma-client/observability-and-logging/metrics). +Tracing gives you a highly detailed, operation-level insight into your Prisma ORM project. ::: @@ -472,5 +472,4 @@ registerTracing({ import { PrismaClient } from '../prisma/generated/client' import async from 'express-async-handler' import express from 'express' -``` - +``` \ No newline at end of file diff --git a/content/200-orm/500-reference/050-prisma-client-reference.mdx b/content/200-orm/500-reference/050-prisma-client-reference.mdx index 8ea2c2473f..e132f8d3df 100644 --- a/content/200-orm/500-reference/050-prisma-client-reference.mdx +++ b/content/200-orm/500-reference/050-prisma-client-reference.mdx @@ -5545,14 +5545,6 @@ See: [Using Raw SQL (`$runCommandRaw()`)](/orm/prisma-client/using-raw-sql/raw-q See: [Transactions](/orm/prisma-client/queries/transactions). -### `$metrics` - -Prisma Client metrics give you a detailed insight into how Prisma Client interacts with your database. You can use this insight to help diagnose performance issues with your application. Learn more: [Metrics](/orm/prisma-client/observability-and-logging/metrics). - -Prisma Client metrics has the following methods: - -- `$metrics.json()`: [Retrieves Prisma Client metrics in JSON format](/orm/prisma-client/observability-and-logging/metrics#retrieve-metrics-in-json-format). -- `$metrics.prometheus()`: [Retrieves Prisma Client metrics in Prometheus format](/orm/prisma-client/observability-and-logging/metrics#retrieve-metrics-in-prometheus-format). ### `$extends` diff --git a/content/200-orm/800-more/400-comparisons/04-prisma-and-drizzle.mdx b/content/200-orm/800-more/400-comparisons/04-prisma-and-drizzle.mdx index b01adb8ab7..3c2a085b36 100644 --- a/content/200-orm/800-more/400-comparisons/04-prisma-and-drizzle.mdx +++ b/content/200-orm/800-more/400-comparisons/04-prisma-and-drizzle.mdx @@ -408,7 +408,6 @@ const posts = await db Both Drizzle and Prisma ORM have the ability to log queries and the underlying SQL generated. -Prisma ORM has additional features built into the client that help teams get a better understanding of their data usage. [Metrics](/orm/prisma-client/observability-and-logging/metrics) and [tracing](/orm/prisma-client/observability-and-logging/opentelemetry-tracing) are two features that can be enabled at any time and give you per query information. This information can be integrated with external tools so that you can track performance over time. ## Additional products diff --git a/content/250-postgres/1200-more/1000-faq.mdx b/content/250-postgres/1200-more/1000-faq.mdx index 262b477d00..a56d48c2c3 100644 --- a/content/250-postgres/1200-more/1000-faq.mdx +++ b/content/250-postgres/1200-more/1000-faq.mdx @@ -94,9 +94,7 @@ Yes, a query like `SELECT 1` counts as an operation and will be billed according ### How can I estimate the number of operations in Prisma ORM? -You can estimate your operation usage in Prisma ORM by integrating an application performance monitoring tool like Prometheus with Prisma ORM's [`metrics` preview feature](/orm/prisma-client/observability-and-logging/metrics). Once you enable the `metrics` preview feature, look at the `prisma_client_queries_total` metric for the number of operations. - -Prisma Postgres uses the `prisma_client_queries_total` counter, which tracks every client operation sent to your database to calculate your billing. For a detailed, step-by-step walkthrough on configuring Prometheus and monitor your application, [see our full guide](https://www.prisma.io/blog/metrics-tutorial-prisma-pmoldgq10kz). +You can estimate your operation usage in Prisma ORM by integrating an application performance monitoring tool like Prometheus. ### What strategies can I use to optimize cost per operation?