@kimchitest/opencode-otel-plugin 1.0.0

package/README.md

@@ -0,0 +1,156 @@
+# OpenCode OTEL Plugin for AI Enabler
+
+Sends usage telemetry from OpenCode to the AI Enabler service.
+
+OpenCode version 1.2.20+
+
+## Installation
+
+### Option 1: NPM package (recommended)
+
+Add to your `~/.config/opencode/opencode.json`:
+
+```json
+{
+  "plugin": ["@castai/opencode-otel-plugin"]
+}
+```
+
+Set environment variables (see [Configuration](#configuration) section below), then restart OpenCode.
+
+### Option 2: Local plugin
+
+1. Copy `plugin.ts` to your OpenCode plugins directory:
+
+```bash
+mkdir -p ~/.config/opencode/plugins
+cp plugin.ts ~/.config/opencode/plugins/otel.ts
+```
+
+2. Set environment variables (see [Configuration](#configuration) section below)
+
+3. Restart OpenCode.
+
+### Option 3: Project-level plugin
+
+1. Create the plugins directory in your project:
+
+```bash
+mkdir -p .opencode/plugins
+```
+
+2. Copy `plugin.ts` to `.opencode/plugins/otel.ts`
+
+3. Set the environment variables (same as above)
+
+## Configuration
+
+### Environment Variables
+
+| Variable | Required | Description |
+|----------|----------|-------------|
+| `OPENCODE_ENABLE_TELEMETRY` | Yes | Set to `1` to enable telemetry |
+| `OPENCODE_OTLP_ENDPOINT` | Yes | AI Enabler logs ingest endpoint URL |
+| `OPENCODE_OTLP_HEADERS` | Yes | Authorization header with your AI Enabler API key |
+
+#### Example Environment Variables
+
+Add these to your shell config (`~/.zshrc`, `~/.bashrc`, etc.):
+
+```bash
+# Enable the plugin
+export OPENCODE_ENABLE_TELEMETRY=1
+
+# AI Enabler endpoint for log ingestion
+export OPENCODE_OTLP_ENDPOINT=https://api.cast.ai/ai-optimizer/v1beta/logs:ingest
+
+# Authorization header with your AI Enabler API key
+export OPENCODE_OTLP_HEADERS="Authorization=Bearer YOUR_API_KEY_HERE"
+```
+
+After adding, restart your shell or run `source ~/.zshrc`.
+
+### Provider Configuration
+
+The plugin reads provider information from your OpenCode config (`~/.config/opencode/opencode.json`). Ensure your provider key matches one of the valid values below.
+
+### Valid Provider Values
+
+| Provider Key | Description |
+|--------------|-------------|
+| `openai` | OpenAI |
+| `anthropic` | Anthropic (Claude) |
+| `azure` | Azure OpenAI |
+| `azure_ai` | Azure AI |
+| `gemini` | Google Gemini |
+| `vertex_ai-language-models` | Vertex AI Gemini |
+| `vertex_ai-anthropic_models` | Vertex AI Anthropic |
+| `groq` | Groq |
+| `mistral` | Mistral |
+| `codestral` | Codestral |
+| `cohere_chat` | Cohere |
+| `anyscale` | Anyscale |
+| `openrouter` | OpenRouter |
+| `databricks` | Databricks |
+| `perplexity` | Perplexity |
+| `hosted_vllm` | Hosted vLLM |
+| `bedrock` | AWS Bedrock |
+| `ai-enabler` | AI Enabler (serverless models) |
+
+> **Important:** If your provider key does not match one of the valid values listed above, the request will be **rejected** and you will see an error toast notification in OpenCode. Make sure to use a provider key from the list above to ensure your usage data is recorded correctly.
+
+### Example OpenCode Config
+
+```json
+{
+  "model": "ai-enabler/glm-5-fp8",
+  "provider": {
+    "ai-enabler": {
+      "npm": "@ai-sdk/openai-compatible",
+      "name": "AI Enabler",
+      "options": {
+        "baseURL": "https://llm.cast.ai/openai/v1",
+        "apiKey": "your-api-key"
+      },
+      "models": {
+        "glm-5-fp8": {
+          "name": "glm-5-fp8",
+          "tool_call": true
+        }
+      }
+    }
+  }
+}
+```
+
+## Data Sent
+
+The plugin sends `api_request` events for each completed assistant message with token usage.
+
+### API Request Attributes
+
+| Attribute | Description |
+|-----------|-------------|
+| `model` | Model identifier |
+| `provider` | Provider identifier |
+| `input_tokens` | Number of input tokens |
+| `output_tokens` | Number of output tokens |
+| `cost_usd` | Cost in USD |
+| `duration_ms` | Request duration in milliseconds (always 0 - OpenCode doesn't expose this data) |
+
+## Troubleshooting
+
+The plugin shows error notifications via OpenCode toasts when issues occur:
+
+### Error Toast Messages
+
+- **"Invalid provider"** - Your provider key is not recognized. Update your `opencode.json` to use a valid provider key from the list above.
+- **"Telemetry error"** - Other errors (network issues, auth failures, etc.)
+
+### Debugging Steps
+
+1. Verify environment variables are set correctly
+2. Check your AI Enabler API key is valid
+3. Ensure the provider key in your OpenCode config matches a valid value
+4. Verify the endpoint URL is correct
+

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@kimchitest/opencode-otel-plugin",
+  "version": "1.0.0",
+  "description": "OpenCode OTEL plugin for AI Enabler - sends usage telemetry for cost tracking",
+  "main": "plugin.ts",
+  "type": "module",
+  "keywords": [
+    "opencode",
+    "otel",
+    "opentelemetry",
+    "ai-enabler",
+    "telemetry"
+  ],
+  "author": "AI Enabler Team",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/castai/opencode-otel-plugin.git"
+  },
+  "files": [
+    "plugin.ts",
+    "README.md"
+  ]
+}

package/plugin.ts

@@ -0,0 +1,155 @@
+/**
+ * OpenCode OTEL Plugin for AI Enabler
+ * 
+ * Sends api_request events to the AI Enabler service for usage tracking.
+ * 
+ * REQUIRED ATTRIBUTES:
+ * - model: The model identifier (e.g., "glm-5-fp8", "claude-sonnet-4-6")
+ * - provider: The provider identifier from the list below
+ * - input_tokens: Number of input/prompt tokens
+ * - output_tokens: Number of output/completion tokens
+ * - cost_usd: Cost in USD (optional, used as fallback if model not found)
+ * 
+ * VALID PROVIDER VALUES:
+ * - "openai" - OpenAI
+ * - "anthropic" - Anthropic (Claude)
+ * - "azure" - Azure OpenAI
+ * - "azure_ai" - Azure AI
+ * - "gemini" - Google Gemini
+ * - "vertex_ai-language-models" - Vertex AI Gemini
+ * - "vertex_ai-anthropic_models" - Vertex AI Anthropic
+ * - "groq" - Groq
+ * - "mistral" - Mistral
+ * - "codestral" - Codestral
+ * - "cohere_chat" - Cohere
+ * - "anyscale" - Anyscale
+ * - "openrouter" - OpenRouter
+ * - "databricks" - Databricks
+ * - "perplexity" - Perplexity
+ * - "hosted_vllm" - Hosted vLLM
+ * - "bedrock" - AWS Bedrock
+ * - "ai-enabler" - AI Enabler (serverless models)
+ * 
+ * ENVIRONMENT VARIABLES:
+ * - OPENCODE_ENABLE_TELEMETRY: Set to enable telemetry
+ * - OPENCODE_OTLP_ENDPOINT: The AI Enabler logs ingest endpoint
+ * - OPENCODE_OTLP_HEADERS: Authorization header (format: "Authorization=Bearer <token>")
+ * 
+ * Tested with OpenCode version: 1.2.20
+ */
+
+const endpoint = process.env.OPENCODE_OTLP_ENDPOINT || "http://localhost:4318"
+const headersStr = process.env.OPENCODE_OTLP_HEADERS || ""
+const enabled = !!process.env.OPENCODE_ENABLE_TELEMETRY
+
+const sentMessages = new Set<string>()
+
+const headers: Record<string, string> = { "Content-Type": "application/json" }
+if (headersStr) {
+  const match = headersStr.match(/Authorization=Bearer\s+(.+)/)
+  if (match) {
+    headers["Authorization"] = `Bearer ${match[1].replace(/"/g, "")}`
+  }
+}
+
+async function sendLog(eventName: string, attrs: Record<string, string | number> = {}) {
+  if (!enabled) return null
+
+  const now = String(Date.now() * 1000000)
+
+  const payload = {
+    resourceLogs: [{
+      resource: {
+        attributes: [
+          { key: "service.name", value: { stringValue: "opencode" } }
+        ],
+        droppedAttributesCount: 0
+      },
+      scopeLogs: [{
+        scope: { name: "opencode", version: "1.0.0" },
+        logRecords: [{
+          timeUnixNano: now,
+          observedTimeUnixNano: now,
+          severityNumber: 9,
+          severityText: "INFO",
+          eventName: eventName,
+          body: { stringValue: eventName },
+          attributes: Object.entries(attrs).map(([k, v]) => ({
+            key: k,
+            value: { stringValue: String(v) }
+          })),
+          droppedAttributesCount: 0,
+          flags: 0,
+          traceId: "",
+          spanId: ""
+        }]
+      }]
+    }]
+  }
+
+  try {
+    const response = await fetch(endpoint, {
+      method: "POST",
+      headers,
+      body: JSON.stringify(payload),
+    })
+    
+    if (!response.ok) {
+      const body = await response.text()
+      return { error: true, status: response.status, body }
+    }
+    return { error: false }
+  } catch (err) {
+    return { error: true, message: String(err) }
+  }
+}
+
+export const OtelPlugin = async ({ client }: { client: { tui: { showToast: (opts: { body: { message: string; variant: "info" | "success" | "warning" | "error" } }) => Promise<boolean> } } }) => {
+  if (!enabled) return {}
+
+  return {
+    event: async ({ event }: { event: { type: string; properties?: Record<string, unknown> } }) => {
+      if (event.type === "message.updated") {
+        const info = (event.properties?.info as Record<string, unknown>) || {}
+
+        if (info.role === "assistant" && info.finish) {
+          const messageId = String(info.id || "unknown")
+          if (sentMessages.has(messageId)) return
+
+          sentMessages.add(messageId)
+          const tokens = (info.tokens as Record<string, number>) || {}
+          const provider = String(info.providerID || "unknown")
+          const model = String(info.modelID || "unknown")
+
+          const result = await sendLog("api_request", {
+            "event.name": "api_request",
+            client: "opencode",
+            model,
+            provider,
+            input_tokens: tokens.input || 0,
+            output_tokens: tokens.output || 0,
+            cost_usd: Number(info.cost) || 0,
+            duration_ms: 0,
+          })
+
+          if (result?.error) {
+            let errorMsg = result.body || result.message || "Unknown error"
+            try {
+              const parsed = JSON.parse(errorMsg)
+              if (parsed.message) {
+                errorMsg = parsed.message
+              }
+            } catch {
+            }
+            await client.tui.showToast({
+              body: {
+                message: `OTEL: ${errorMsg}`,
+                variant: "error"
+              }
+            })
+          }
+        }
+      }
+    },
+  }
+}