From 1ee6f0a75a81c2b31475fbc0d860e51d443d535e Mon Sep 17 00:00:00 2001 From: Alex Holovach Date: Thu, 2 Oct 2025 16:13:00 -0500 Subject: [PATCH] update readme --- .changeset/unlucky-days-breathe.md | 5 +++++ packages/otel-drizzle/README.md | 18 +++++++++--------- 2 files changed, 14 insertions(+), 9 deletions(-) create mode 100644 .changeset/unlucky-days-breathe.md diff --git a/.changeset/unlucky-days-breathe.md b/.changeset/unlucky-days-breathe.md new file mode 100644 index 0000000..7c1647b --- /dev/null +++ b/.changeset/unlucky-days-breathe.md @@ -0,0 +1,5 @@ +--- +"@kubiks/otel-drizzle": patch +--- + +update README diff --git a/packages/otel-drizzle/README.md b/packages/otel-drizzle/README.md index 119577e..fefb6db 100644 --- a/packages/otel-drizzle/README.md +++ b/packages/otel-drizzle/README.md @@ -2,9 +2,9 @@ OpenTelemetry instrumentation for [Drizzle ORM](https://orm.drizzle.team/). Add distributed tracing to your database queries with a single line of code. -![Drizzle ORM Trace Visualization](../../images/otel-drizzle-trace.png) +![Drizzle ORM Trace Visualization](https://github.com/kubiks-inc/otel/blob/main/images/otel-drizzle-trace.png) -*Visualize your database queries with detailed span information including operation type, SQL statements, and performance metrics.* +_Visualize your database queries with detailed span information including operation type, SQL statements, and performance metrics._ ## Installation @@ -87,13 +87,13 @@ Each database query automatically creates a span with rich telemetry data: The instrumentation adds the following attributes to each span following [OpenTelemetry semantic conventions](https://opentelemetry.io/docs/specs/semconv/database/): -| Attribute | Description | Example | -|-----------|-------------|---------| -| `db.operation` | SQL operation type | `SELECT` | -| `db.statement` | Full SQL query | `select "id", "name" from "users"...` | -| `db.system` | Database system | `postgresql` | -| `db.name` | Database name | `myapp` | -| `operation.name` | Client operation name | `kubiks_otel-drizzle.client` | +| Attribute | Description | Example | +| ---------------- | --------------------- | ------------------------------------- | +| `db.operation` | SQL operation type | `SELECT` | +| `db.statement` | Full SQL query | `select "id", "name" from "users"...` | +| `db.system` | Database system | `postgresql` | +| `db.name` | Database name | `myapp` | +| `operation.name` | Client operation name | `kubiks_otel-drizzle.client` | ## License