Opentelemetry Integration

.env

@@ -13,6 +13,7 @@ COAP_SIMPLE_PORT_OUT=5683
 COAP_NEGOTIATION_PORT_OUT=5684
 SMART_HOME_SMART_CLOCK_PORT_OUT=5685
 TRAEFIK_DASHBOARD_PORT_OUT=8080
+JAEGER_ENDPOINT=http://host.docker.internal:8085/api/traces
 
 STACK_HOSTNAME="plugfest.thingweb.io"
 BROKER_URI="plugfest.thingweb.io"

README.md

@@ -178,3 +178,7 @@ docker buildx build \
 For running the things separately, using their `Dockerfile`'s, `docker build -t <image-tag> -f ./Dockerfile ../../` command must be used to give the context to be able to copy `tm.json` into the container.
 
 For Node.js-based devices, we use npm workspaces and running `npm install` at the root directory installs all the packages needed for every device. After packages are installed, running `node main.js` would run the thing. For port configuration, running either `node main.js -p 1000` or `node main.js --port 1000` would start the thing on port 1000.
+
+## Tracing
+
+Distributed tracing is enabled using OpenTelemetry and Jaeger. To view all traces and logs, open [http://localhost:8084](http://localhost:8084) in your browser (Jaeger UI). Traces are sent to the Jaeger collector on port 14268.

docker-compose-things-local.yml

@@ -109,6 +109,7 @@ services:
         environment:
             - HOSTNAME=${STACK_HOSTNAME}
             - PORT=${WEB_PORT_OUT}
+            - JAEGER_ENDPOINT=${JAEGER_ENDPOINT}
         networks:
             - things_network
     http-data-schema-thing:

docker-compose-things.yml

@@ -149,6 +149,7 @@ services:
         environment:
             - HOSTNAME=${STACK_HOSTNAME}
             - PORT=${WEB_PORT_OUT}
+            - JAEGER_ENDPOINT=${JAEGER_ENDPOINT}
         deploy:
             resources:
                 limits:

package.json

@@ -35,8 +35,10 @@
         "eslint-config-prettier": "^9.1.0",
         "eslint-config-standard": "^17.1.0",
         "eslint-plugin-import": "^2.30.0",
+        "eslint-plugin-n": "^16.6.2",
         "eslint-plugin-node": "^11.1.0",
         "eslint-plugin-notice": "^1.0.0",
+        "eslint-plugin-promise": "^6.6.0",
         "eslint-plugin-unused-imports": "^4.1.4",
         "eslint-plugin-workspaces": "^0.10.1",
         "mocha": "^10.7.3",

tests/test-enhanced-tracing.sh

@@ -0,0 +1,186 @@
+#!/bin/bash
+
+# Test script for Enhanced OpenTelemetry Tracing
+# This script demonstrates the full-stack tracing capabilities
+
+echo "🚀 Testing Enhanced OpenTelemetry Tracing for Advanced Coffee Machine"
+echo "=================================================="
+
+# Configuration
+COFFEE_MACHINE_URL="http://localhost/http-advanced-coffee-machine"
+JAEGER_URL="http://jaeger.localhost"
+
+
+echo "📋 Prerequisites:"
+echo "   - Coffee machine should be running on port 80 (via Docker/proxy)"
+echo "   - Jaeger should be running on port 8084 (UI) and 14268 (collector)"
+echo "   - View traces at: $JAEGER_URL"
+echo ""
+
+sleep 2
+
+echo "🧪 Test 0: Reset Resources (prepare for testing)"
+echo "----------------------------------------"
+curl -X PUT "$COFFEE_MACHINE_URL/properties/availableResourceLevel?id=water" \
+  -H 'Content-Type: application/json' \
+  -d '100' \
+  -w "\nStatus: %{http_code}\nTime: %{time_total}s\n\n"
+
+curl -X PUT "$COFFEE_MACHINE_URL/properties/availableResourceLevel?id=milk" \
+  -H 'Content-Type: application/json' \
+  -d '100' \
+  -w "\nStatus: %{http_code}\nTime: %{time_total}s\n\n"
+
+curl -X PUT "$COFFEE_MACHINE_URL/properties/availableResourceLevel?id=chocolate" \
+  -H 'Content-Type: application/json' \
+  -d '100' \
+  -w "\nStatus: %{http_code}\nTime: %{time_total}s\n\n"
+
+curl -X PUT "$COFFEE_MACHINE_URL/properties/availableResourceLevel?id=coffeeBeans" \
+  -H 'Content-Type: application/json' \
+  -d '100' \
+  -w "\nStatus: %{http_code}\nTime: %{time_total}s\n\n"
+
+sleep 1
+
+echo "🧪 Test 1: Make a Latte (should show full nested trace)"
+echo "----------------------------------------"
+curl -X POST "$COFFEE_MACHINE_URL/actions/makeDrink?drinkId=latte&size=l&quantity=1" \
+  -w "\nStatus: %{http_code}\nTime: %{time_total}s\n\n"
+
+sleep 1
+
+echo "🧪 Test 2: Make an Espresso (smaller trace)"
+echo "----------------------------------------"
+curl -X POST "$COFFEE_MACHINE_URL/actions/makeDrink?drinkId=espresso&size=s&quantity=2" \
+  -w "\nStatus: %{http_code}\nTime: %{time_total}s\n\n"
+
+sleep 1
+
+echo "🧪 Test 3: Set a Valid Schedule (should show full nested trace)"
+echo "----------------------------------------"
+curl -X POST "$COFFEE_MACHINE_URL/actions/setSchedule" \
+  -H 'Content-Type: application/json' \
+  -d '{"time":"08:00","mode":"everyday","drinkId":"latte","size":"l","quantity":2}' \
+  -w "\nStatus: %{http_code}\nTime: %{time_total}s\n\n"
+
+sleep 1
+
+echo "🧪 Test 4: Invalid Schedule (should show error trace)"
+echo "----------------------------------------"
+curl -X POST "$COFFEE_MACHINE_URL/actions/setSchedule" \
+  -H 'Content-Type: application/json' \
+  -d '{"time":"25:99","mode":"everyday"}' \
+  -w "\nStatus: %{http_code}\nTime: %{time_total}s\n\n"
+
+sleep 1
+
+echo "🧪 Test 5: Check Resources (property read trace)"
+echo "----------------------------------------"
+curl -X GET "$COFFEE_MACHINE_URL/properties/allAvailableResources" \
+  -H 'Accept: application/json' \
+  -w "\nStatus: %{http_code}\nTime: %{time_total}s\n\n"
+
+sleep 1
+
+echo "🧪 Test 6: Check Possible Drinks (property read trace)"
+echo "----------------------------------------"
+curl -X GET "$COFFEE_MACHINE_URL/properties/possibleDrinks" \
+  -H 'Accept: application/json' \
+  -w "\nStatus: %{http_code}\nTime: %{time_total}s\n\n"
+
+sleep 1
+
+echo "🧪 Test 7: Update Resource Level (property write trace)"
+echo "----------------------------------------"
+curl -X PUT "$COFFEE_MACHINE_URL/properties/availableResourceLevel?id=water" \
+  -H 'Content-Type: application/json' \
+  -d '50' \
+  -w "\nStatus: %{http_code}\nTime: %{time_total}s\n\n"
+
+sleep 1
+
+echo "🧪 Test 8: Update Served Counter (property write trace)"
+echo "----------------------------------------"
+curl -X PUT "$COFFEE_MACHINE_URL/properties/servedCounter" \
+  -H 'Content-Type: application/json' \
+  -d '1001' \
+  -w "\nStatus: %{http_code}\nTime: %{time_total}s\n\n"
+
+sleep 1
+
+echo "🧪 Test 9: Check Schedules (property read trace)"
+echo "----------------------------------------"
+curl -X GET "$COFFEE_MACHINE_URL/properties/schedules" \
+  -H 'Accept: application/json' \
+  -w "\nStatus: %{http_code}\nTime: %{time_total}s\n\n"
+
+sleep 1
+
+echo "🧪 Test 10: Trigger Low Resource Event - Set Water to 5% (event trace)"
+echo "----------------------------------------"
+curl -X PUT "$COFFEE_MACHINE_URL/properties/availableResourceLevel?id=water" \
+  -H 'Content-Type: application/json' \
+  -d '5' \
+  -w "\nStatus: %{http_code}\nTime: %{time_total}s\n\n"
+
+sleep 1
+
+echo "🧪 Test 11: Trigger Out of Resource Event - Set Coffee Beans to 0% (event trace)"
+echo "----------------------------------------"
+curl -X PUT "$COFFEE_MACHINE_URL/properties/availableResourceLevel?id=coffeeBeans" \
+  -H 'Content-Type: application/json' \
+  -d '0' \
+  -w "\nStatus: %{http_code}\nTime: %{time_total}s\n\n"
+
+sleep 1
+
+echo "🧪 Test 12: Try Making Drink with No Coffee Beans (should trigger outOfResource event)"
+echo "----------------------------------------"
+curl -X POST "$COFFEE_MACHINE_URL/actions/makeDrink?drinkId=espresso&size=m&quantity=1" \
+  -w "\nStatus: %{http_code}\nTime: %{time_total}s\n\n"
+
+sleep 1
+
+echo "🧪 Test 13: Set High Served Counter to Trigger Maintenance Event (event trace)"
+echo "----------------------------------------"
+curl -X PUT "$COFFEE_MACHINE_URL/properties/servedCounter" \
+  -H 'Content-Type: application/json' \
+  -d '1500' \
+  -w "\nStatus: %{http_code}\nTime: %{time_total}s\n\n"
+
+sleep 1
+
+echo "🧪 Test 14: Check Maintenance Status After High Counter (property read trace)"
+echo "----------------------------------------"
+curl -X GET "$COFFEE_MACHINE_URL/properties/maintenanceNeeded" \
+  -H 'Accept: application/json' \
+  -w "\nStatus: %{http_code}\nTime: %{time_total}s\n\n"
+
+echo "✅ All tests completed!"
+echo ""
+echo "🔍 To view the enhanced traces:"
+echo "   1. Open Jaeger UI: $JAEGER_URL"
+echo "   2. Select service: 'advanced-coffee-machine'"
+echo "   3. Click 'Find Traces'"
+echo "   4. Click on any trace to see the nested span structure"
+echo ""
+echo "📊 You should see traces with:"
+echo "   • HTTP request spans (auto-instrumented)"
+echo "   • property.read.* spans for GET requests with nested business logic"
+echo "   • property.write.* spans for PUT requests with validation and events"
+echo "   • action.* spans for POST requests with complex workflows"
+echo "   • event.* spans for outOfResource and maintenanceNeeded events"
+echo "   • Nested business logic, validation, and calculation spans"
+echo "   • Database operation spans (db.select, db.update, db.insert)"
+echo "   • Hardware simulation spans (sensors, drink preparation)"
+echo "   • Rich metadata and contextual attributes"
+echo "   • Error details and validation failures"
+echo ""
+echo "🎯 Event Testing Scenarios:"
+echo "   • Low resource alerts (water at 5%)"
+echo "   • Out of resource events (coffee beans at 0%)"
+echo "   • Maintenance threshold events (served counter > 1000)"
+echo "   • Failed drink attempts triggering resource events"
+echo ""
+echo "🚀 This comprehensive test covers ALL WoT interaction types with full-stack tracing!"

things/advanced-coffee-machine/http/ts/Dockerfile

@@ -4,7 +4,7 @@ WORKDIR /app
 COPY ./advanced-coffee-machine.tm.json .
 COPY ./http/ts .
 
-RUN npm install
+RUN npm install --legacy-peer-deps
 
 RUN npm run build
 

things/advanced-coffee-machine/http/ts/package.json

@@ -24,7 +24,12 @@
         "@node-wot/core": "0.8.16",
         "dotenv": "^16.4.5",
         "json-placeholder-replacer": "^2.0.5",
-        "wot-typescript-definitions": "0.8.0-SNAPSHOT.29"
+        "wot-typescript-definitions": "0.8.0-SNAPSHOT.29",
+        "@opentelemetry/api": "1.9.0",
+        "@opentelemetry/sdk-trace-node": "1.9.0",
+        "@opentelemetry/exporter-jaeger": "1.9.0",
+        "@opentelemetry/resources": "1.9.0",
+        "@opentelemetry/semantic-conventions": "1.9.0"
     },
     "devDependencies": {
         "@types/node": "^22.1.0",