feat(node-experimental): Add @sentry/node-experimental package as MVP for POTEL
#8609
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| module.exports = { | ||
| env: { | ||
| node: true, | ||
| }, | ||
| extends: ['../../.eslintrc.js'], | ||
| rules: { | ||
| '@sentry-internal/sdk/no-optional-chaining': 'off', | ||
| }, | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| Copyright (c) 2023 Sentry (https://sentry.io) and individual contributors. All rights reserved. | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated | ||
| documentation files (the "Software"), to deal in the Software without restriction, including without limitation the | ||
| rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit | ||
| persons to whom the Software is furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all copies or substantial portions of the | ||
| Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE | ||
| WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR | ||
| COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR | ||
| OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| <p align="center"> | ||
| <a href="https://sentry.io/?utm_source=github&utm_medium=logo" target="_blank"> | ||
| <img src="https://sentry-brand.storage.googleapis.com/sentry-wordmark-dark-280x84.png" alt="Sentry" width="280" height="84"> | ||
| </a> | ||
| </p> | ||
|
|
||
| # Official Sentry SDK for Node (EXPERIMENTAL) | ||
|
|
||
| [](https://www.npmjs.com/package/@sentry/node-experimental) | ||
| [](https://www.npmjs.com/package/@sentry/node-experimental) | ||
| [](https://www.npmjs.com/package/@sentry/node-experimental) | ||
|
|
||
| This is a WIP, proof of concept implementation of a Node SDK that uses OpenTelemetry for performance instrumentation under the hood. | ||
|
|
||
| THIS MAY/WILL BREAK IN MANY UNEXPECTED WAYS. We may remove, add, change any of the integrations, add/remove any exports, etc. | ||
| This package is **NOT READY TO USE IN ANY FORM OF PRODUCTION ENVIRONMENT**! | ||
|
|
||
| This SDK is **considered experimental and in an alpha state**. It may experience breaking changes, and may be discontinued at any time. Please reach out on | ||
| [GitHub](https://github.com/getsentry/sentry-javascript/issues/new/choose) if you have any feedback/concerns. | ||
|
|
||
| ## Installation | ||
|
|
||
| ```bash | ||
| npm install @sentry/node-experimental | ||
|
|
||
| # Or yarn | ||
| yarn add @sentry/node-experimental | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| ```js | ||
| // ES5 Syntax | ||
| const Sentry = require('@sentry/node-experimental'); | ||
| // ES6 Syntax | ||
| import * as Sentry from '@sentry/node-experimental'; | ||
|
|
||
| Sentry.init({ | ||
| dsn: '__DSN__', | ||
| // ... | ||
| }); | ||
| ``` | ||
|
|
||
| Note that it is necessary to initialize Sentry **before you import any package that may be instrumented by us**. | ||
|
|
||
| ## Available (Performance) Integrations | ||
|
|
||
| * Http | ||
| * Express | ||
| * Fastify | ||
| * Nest | ||
| * Mysql | ||
| * Mysql2 | ||
| * GraphQL | ||
| * Mongo | ||
| * Mongoose | ||
| * Postgres | ||
| * Prisma | ||
|
|
||
| All of these are auto-discovered, you don't need to configure anything for performance. | ||
| You still need to register middlewares etc. for error capturing. | ||
| Other, non-performance integrations from `@sentry/node` are also available (except for Undici). | ||
|
|
||
| ## Links | ||
|
|
||
| - [Official SDK Docs](https://docs.sentry.io/quickstart/) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| module.exports = require('../../jest/jest.config.js'); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| { | ||
| "name": "@sentry/node-experimental", | ||
| "version": "7.60.0", | ||
| "description": "Experimental version of a Node SDK using OpenTelemetry for performance instrumentation", | ||
| "repository": "git://github.com/getsentry/sentry-javascript.git", | ||
| "homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/node-experimental", | ||
| "author": "Sentry", | ||
| "license": "MIT", | ||
| "engines": { | ||
| "node": ">=14" | ||
| }, | ||
| "main": "build/cjs/index.js", | ||
| "module": "build/esm/index.js", | ||
| "types": "build/types/index.d.ts", | ||
| "typesVersions": { | ||
| "<4.9": { | ||
| "build/types/index.d.ts": [ | ||
| "build/types-ts3.8/index.d.ts" | ||
| ] | ||
| } | ||
| }, | ||
| "publishConfig": { | ||
| "access": "public" | ||
| }, | ||
| "dependencies": { | ||
| "@opentelemetry/api": "~1.4.1", | ||
| "@opentelemetry/instrumentation": "~0.41.0", | ||
| "@opentelemetry/instrumentation-fastify": "~0.32.0", | ||
| "@opentelemetry/instrumentation-http": "~0.41.0", | ||
| "@opentelemetry/instrumentation-express": "~0.33.0", | ||
| "@opentelemetry/instrumentation-graphql": "~0.35.0", | ||
| "@opentelemetry/instrumentation-mongodb": "~0.36.0", | ||
| "@opentelemetry/instrumentation-mongoose": "~0.33.0", | ||
| "@opentelemetry/instrumentation-mysql": "~0.34.0", | ||
| "@opentelemetry/instrumentation-mysql2": "~0.34.0", | ||
| "@opentelemetry/instrumentation-pg": "~0.36.0", | ||
| "@opentelemetry/instrumentation-nestjs-core": "~0.33.0", | ||
| "@opentelemetry/semantic-conventions": "~1.15.0", | ||
| "@opentelemetry/sdk-trace-node": "~1.15.0", | ||
| "@prisma/instrumentation": "~5.0.0", | ||
| "@sentry/core": "7.60.0", | ||
| "@sentry/node": "7.60.0", | ||
| "@sentry/opentelemetry-node": "7.60.0", | ||
| "@sentry/types": "7.60.0", | ||
| "@sentry/utils": "7.60.0" | ||
| }, | ||
| "scripts": { | ||
| "build": "run-p build:transpile build:types", | ||
| "build:dev": "yarn build", | ||
| "build:transpile": "rollup -c rollup.npm.config.js", | ||
| "build:types": "run-s build:types:core build:types:downlevel", | ||
| "build:types:core": "tsc -p tsconfig.types.json", | ||
| "build:types:downlevel": "yarn downlevel-dts build/types build/types-ts3.8 --to ts3.8", | ||
| "build:watch": "run-p build:transpile:watch build:types:watch", | ||
| "build:dev:watch": "yarn build:watch", | ||
| "build:transpile:watch": "rollup -c rollup.npm.config.js --watch", | ||
| "build:types:watch": "tsc -p tsconfig.types.json --watch", | ||
| "build:tarball": "ts-node ../../scripts/prepack.ts && npm pack ./build", | ||
| "circularDepCheck": "madge --circular src/index.ts", | ||
| "clean": "rimraf build coverage sentry-node-experimental-*.tgz", | ||
| "fix": "run-s fix:eslint fix:prettier", | ||
| "fix:eslint": "eslint . --format stylish --fix", | ||
| "fix:prettier": "prettier --write \"{src,test,scripts}/**/**.ts\"", | ||
| "lint": "run-s lint:prettier lint:eslint", | ||
| "lint:eslint": "eslint . --format stylish", | ||
| "lint:prettier": "prettier --check \"{src,test,scripts}/**/**.ts\"", | ||
| "test": "yarn test:jest", | ||
| "test:jest": "jest", | ||
| "test:watch": "jest --watch", | ||
| "yalc:publish": "ts-node ../../scripts/prepack.ts && yalc publish build --push" | ||
| }, | ||
| "volta": { | ||
| "extends": "../../package.json" | ||
| }, | ||
| "sideEffects": false | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| import { makeBaseNPMConfig, makeNPMConfigVariants } from '../../rollup/index.js'; | ||
|
|
||
| export default makeNPMConfigVariants(makeBaseNPMConfig()); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| import { Integrations as CoreIntegrations } from '@sentry/core'; | ||
|
|
||
| import * as NodeExperimentalIntegrations from './integrations'; | ||
|
|
||
| const INTEGRATIONS = { | ||
| ...CoreIntegrations, | ||
| ...NodeExperimentalIntegrations, | ||
| }; | ||
|
|
||
| export { init } from './sdk/init'; | ||
| export { INTEGRATIONS as Integrations }; | ||
| export { getAutoPerformanceIntegrations } from './integrations/getAutoPerformanceIntegrations'; | ||
| export * as Handlers from './sdk/handlers'; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Prettier changed this for me 😅 Hope that's OK...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ahh yes, when I worked on this, my prettier/vscode settings were broken and apparently our lint check didn't catch it. Should be fine.