@lokalise/fastify-extras 4.2.0 → 4.3.0

package/dist/index.d.ts

@@ -6,3 +6,5 @@ export { newrelicTransactionManagerPlugin, NewRelicTransactionManager, } from '.
 export type { NewRelicTransactionManagerOptions } from './plugins/newrelicTransactionManagerPlugin';
 export { metricsPlugin } from './plugins/metricsPlugin';
 export type { ErrorObjectResolver, MetricsPluginOptions } from './plugins/metricsPlugin';
+export { prismaOpenTracingPlugin } from './plugins/opentelemetry/opentelemetry/prismaOpenTracingPlugin';
+export type { PrismaOpenTracingPluginConfig } from './plugins/opentelemetry/opentelemetry/prismaOpenTracingPlugin';

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.metricsPlugin = exports.NewRelicTransactionManager = exports.newrelicTransactionManagerPlugin = exports.REQUEST_ID_STORE_KEY = exports.getRequestIdFastifyAppConfig = exports.requestContextProviderPlugin = exports.reportErrorToBugsnag = exports.bugsnagPlugin = void 0;
+exports.prismaOpenTracingPlugin = exports.metricsPlugin = exports.NewRelicTransactionManager = exports.newrelicTransactionManagerPlugin = exports.REQUEST_ID_STORE_KEY = exports.getRequestIdFastifyAppConfig = exports.requestContextProviderPlugin = exports.reportErrorToBugsnag = exports.bugsnagPlugin = void 0;
 var bugsnagPlugin_1 = require("./plugins/bugsnagPlugin");
 Object.defineProperty(exports, "bugsnagPlugin", { enumerable: true, get: function () { return bugsnagPlugin_1.bugsnagPlugin; } });
 Object.defineProperty(exports, "reportErrorToBugsnag", { enumerable: true, get: function () { return bugsnagPlugin_1.reportErrorToBugsnag; } });
@@ -13,4 +13,6 @@ Object.defineProperty(exports, "newrelicTransactionManagerPlugin", { enumerable:
 Object.defineProperty(exports, "NewRelicTransactionManager", { enumerable: true, get: function () { return newrelicTransactionManagerPlugin_1.NewRelicTransactionManager; } });
 var metricsPlugin_1 = require("./plugins/metricsPlugin");
 Object.defineProperty(exports, "metricsPlugin", { enumerable: true, get: function () { return metricsPlugin_1.metricsPlugin; } });
+var prismaOpenTracingPlugin_1 = require("./plugins/opentelemetry/opentelemetry/prismaOpenTracingPlugin");
+Object.defineProperty(exports, "prismaOpenTracingPlugin", { enumerable: true, get: function () { return prismaOpenTracingPlugin_1.prismaOpenTracingPlugin; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":";;;AAAA,yDAA6E;AAApE,8GAAA,aAAa,OAAA;AAAE,qHAAA,oBAAoB,OAAA;AAG5C,uFAI+C;AAH7C,4IAAA,4BAA4B,OAAA;AAC5B,4IAAA,4BAA4B,OAAA;AAC5B,oIAAA,oBAAoB,OAAA;AAItB,+FAGmD;AAFjD,oJAAA,gCAAgC,OAAA;AAChC,8IAAA,0BAA0B,OAAA;AAI5B,yDAAuD;AAA9C,8GAAA,aAAa,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":";;;AAAA,yDAA6E;AAApE,8GAAA,aAAa,OAAA;AAAE,qHAAA,oBAAoB,OAAA;AAG5C,uFAI+C;AAH7C,4IAAA,4BAA4B,OAAA;AAC5B,4IAAA,4BAA4B,OAAA;AAC5B,oIAAA,oBAAoB,OAAA;AAItB,+FAGmD;AAFjD,oJAAA,gCAAgC,OAAA;AAChC,8IAAA,0BAA0B,OAAA;AAI5B,yDAAuD;AAA9C,8GAAA,aAAa,OAAA;AAGtB,yGAAuG;AAA9F,kIAAA,uBAAuB,OAAA"}

package/dist/plugins/opentelemetry/opentelemetry/prismaOpenTracingPlugin.d.ts

@@ -0,0 +1,7 @@
+export interface PrismaOpenTracingPluginConfig {
+    isEnabled: boolean;
+    useBatchSpans: boolean;
+    samplingRatio: number;
+    serviceName: string;
+}
+export declare const prismaOpenTracingPlugin: import("fastify").FastifyPluginCallback<PrismaOpenTracingPluginConfig, import("fastify").RawServerDefault, import("fastify").FastifyTypeProviderDefault, import("fastify").FastifyBaseLogger>;

package/dist/plugins/opentelemetry/opentelemetry/prismaOpenTracingPlugin.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.prismaOpenTracingPlugin = void 0;
+const tslib_1 = require("tslib");
+const exporter_trace_otlp_grpc_1 = require("@opentelemetry/exporter-trace-otlp-grpc");
+const instrumentation_1 = require("@opentelemetry/instrumentation");
+const resources_1 = require("@opentelemetry/resources");
+const sdk_trace_base_1 = require("@opentelemetry/sdk-trace-base");
+const sdk_trace_node_1 = require("@opentelemetry/sdk-trace-node");
+const semantic_conventions_1 = require("@opentelemetry/semantic-conventions");
+const instrumentation_2 = require("@prisma/instrumentation");
+const fastify_plugin_1 = tslib_1.__importDefault(require("fastify-plugin"));
+const spanProcessors_1 = require("./spanProcessors");
+function plugin(app, opts, done) {
+    if (opts.isEnabled) {
+        const provider = new sdk_trace_node_1.NodeTracerProvider({
+            sampler: new sdk_trace_base_1.TraceIdRatioBasedSampler(opts.samplingRatio),
+            resource: new resources_1.Resource({
+                [semantic_conventions_1.SemanticResourceAttributes.SERVICE_NAME]: opts.serviceName,
+            }),
+        });
+        // Is configured by OTEL_EXPORTER_OTLP_* env vars
+        const otlpExporter = new exporter_trace_otlp_grpc_1.OTLPTraceExporter();
+        // Production sends spans in batches
+        if (opts.useBatchSpans) {
+            provider.addSpanProcessor(new spanProcessors_1.LokaliseBatchSpanProcessor(otlpExporter));
+        }
+        else {
+            provider.addSpanProcessor(new spanProcessors_1.LokaliseSimpleSpanProcessor(otlpExporter));
+        }
+        (0, instrumentation_1.registerInstrumentations)({
+            instrumentations: [new instrumentation_2.PrismaInstrumentation()],
+            tracerProvider: provider,
+        });
+        provider.register();
+    }
+    done();
+}
+exports.prismaOpenTracingPlugin = (0, fastify_plugin_1.default)(plugin, {
+    fastify: '4.x',
+    name: 'prisma-otel-tracing-plugin',
+});
+//# sourceMappingURL=prismaOpenTracingPlugin.js.map

package/dist/plugins/opentelemetry/opentelemetry/prismaOpenTracingPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prismaOpenTracingPlugin.js","sourceRoot":"","sources":["../../../../lib/plugins/opentelemetry/opentelemetry/prismaOpenTracingPlugin.ts"],"names":[],"mappings":";;;;AAAA,sFAA2E;AAC3E,oEAAyE;AACzE,wDAAmD;AACnD,kEAAwE;AACxE,kEAAkE;AAClE,8EAAgF;AAChF,6DAA+D;AAE/D,4EAA+B;AAE/B,qDAA0F;AAS1F,SAAS,MAAM,CAAC,GAAoB,EAAE,IAAmC,EAAE,IAAgB;IACzF,IAAI,IAAI,CAAC,SAAS,EAAE;QAClB,MAAM,QAAQ,GAAG,IAAI,mCAAkB,CAAC;YACtC,OAAO,EAAE,IAAI,yCAAwB,CAAC,IAAI,CAAC,aAAa,CAAC;YACzD,QAAQ,EAAE,IAAI,oBAAQ,CAAC;gBACrB,CAAC,iDAA0B,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,WAAW;aAC5D,CAAC;SACH,CAAC,CAAA;QAEF,iDAAiD;QACjD,MAAM,YAAY,GAAG,IAAI,4CAAiB,EAAE,CAAA;QAE5C,oCAAoC;QACpC,IAAI,IAAI,CAAC,aAAa,EAAE;YACtB,QAAQ,CAAC,gBAAgB,CAAC,IAAI,2CAA0B,CAAC,YAAY,CAAC,CAAC,CAAA;SACxE;aAAM;YACL,QAAQ,CAAC,gBAAgB,CAAC,IAAI,4CAA2B,CAAC,YAAY,CAAC,CAAC,CAAA;SACzE;QAED,IAAA,0CAAwB,EAAC;YACvB,gBAAgB,EAAE,CAAC,IAAI,uCAAqB,EAAE,CAAC;YAC/C,cAAc,EAAE,QAAQ;SACzB,CAAC,CAAA;QAEF,QAAQ,CAAC,QAAQ,EAAE,CAAA;KACpB;IAED,IAAI,EAAE,CAAA;AACR,CAAC;AAEY,QAAA,uBAAuB,GAAG,IAAA,wBAAE,EAAC,MAAM,EAAE;IAChD,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,4BAA4B;CACnC,CAAC,CAAA"}

package/dist/plugins/opentelemetry/opentelemetry/spanProcessors.d.ts

@@ -0,0 +1,16 @@
+import type { Span } from '@opentelemetry/sdk-trace-base';
+import { BatchSpanProcessor, SimpleSpanProcessor } from '@opentelemetry/sdk-trace-base';
+/**
+ * Extends span processor to be able to attach custom attributes request id to spans.
+ *
+ * This might be easier in the future once the opentelemetry instrumentation for prisma
+ * has matured a bit more.
+ *
+ * @see https://github.com/prisma/prisma/issues/14640#issuecomment-1209931862
+ */
+export declare class LokaliseSimpleSpanProcessor extends SimpleSpanProcessor {
+    onStart(span: Span): void;
+}
+export declare class LokaliseBatchSpanProcessor extends BatchSpanProcessor {
+    onStart(span: Span): void;
+}

package/dist/plugins/opentelemetry/opentelemetry/spanProcessors.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LokaliseBatchSpanProcessor = exports.LokaliseSimpleSpanProcessor = void 0;
+const request_context_1 = require("@fastify/request-context");
+const sdk_trace_base_1 = require("@opentelemetry/sdk-trace-base");
+const requestContextProviderPlugin_1 = require("../../requestContextProviderPlugin");
+/**
+ * Extends span processor to be able to attach custom attributes request id to spans.
+ *
+ * This might be easier in the future once the opentelemetry instrumentation for prisma
+ * has matured a bit more.
+ *
+ * @see https://github.com/prisma/prisma/issues/14640#issuecomment-1209931862
+ */
+class LokaliseSimpleSpanProcessor extends sdk_trace_base_1.SimpleSpanProcessor {
+    onStart(span) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        const requestId = request_context_1.requestContext.get(requestContextProviderPlugin_1.REQUEST_ID_STORE_KEY);
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+        span.setAttribute(requestContextProviderPlugin_1.REQUEST_ID_STORE_KEY, requestId);
+    }
+}
+exports.LokaliseSimpleSpanProcessor = LokaliseSimpleSpanProcessor;
+class LokaliseBatchSpanProcessor extends sdk_trace_base_1.BatchSpanProcessor {
+    onStart(span) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        const requestId = request_context_1.requestContext.get(requestContextProviderPlugin_1.REQUEST_ID_STORE_KEY);
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+        span.setAttribute(requestContextProviderPlugin_1.REQUEST_ID_STORE_KEY, requestId);
+    }
+}
+exports.LokaliseBatchSpanProcessor = LokaliseBatchSpanProcessor;
+//# sourceMappingURL=spanProcessors.js.map

package/dist/plugins/opentelemetry/opentelemetry/spanProcessors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spanProcessors.js","sourceRoot":"","sources":["../../../../lib/plugins/opentelemetry/opentelemetry/spanProcessors.ts"],"names":[],"mappings":";;;AAAA,8DAAyD;AAEzD,kEAAuF;AAEvF,qFAAyE;AAEzE;;;;;;;GAOG;AACH,MAAa,2BAA4B,SAAQ,oCAAmB;IAClE,OAAO,CAAC,IAAU;QAChB,mEAAmE;QACnE,MAAM,SAAS,GAAG,gCAAc,CAAC,GAAG,CAAC,mDAAoB,CAAC,CAAA;QAC1D,iEAAiE;QACjE,IAAI,CAAC,YAAY,CAAC,mDAAoB,EAAE,SAAS,CAAC,CAAA;IACpD,CAAC;CACF;AAPD,kEAOC;AAED,MAAa,0BAA2B,SAAQ,mCAAkB;IAChE,OAAO,CAAC,IAAU;QAChB,mEAAmE;QACnE,MAAM,SAAS,GAAG,gCAAc,CAAC,GAAG,CAAC,mDAAoB,CAAC,CAAA;QAC1D,iEAAiE;QACjE,IAAI,CAAC,YAAY,CAAC,mDAAoB,EAAE,SAAS,CAAC,CAAA;IACpD,CAAC;CACF;AAPD,gEAOC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lokalise/fastify-extras",
-  "version": "4.2.0",
+  "version": "4.3.0",
   "description": "Opinionated set of fastify plugins, commonly used in Lokalise",
   "author": {
     "name": "Lokalise",
@@ -47,6 +47,14 @@
   "peerDependencies": {
     "@bugsnag/js": "^7.18.0",
     "@fastify/request-context": "^4.2.0",
+    "@opentelemetry/api": "^1.3.0",
+    "@opentelemetry/exporter-trace-otlp-grpc": "^0.34.0",
+    "@opentelemetry/instrumentation": "^0.34.0",
+    "@opentelemetry/resources": "^1.8.0",
+    "@opentelemetry/sdk-trace-base": "^1.8.0",
+    "@opentelemetry/sdk-trace-node": "^1.8.0",
+    "@opentelemetry/semantic-conventions": "^1.8.0",
+    "@prisma/instrumentation": "^4.8.0",
     "fastify": "^4.10.2",
     "fastify-metrics": "^10.0.1",
     "newrelic": "^9.7.4",
@@ -56,6 +64,14 @@
     "@bugsnag/js": "^7.18.0",
     "@fastify/request-context": "^4.2.0",
     "@lokalise/node-core": "^2.0.1",
+    "@opentelemetry/api": "^1.3.0",
+    "@opentelemetry/exporter-trace-otlp-grpc": "^0.34.0",
+    "@opentelemetry/instrumentation": "^0.34.0",
+    "@opentelemetry/resources": "^1.8.0",
+    "@opentelemetry/sdk-trace-base": "^1.8.0",
+    "@opentelemetry/sdk-trace-node": "^1.8.0",
+    "@opentelemetry/semantic-conventions": "^1.8.0",
+    "@prisma/instrumentation": "^4.8.0",
     "@types/jest": "^29.2.5",
     "@types/newrelic": "^9.4.0",
     "@types/node": "^18.11.18",