examples: update to use tracing

Author: fracek

develop/docker-compose.yml

@@ -0,0 +1,16 @@
+services:
+  otel-collector:
+    image: otel/opentelemetry-collector-contrib:0.121.0
+    command: ["--config=/etc/otel-collector-config.yml"]
+    volumes:
+      - ./otel-collector-config.yml:/etc/otel-collector-config.yml:ro
+    ports:
+      - "4317:4317"   # OTLP gRPC
+      - "4318:4318"   # OTLP HTTP
+    depends_on:
+      - jaeger
+
+  jaeger:
+    image: jaegertracing/all-in-one:1.66.0
+    ports:
+      - "16686:16686" # Jaeger UI

develop/otel-collector-config.yml

@@ -0,0 +1,23 @@
+receivers:
+  otlp:
+    protocols:
+      grpc:
+        endpoint: 0.0.0.0:4317
+      http:
+        endpoint: 0.0.0.0:4318
+
+processors:
+  batch:
+
+exporters:
+  otlp/jaeger:
+    endpoint: jaeger:4317
+    tls:
+      insecure: true
+
+service:
+  pipelines:
+    traces:
+      receivers: [otlp]
+      processors: [batch]
+      exporters: [otlp/jaeger]

examples/evm-client/package.json

@@ -14,6 +14,10 @@
     "@apibara/evm": "workspace:*",
     "@apibara/evm-rpc": "workspace:*",
     "@apibara/protocol": "workspace:*",
+    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/exporter-trace-otlp-grpc": "^0.57.2",
+    "@opentelemetry/resources": "^1.30.1",
+    "@opentelemetry/sdk-trace-node": "^1.30.1",
     "citty": "^0.1.6",
     "consola": "^3.4.2",
     "nice-grpc": "^2.1.8",

examples/evm-client/src/main-rpc.ts

@@ -1,6 +1,13 @@
 import assert from "node:assert";
 import { EvmRpcStream, type Filter, rateLimitedHttp } from "@apibara/evm-rpc";
 import { createRpcClient } from "@apibara/protocol/rpc";
+import { trace } from "@opentelemetry/api";
+import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-grpc";
+import { Resource } from "@opentelemetry/resources";
+import {
+  BatchSpanProcessor,
+  NodeTracerProvider,
+} from "@opentelemetry/sdk-trace-node";
 import { defineCommand, runMain } from "citty";
 import consola from "consola";
 import { createPublicClient } from "viem";
@@ -33,8 +40,29 @@ const command = defineCommand({
       default: "accepted",
       description: "Block finality (finalized, accepted)",
     },
+    trace: {
+      type: "string",
+      description:
+        "Enable OpenTelemetry tracing and specify the OTLP gRPC endpoint URL (e.g. http://localhost:4317)",
+    },
   },
   async run({ args }) {
+    if (args.trace) {
+      const provider = new NodeTracerProvider({
+        resource: new Resource({
+          "service.name": "example-evm-rpc-client",
+        }),
+      });
+
+      const exporter = new OTLPTraceExporter({ url: args.trace });
+      provider.addSpanProcessor(new BatchSpanProcessor(exporter));
+      provider.register();
+
+      trace.setGlobalTracerProvider(provider);
+
+      consola.info("OpenTelemetry tracing enabled:", args.trace);
+    }
+
     consola.info("Creating EVM RPC client");
 
     const viemClient = createPublicClient({