Instrumenting SDKs with open telemetry

.gitignore

@@ -51,3 +51,6 @@ tsconfig.tsbuildinfo
 **/src/**/*.js
 **/src/**/*.d.ts
 **/src/**/*.js.map
+!**/src/**/schema.d.ts
+
+.env

README.md

@@ -21,3 +21,25 @@ Go to [our website](https://featureboard.app) to find out more.
 ## Documentation
 
 Installation and usage instructions can be found on our [docs site](https://docs.featureboard.app).
+
+## Open Telemetry
+
+The FeatureBoard SDKs are instrumented with Open Telemetry natively, so you can easily integrate with your existing observability tools.
+
+### Unit tests
+
+To configure the SDK to use a local Open Telemetry Collector, set the following environment variables:
+
+OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318
+
+You can put this in a `.env` file in the root of the project.
+
+## Debugging
+
+To enable debug logging, set the following environment variable:
+
+```
+FEATUREBOARD_SDK_DEBUG=true
+```
+
+In the browser set `window.FEATUREBOARD_SDK_DEBUG = true`

libs/js-sdk/.eslintrc.cjs

@@ -14,5 +14,11 @@ module.exports = {
       },
     },
   ],
-  ignorePatterns: ['!**/*', 'node_modules', 'out-tsc'],
+  ignorePatterns: [
+    '!**/*',
+    'node_modules',
+    'tsc-out',
+    'vitest.config.ts',
+    'test-setup.ts',
+  ],
 }

libs/js-sdk/package.json

@@ -33,7 +33,16 @@
     },
     "dependencies": {
         "@featureboard/contracts": "workspace:*",
-        "debug": "^4.3.4",
         "promise-completion-source": "^1.0.0"
+    },
+    "peerDependencies": {
+        "@opentelemetry/api": "^1.0.0"
+    },
+    "devDependencies": {
+        "@opentelemetry/api": "^1.7.0",
+        "@opentelemetry/exporter-trace-otlp-http": "^0.45.1",
+        "@opentelemetry/sdk-node": "^0.45.1",
+        "@opentelemetry/sdk-trace-base": "^1.18.1",
+        "@opentelemetry/sdk-trace-node": "^1.18.1"
     }
 }

libs/js-sdk/project.json

@@ -21,6 +21,7 @@
             "executor": "nx:run-commands",
             "options": {
                 "commands": [
+                    "echo \"export const version = '$(jq -r '.version' package.json)';\" > src/version.ts",
                     "tsup src/index.ts -d dist --sourcemap --format esm --legacy-output --external @featureboard/contracts --env.TEST false",
                     "tsup src/index.ts -d dist/legacycjs --sourcemap --format cjs --legacy-output --external @featureboard/contracts --env.TEST false",
                     "tsup src/index.ts -d dist --sourcemap --format esm,cjs --external @featureboard/contracts --env.TEST false",