refactor: improve OpenTelemetry instrumentation

Author: adrianescutia

.gitignore

@@ -1,5 +1,5 @@
 # custom
-/agentico-project
+/agentico-project**
 
 # Logs
 logs

src/index.ts

@@ -216,7 +216,7 @@ async function createServer(directory: string, options: any = {}) {
   // Configuration based on user answers, or default values
   const config = {
     // Remove special characters from name
-    name: (options.name || answers.name).replace(/[^a-zA-Z0-9_]/g, ''),
+    name: lodash.kebabCase(options.name || answers.name).toLowerCase(),
     description: options.description || answers.description,
     tool: options.tool || answers.tool,
     installForClaude: options.installForClaude || answers.installForClaude,

template/instrumentation/scripts/agenticotel-config.yaml

@@ -10,8 +10,8 @@ processors:
     timeout: 5s
 
 exporters:
-  # otlp: # Exports traces to Jaeger
-  #   endpoint: "http://host.docker.internal:14250"
+  # otlp: # Exports traces to Jaeger - in case you want to use Jaeger at the same time
+  #   endpoint: "http://jaeger:14250"
   #   tls:
   #     insecure: true
   otlphttp:

template/project/package.json.ejs

@@ -23,7 +23,7 @@
     "build": "tsc && node -e \"require('fs').chmodSync('build/index.js', '755')\"",
     "prepare": "npm run build",
     "watch": "tsc --watch",
-    "inspector": "npx @modelcontextprotocol/inspector build/index.js"
+    "inspector": "npx @modelcontextprotocol/inspector@0.3.0 build/index.js"
   },
   "dependencies": {
     "@agentico/mcp-server": "^0.3.0",

template/project/src/AgenticoTool.ts.ejs

@@ -1,7 +1,6 @@
 import { z } from "zod";
 import { zodToJsonSchema } from 'zod-to-json-schema';
 import { Tool } from "@agentico/mcp-server";
-<% if (instrumentation) { %>import opentelemetry from '@opentelemetry/api';<% } %>
 
 // @todo Adapt the schema and input type to match the tool's input you want to create
 const <%= toolPascalCase %>Schema = z.object({
@@ -22,34 +21,31 @@ export class <%= toolPascalCase %>Tool extends Tool {
     // @todo - Implement any initialization logic here
     // console.error("<%= toolPascalCase %>Tool initialized");
   }
-  execute(input: <%= toolPascalCase %>Input): Promise<any> {
+  async execute(input: <%= toolPascalCase %>Input): Promise<any> {
     // @todo - Implement the tool logic here - this is where the tool does its work    
     <% if (instrumentation) { %>
     // OpenTelemetry instrumentation example - @todo - adapt to your needs
-    const tracer = opentelemetry.trace.getTracer('Agentico-tracer');
-    const message = input.message.length > 20 ? `${input.message.substring(0, 20)}...` : input.message;
-    const rootSpan = tracer.startSpan(`<%= toolPascalCase %>Tool Execution - ${message}`);
+    this.otel.startSpan(`Tool Execution - ${input.message}`);
       
     try {      
       // Start another span. In this example, the main method already started a
-      // span, so that'll be the parent span, and this will be a child span.
-      const ctx = opentelemetry.trace.setSpan(opentelemetry.context.active(), rootSpan);
       // simulate 3 steps
-      const step1 = tracer.startSpan('<%= toolPascalCase %> Execution Step 1', undefined, ctx);
-      rootSpan.addEvent('<%= toolPascalCase %> Execution Started - Step 1');
+      const step1 = this.otel.startSpan('Execution Step 1');
+      this.otel.addEvent('Execution Started - Step 1', step1);
       await new Promise((r) => setTimeout(r, 700));
       step1.end();
-      rootSpan.addEvent('<%= toolPascalCase %> Execution Ended - Step 1');
-      const step2 = tracer.startSpan('<%= toolPascalCase %> Execution Step 2', undefined, ctx);
+      // unporpose, no span for this event - see the result in the trace ;)
+      this.otel.addEvent('Execution Ended - Step 1');
+      const step2 = this.otel.startSpan('Execution Step 2');
       await new Promise((r) => setTimeout(r, 1000));
       step2.end();
-      const step3 = tracer.startSpan('<%= toolPascalCase %> Execution Step 3', undefined, ctx);
+      const step3 = this.otel.startSpan('Execution Step 3');
       await new Promise((r) => setTimeout(r, 800));
       step3.end();
     } catch (error) {
-      console.error('Automation failed:', error);
+      this.otel.addErrorEvent(error as Error);
     } finally {
-      rootSpan.end();
+      this.otel.endSpan();
     }
     <% } %>
     // echoing, just return the input message

template/project/src/index.ts.ejs

@@ -11,15 +11,17 @@ import { <%= toolPascalCase %>Tool } from "./AgenticoTool.js";
 /**
  * Create an MCP server with capabilities for an echo tool.
  */
-const myServer = new MCPServer("<%= name %>", "0.1.0");
+const myServer = new MCPServer(
+  "<%= name %>",
+  "0.1.0",
+  <% if (instrumentation) { -%>
+  "<%= traceExporterUrl %>"
+  <% } -%>
+);
 
 async function main() {
   // Register tools
   myServer.registerTool("<%= tool %>", new <%= toolPascalCase %>Tool());
-  <% if (instrumentation) { %>
-  // Initialize OpenTelemetry
-  otlpSDK.start();
-  <% } -%>
   await myServer.run();
 }