@launchdarkly/node-server-sdk-otel 0.0.1

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2022 Catamorphic, Co.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,79 @@
+# LaunchDarkly Server-Side SDK for Node.js - OpenTelemetry integration
+
+[![NPM][node-otel-npm-badge]][node-otel-npm-link]
+[![Actions Status][node-otel-ci-badge]][node-otel-ci]
+[![Documentation](https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8)](https://launchdarkly.github.io/js-core/packages/telemetry/node-server-sdk-otel/docs/)
+
+# 🚫🚫🚫🚫🚫🚫
+
+> [!CAUTION]
+> This package is prerelease and experimental. It should not be used in production and is not supported.
+
+This package provides OpenTelemetry integrations for the LaunchDarkly Server-Side SDK for Node.js.
+
+## LaunchDarkly overview
+
+[LaunchDarkly](https://www.launchdarkly.com) is a feature management platform that serves over 100 billion feature flags daily to help teams build better software, faster. [Get started](https://docs.launchdarkly.com/home/getting-started) using LaunchDarkly today!
+
+[![Twitter Follow](https://img.shields.io/twitter/follow/launchdarkly.svg?style=social&label=Follow&maxAge=2592000)](https://twitter.com/intent/follow?screen_name=launchdarkly)
+
+## Supported Node versions
+
+This package is compatible with Node.js versions 14 and above.
+
+## Getting started
+
+Refer to [Using Redis as a persistent feature store](https://docs.launchdarkly.com/sdk/features/storing-data/otel#nodejs-server-side).
+
+## Quick setup
+
+This assumes that you have already installed the LaunchDarkly Node.js SDK.
+
+1. Install this package with `npm` or `yarn`:
+
+```shell
+npm install @launchdarkly/node-server-sdk-otel --save
+```
+
+2. If your application does not already have its own dependency on the `@opentelemetry/api` package, add `@opentelemetry/api` as well:
+
+```shell
+npm install @opentelemetry/api --save
+```
+
+3. Import the tracing hook:
+
+```typescript
+import { TracingHook } from '@launchdarkly/node-server-sdk-otel';
+```
+
+4. When configuring your SDK client, add the `TracingHook`
+
+```typescript
+import { init } from '@launchdarkly/node-server-sdk';
+
+const client = init('YOUR SDK KEY', {hooks: [new TracingHook()]});
+```
+
+## Contributing
+
+We encourage pull requests and other contributions from the community. Check out our [contributing guidelines](CONTRIBUTING.md) for instructions on how to contribute to this SDK.
+
+## About LaunchDarkly
+
+- LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can:
+  - Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases.
+  - Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?).
+  - Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file.
+  - Grant access to certain features based on user attributes, like payment plan (eg: users on the ‘gold’ plan get access to more features than users in the ‘silver’ plan). Disable parts of your application to facilitate maintenance, without taking everything offline.
+- LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Check out [our documentation](https://docs.launchdarkly.com/sdk) for a complete list.
+- Explore LaunchDarkly
+  - [launchdarkly.com](https://www.launchdarkly.com/ 'LaunchDarkly Main Website') for more information
+  - [docs.launchdarkly.com](https://docs.launchdarkly.com/ 'LaunchDarkly Documentation') for our documentation and SDK reference guides
+  - [apidocs.launchdarkly.com](https://apidocs.launchdarkly.com/ 'LaunchDarkly API Documentation') for our API documentation
+  - [blog.launchdarkly.com](https://blog.launchdarkly.com/ 'LaunchDarkly Blog Documentation') for the latest product updates
+
+[node-otel-ci-badge]: https://github.com/launchdarkly/js-core/actions/workflows/node-otel.yml/badge.svg
+[node-otel-ci]: https://github.com/launchdarkly/js-core/actions/workflows/node-otel.yml
+[node-otel-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/node-server-sdk-otel.svg?style=flat-square
+[node-otel-npm-link]: https://www.npmjs.com/package/@launchdarkly/node-server-sdk-otel

package/dist/TracingHook.d.ts

@@ -0,0 +1,22 @@
+import { integrations, LDEvaluationDetail } from '@launchdarkly/node-server-sdk';
+/**
+ * Options which allow configuring the tracing hook.
+ */
+export interface TracingHookOptions {
+    /**
+     * If set to true, then the tracing hook will add spans for each variation
+     * method call.
+     *
+     * The default value is false.
+     */
+    spans: boolean;
+}
+export default class TracingHook implements integrations.Hook {
+    private readonly options;
+    private readonly tracer;
+    constructor(options?: TracingHookOptions);
+    getMetadata(): integrations.HookMetadata;
+    beforeEvaluation?(hookContext: integrations.EvaluationHookContext, data: integrations.EvaluationHookData): integrations.EvaluationHookData;
+    afterEvaluation?(hookContext: integrations.EvaluationHookContext, data: integrations.EvaluationHookData, _detail: LDEvaluationDetail): integrations.EvaluationHookData;
+}
+//# sourceMappingURL=TracingHook.d.ts.map

package/dist/TracingHook.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TracingHook.d.ts","sourceRoot":"","sources":["../src/TracingHook.ts"],"names":[],"mappings":"AAGA,OAAO,EAAW,YAAY,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAO1F;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACH,KAAK,EAAE,OAAO,CAAC;CAChB;AAUD,MAAM,CAAC,OAAO,OAAO,WAAY,YAAW,YAAY,CAAC,IAAI;IAC3D,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAqB;IAC7C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA0C;gBAErD,OAAO,CAAC,EAAE,kBAAkB;IAIxC,WAAW,IAAI,YAAY,CAAC,YAAY;IAMxC,gBAAgB,CAAC,CACf,WAAW,EAAE,YAAY,CAAC,qBAAqB,EAC/C,IAAI,EAAE,YAAY,CAAC,kBAAkB,GACpC,YAAY,CAAC,kBAAkB;IAalC,eAAe,CAAC,CACd,WAAW,EAAE,YAAY,CAAC,qBAAqB,EAC/C,IAAI,EAAE,YAAY,CAAC,kBAAkB,EACrC,OAAO,EAAE,kBAAkB,GAC1B,YAAY,CAAC,kBAAkB;CAanC"}

package/dist/TracingHook.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// eslint-disable-next-line max-classes-per-file
+const api_1 = require("@opentelemetry/api");
+const node_server_sdk_1 = require("@launchdarkly/node-server-sdk");
+const FEATURE_FLAG_SCOPE = 'feature_flag';
+const FEATURE_FLAG_KEY_ATTR = `${FEATURE_FLAG_SCOPE}.key`;
+const FEATURE_FLAG_PROVIDER_ATTR = `${FEATURE_FLAG_SCOPE}.provider_name`;
+const FEATURE_FLAG_CONTEXT_KEY = `${FEATURE_FLAG_SCOPE}.context.key`;
+const defaultOptions = {
+    spans: false,
+};
+class TracingHook {
+    constructor(options) {
+        this.tracer = api_1.trace.getTracer('launchdarkly-client');
+        // TODO: Add option verification.
+        this.options = Object.assign(Object.assign({}, defaultOptions), (options !== null && options !== void 0 ? options : {}));
+    }
+    getMetadata() {
+        return {
+            name: 'LaunchDarkly Tracing Hook',
+        };
+    }
+    beforeEvaluation(hookContext, data) {
+        if (this.options.spans) {
+            const { canonicalKey } = node_server_sdk_1.Context.fromLDContext(hookContext.context);
+            const span = this.tracer.startSpan(hookContext.method, undefined, api_1.context.active());
+            span.setAttribute('feature_flag.context.key', canonicalKey);
+            span.setAttribute('feature_flag.key', hookContext.key);
+            return Object.assign(Object.assign({}, data), { span });
+        }
+        return data;
+    }
+    afterEvaluation(hookContext, data, _detail) {
+        var _a;
+        const currentTrace = api_1.trace.getActiveSpan();
+        if (currentTrace) {
+            currentTrace.addEvent(FEATURE_FLAG_SCOPE, {
+                [FEATURE_FLAG_KEY_ATTR]: hookContext.key,
+                [FEATURE_FLAG_PROVIDER_ATTR]: this.getMetadata().name,
+                [FEATURE_FLAG_CONTEXT_KEY]: node_server_sdk_1.Context.fromLDContext(hookContext.context).canonicalKey,
+            });
+        }
+        (_a = data.span) === null || _a === void 0 ? void 0 : _a.end();
+        return data;
+    }
+}
+exports.default = TracingHook;
+//# sourceMappingURL=TracingHook.js.map

package/dist/TracingHook.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TracingHook.js","sourceRoot":"","sources":["../src/TracingHook.ts"],"names":[],"mappings":";;AAAA,gDAAgD;AAChD,4CAA0D;AAE1D,mEAA0F;AAE1F,MAAM,kBAAkB,GAAG,cAAc,CAAC;AAC1C,MAAM,qBAAqB,GAAG,GAAG,kBAAkB,MAAM,CAAC;AAC1D,MAAM,0BAA0B,GAAG,GAAG,kBAAkB,gBAAgB,CAAC;AACzE,MAAM,wBAAwB,GAAG,GAAG,kBAAkB,cAAc,CAAC;AAmBrE,MAAM,cAAc,GAAuB;IACzC,KAAK,EAAE,KAAK;CACb,CAAC;AAEF,MAAqB,WAAW;IAI9B,YAAY,OAA4B;QAFvB,WAAM,GAAG,WAAK,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;QAG/D,iCAAiC;QACjC,IAAI,CAAC,OAAO,mCAAQ,cAAc,GAAK,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC,CAAE,CAAC;IAC3D,CAAC;IACD,WAAW;QACT,OAAO;YACL,IAAI,EAAE,2BAA2B;SAClC,CAAC;IACJ,CAAC;IAED,gBAAgB,CACd,WAA+C,EAC/C,IAAqC;QAErC,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE;YACtB,MAAM,EAAE,YAAY,EAAE,GAAG,yBAAO,CAAC,aAAa,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;YAEpE,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,EAAE,aAAO,CAAC,MAAM,EAAE,CAAC,CAAC;YACpF,IAAI,CAAC,YAAY,CAAC,0BAA0B,EAAE,YAAY,CAAC,CAAC;YAC5D,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC;YAEvD,uCAAY,IAAI,KAAE,IAAI,IAAG;SAC1B;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,eAAe,CACb,WAA+C,EAC/C,IAAqC,EACrC,OAA2B;;QAE3B,MAAM,YAAY,GAAG,WAAK,CAAC,aAAa,EAAE,CAAC;QAC3C,IAAI,YAAY,EAAE;YAChB,YAAY,CAAC,QAAQ,CAAC,kBAAkB,EAAE;gBACxC,CAAC,qBAAqB,CAAC,EAAE,WAAW,CAAC,GAAG;gBACxC,CAAC,0BAA0B,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI;gBACrD,CAAC,wBAAwB,CAAC,EAAE,yBAAO,CAAC,aAAa,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,YAAY;aACpF,CAAC,CAAC;SACJ;QAED,MAAC,IAAsB,CAAC,IAAI,0CAAE,GAAG,EAAE,CAAC;QACpC,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA/CD,8BA+CC"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { default as TracingHook } from './TracingHook';
+export { TracingHookOptions } from './TracingHook';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC"}

package/dist/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TracingHook = void 0;
+var TracingHook_1 = require("./TracingHook");
+Object.defineProperty(exports, "TracingHook", { enumerable: true, get: function () { return TracingHook_1.default; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,6CAAuD;AAA9C,0GAAA,OAAO,OAAe"}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@launchdarkly/node-server-sdk-otel",
+  "version": "0.0.1",
+  "type": "commonjs",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "homepage": "https://github.com/launchdarkly/js-core/tree/main/packages/telemetry/node-server-sdk-otel",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/launchdarkly/js-core.git"
+  },
+  "description": "OpenTelemetry integration for the LaunchDarkly Server-Side SDK for Node.js",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "launchdarkly",
+    "analytics",
+    "client"
+  ],
+  "scripts": {
+    "doc": "../../../scripts/build-doc.sh .",
+    "test": "npx jest --ci",
+    "build": "npx tsc",
+    "clean": "npx tsc --build --clean",
+    "lint": "npx eslint . --ext .ts",
+    "lint:fix": "yarn run lint -- --fix",
+    "prettier": "prettier --write 'src/*.@(js|ts|tsx|json)'",
+    "check": "yarn && yarn prettier && yarn lint && tsc && yarn test"
+  },
+  "license": "Apache-2.0",
+  "peerDependencies": {
+    "@launchdarkly/node-server-sdk": "9.3.0-alpha.1",
+    "@opentelemetry/api": ">=1.3.0"
+  },
+  "devDependencies": {
+    "@launchdarkly/node-server-sdk": "9.3.0-alpha.1",
+    "@launchdarkly/private-js-mocks": "0.0.1",
+    "@opentelemetry/api": ">=1.3.0",
+    "@testing-library/dom": "^9.3.1",
+    "@testing-library/jest-dom": "^5.16.5",
+    "@types/jest": "^29.5.3",
+    "@types/semver": "^7.5.0",
+    "@typescript-eslint/eslint-plugin": "^6.20.0",
+    "@typescript-eslint/parser": "^6.20.0",
+    "eslint": "^8.45.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-airbnb-typescript": "^17.1.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-jest": "^27.6.3",
+    "eslint-plugin-prettier": "^5.0.0",
+    "jest": "^29.6.1",
+    "jest-diff": "^29.6.1",
+    "jest-environment-jsdom": "^29.6.1",
+    "launchdarkly-js-test-helpers": "^2.2.0",
+    "prettier": "^3.0.0",
+    "ts-jest": "^29.1.1",
+    "typedoc": "0.25.0",
+    "typescript": "5.1.6"
+  }
+}