Instrumenting SDKs with open telemetry

.changeset/cuddly-rivers-bathe.md

@@ -0,0 +1,6 @@
+---
+'@featureboard/node-sdk': minor
+'@featureboard/js-sdk': minor
+---
+
+Added native open telemetry integration

.github/workflows/main.yml

@@ -69,6 +69,10 @@ jobs:
           sed -i "s/<Version>.*<\/Version>/<Version>$version<\/Version>/" $csproj_path
           sed -i "s/<Copyright>.*<\/Copyright>/<Copyright>Copyright (c) Arkahna $currentYear<\/Copyright>/" $csproj_path
 
+      - name: Update Node/JS SDK version
+        run: |
+          pnpm nx run-many --target version --all
+
       - name: Push changes
         run: |
           pnpm i -r --no-frozen-lockfile

.github/workflows/pr.yml

@@ -42,24 +42,4 @@ jobs:
         run: pnpm tsc -b
 
       - name: Lint, build and test
-        run: pnpm nx run-many --target build,lint,test --all --exclude examples-dotnet-api
-
-      - name: Version command
-        id: version
-        run: |
-          npx changeset version
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Update DotNet SDK version and copyright year
-        run: |
-          version=$(node -pe "require('./libs/dotnet-sdk/package.json').version")
-          echo "Version: $version"
-          currentYear=$(node -pe "new Date().getFullYear()")
-          csproj_path=libs/dotnet-sdk/FeatureBoard.DotnetSdk.csproj
-          sed -i "s/<Version>.*<\/Version>/<Version>$version<\/Version>/" $csproj_path
-          sed -i "s/<Copyright>.*<\/Copyright>/<Copyright>Copyright (c) Arkahna $currentYear<\/Copyright>/" $csproj_path
-          cat $csproj_path
-
-      - name: Package libs
-        run: pnpm package
+        run: pnpm nx run-many --target build,lint,test,package --all --exclude examples-dotnet-api

.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,15 @@
     },
     "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"
     }
 }

libs/js-sdk/project.json

@@ -17,6 +17,13 @@
                 "cwd": "libs/js-sdk"
             }
         },
+        "version": {
+            "executor": "@nrwl/workspace:run-commands",
+            "options": {
+                "command": "echo \"export const version = '$(jq -r '.version' package.json)';\" > src/version.ts",
+                "cwd": "libs/js-sdk"
+            }
+        },
         "package": {
             "executor": "nx:run-commands",
             "options": {
@@ -28,7 +35,8 @@
                 ],
                 "cwd": "libs/js-sdk",
                 "parallel": false
-            }
+            },
+            "dependsOn": ["version"]
         }
     }
 }