Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(prisma): mark instrumentation-prisma-client as deprecated #46

Merged
merged 2 commits into from
Sep 19, 2023
Merged

docs(prisma): mark instrumentation-prisma-client as deprecated #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f621f3
docs(prisma): mark instrumentation-prisma-client as deprecated
justindsmith Sep 19, 2023
46421a6
fix yarn.lock
justindsmith Sep 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/instrumentation-prisma-client/.tav.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
'@prisma/client':
versions: ">=3.8.0"
versions: "3.8.0 - 3.x"
commands:
- yarn test
14 changes: 6 additions & 8 deletions packages/instrumentation-prisma-client/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,19 @@
## IMPORTANT NOTE: PRISMA NOW HAS [OFFICIAL SUPPORT FOR OPENTELEMETRY](https://www.prisma.io/docs/concepts/components/prisma-client/opentelemetry-tracing). THIS PACKAGE IS DEPRECATED.

# OpenTelemetry Prisma Client Instrumentation for Node.js
[![NPM version](https://img.shields.io/npm/v/opentelemetry-instrumentation-prisma-client.svg)](https://www.npmjs.com/package/opentelemetry-instrumentation-prisma-client)
[![Apache 2.0 License](https://img.shields.io/badge/license-Apache_2.0-green.svg)](https://github.com/justindsmith/opentelemetry-instrumentations-js/blob/master/LICENSE)

This module provides automatic instrumentation for [`@prisma/client`](https://github.com/prisma/prisma/tree/main/packages/client).

## NOTE

This is an unofficial plugin for the Prisma client. The Prisma team is working on official support for OpenTelemetry and progress can be tracked at https://github.com/prisma/client-planning/issues/21. Once the official support reaches the same level of capabilities of `opentelemetry-instrumentation-prisma-client`, the `opentelemetry-instrumentation-prisma-client` will be marked as deprecated.

## Installation

```
npm install --save opentelemetry-instrumentation-prisma-client
```

## Supported Versions
- `>=3.8.0`
- `3.8.0 - 3.x`

## Usage
For further automatic instrumentation instruction see the [@opentelemetry/instrumentation](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-instrumentation) package.
Expand All @@ -37,9 +35,9 @@ registerInstrumentations({

## Configuration

| Name | Type | Default Value | Description | |
|--------------------------|----------------------------------------------------|-----------------------------|----------------------------------------------------|--|
| spanAttributes | <code>Attributes</code> | `undefined` | An optional set of Opentelemetry Attributes to be added to the span. For example `spanAttributes: {[SemanticAttributes.DB_SYSTEM]: 'postgresql'}` | |
| Name | Type | Default Value | Description | |
|----------------|-------------------------|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------|--|
| spanAttributes | <code>Attributes</code> | `undefined` | An optional set of Opentelemetry Attributes to be added to the span. For example `spanAttributes: {[SemanticAttributes.DB_SYSTEM]: 'postgresql'}` | |

## License
Apache 2.0 - See [LICENSE](https://github.com/justindsmith/opentelemetry-instrumentation-js/blob/main/LICENSE) for more information.
Loading
Loading