Support opentelemetry

Author: ericdallo

.cljfmt.edn

@@ -0,0 +1 @@
+{:extra-indents {task [[:inner 0]]}}

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+- Add support for Opentelemetry via `otlp` config.
+  - Export metrics of server tasks, tool calls, prompts, resources.
+
 ## 0.54.4
 
 - Use jsonrpc4clj instead of lsp4clj.

README.md

@@ -33,6 +33,7 @@ src="https://img.shields.io/github/stars/editor-code-assistant/eca?style=flat-sq
 - :coffee: **Agentic**: let LLM work as an agent with its native tools and MCPs you can configure.
 - :syringe: **Context**: support: giving more details about your code to the LLM, including MCP resources and prompts.
 - :rocket: **Multi models**: Login to OpenAI, Anthropic, Copilot, Ollama local models and many more.
+- :chart_with_upwards_trend: **OpenTelemetry**: Export metrics of tools, prompts, server usage.
 
 ## Rationale 
 

deps.edn

@@ -11,6 +11,9 @@
         hato/hato {:mvn/version "1.0.0"}
         ring/ring-codec {:mvn/version "1.3.0"}
         ring/ring-jetty-adapter {:mvn/version "1.15.2"}
+        com.github.steffan-westcott/clj-otel-api {:mvn/version "0.2.9"}
+        com.github.steffan-westcott/clj-otel-sdk-extension-autoconfigure {:mvn/version "0.2.9"}
+        com.github.steffan-westcott/clj-otel-exporter-otlp {:mvn/version "0.2.9"}
         camel-snake-kebab/camel-snake-kebab {:mvn/version "0.4.3"}
         org.slf4j/slf4j-simple {:mvn/version "2.0.17"}
         com.googlecode.java-diff-utils/diffutils {:mvn/version "1.3.0"}

docs/configuration.md

@@ -353,6 +353,20 @@ ECA allows to totally customize the prompt sent to LLM via the `behavior` config
     }
     ```
 
+## Opentelemetry integration
+
+To configure, add your OTLP collector config via `:otlp` map following [otlp auto-configure settings](https://opentelemetry.io/docs/languages/java/configuration/#properties-general). Example:
+
+    ```javascript
+    {
+      "otlp": {
+        "otel.exporter.otlp.metrics.protocol": "http/protobuf",
+        "otel.exporter.otlp.metrics.endpoint": "https://my-otlp-endpoint.com/foo",
+        "otel.exporter.otlp.headers": "Authorization=Bearer 123456"
+      }
+    }
+    ```
+
 ## All configs
 
 === "Schema"
@@ -429,6 +443,7 @@ ECA allows to totally customize the prompt sent to LLM via the `behavior` config
                 maxEntriesPerDir?: number;
             };
         };
+        otlp?: {[key: string]: string};
     }
     ```
 

docs/features.md

@@ -111,6 +111,12 @@ Current supported providers with login:
 - `anthropic`: with options to login to Claude Max/Pro or create API keys.
 - `github-copilot`: via Github oauth.
 
+## OpenTelemetry integration
+
+ECA has support for [OpenTelemetry](https://opentelemetry.io/)(otlp), if configured, server tasks, tool calls, and more will be metrified via otlp API.
+
+For more details check [its configuration](./configuration.md#opentelemetry-integration)
+
 ##  Completion
 
 Soon

resources/META-INF/native-image/eca/eca/native-image.properties

@@ -5,6 +5,8 @@ Args=-J-Dborkdude.dynaload.aot=true \
      --enable-url-protocols=jar,http,https \
      --initialize-at-build-time=com.fasterxml.jackson \
      --initialize-at-build-time=org.yaml.snakeyaml \
+     --initialize-at-build-time=io.opentelemetry.api.common.AttributeType \
+     --initialize-at-build-time=io.opentelemetry.api.logs.Severity \
      -H:-CheckToolchain \
      -H:Log=registerResource: \
      -H:IncludeResources=ECA_VERSION \

src/eca/config.clj

@@ -249,7 +249,8 @@
     [:behavior :ANY :toolCall :approval :ask]
     [:behavior :ANY :toolCall :approval :ask :ANY :argsMatchers]
     [:behavior :ANY :toolCall :approval :deny]
-    [:behavior :ANY :toolCall :approval :deny :ANY :argsMatchers]]})
+    [:behavior :ANY :toolCall :approval :deny :ANY :argsMatchers]
+    [:otlp]]})
 
 (defn all [db]
   (let [initialization-config @initialization-config*

src/eca/db.clj

@@ -75,10 +75,9 @@
 (defn ^:private transit-global-db-file []
   (io/file (global-cache-dir) "db.transit.json"))
 
-(defn ^:private read-cache [cache-file]
+(defn ^:private read-cache [cache-file metrics]
   (try
-    (metrics/task
-     :db/read-cache
+    (metrics/task metrics :db/read-cache
      (if (fs/exists? cache-file)
        (let [cache (with-open [is (io/input-stream cache-file)]
                      (transit/read (transit/reader is :json)))]
@@ -88,10 +87,9 @@
     (catch Throwable e
       (logger/error logger-tag "Could not load global cache from DB" e))))
 
-(defn ^:private upsert-cache! [cache cache-file]
+(defn ^:private upsert-cache! [cache cache-file metrics]
   (try
-    (metrics/task
-     :db/upsert-cache
+    (metrics/task metrics :db/upsert-cache
      (io/make-parents cache-file)
       ;; https://github.com/cognitect/transit-clj/issues/43
      (with-open [os ^OutputStream (no-flush-output-stream (io/output-stream cache-file))]
@@ -100,22 +98,22 @@
     (catch Throwable e
       (logger/error logger-tag (str "Could not upsert db cache to " cache-file) e))))
 
-(defn ^:private read-global-cache []
-  (let [cache (read-cache (transit-global-db-file))]
+(defn ^:private read-global-cache [metrics]
+  (let [cache (read-cache (transit-global-db-file) metrics)]
     (when (= version (:version cache))
       cache)))
 
-(defn ^:private read-global-by-workspaces-cache [workspaces]
-  (let [cache (read-cache (transit-global-by-workspaces-db-file workspaces))]
+(defn ^:private read-global-by-workspaces-cache [workspaces metrics]
+  (let [cache (read-cache (transit-global-by-workspaces-db-file workspaces) metrics)]
     (when (= version (:version cache))
       cache)))
 
-(defn load-db-from-cache! [db* config]
+(defn load-db-from-cache! [db* config metrics]
   (when-not (:pureConfig config)
-    (when-let [global-cache (read-global-cache)]
+    (when-let [global-cache (read-global-cache metrics)]
       (logger/info logger-tag "Loading from global-cache caches...")
       (swap! db* shared/deep-merge global-cache))
-    (when-let [global-by-workspace-cache (read-global-by-workspaces-cache (:workspace-folders @db*))]
+    (when-let [global-by-workspace-cache (read-global-by-workspaces-cache (:workspace-folders @db*) metrics)]
       (logger/info logger-tag "Loading from workspace-cache caches...")
       (swap! db* shared/deep-merge global-by-workspace-cache))))
 
@@ -130,12 +128,12 @@
 (defn ^:private normalize-db-for-global-write [db]
   (select-keys db [:auth]))
 
-(defn update-workspaces-cache! [db]
+(defn update-workspaces-cache! [db metrics]
   (-> (normalize-db-for-workspace-write db)
       (assoc :version version)
-      (upsert-cache! (transit-global-by-workspaces-db-file (:workspace-folders db)))))
+      (upsert-cache! (transit-global-by-workspaces-db-file (:workspace-folders db)) metrics)))
 
-(defn update-global-cache! [db]
+(defn update-global-cache! [db metrics]
   (-> (normalize-db-for-global-write db)
       (assoc :version version)
-      (upsert-cache! (transit-global-db-file))))
+      (upsert-cache! (transit-global-db-file) metrics)))

src/eca/features/chat.clj

@@ -32,14 +32,14 @@
     :role role
     :content content}))
 
-(defn finish-chat-prompt! [status {:keys [chat-id db* on-finished-side-effect] :as chat-ctx}]
+(defn finish-chat-prompt! [status {:keys [chat-id db* metrics on-finished-side-effect] :as chat-ctx}]
   (swap! db* assoc-in [:chats chat-id :status] status)
   (send-content! chat-ctx :system
                  {:type :progress
                   :state :finished})
   (when on-finished-side-effect
     (on-finished-side-effect))
-  (db/update-workspaces-cache! @db*))
+  (db/update-workspaces-cache! @db* metrics))
 
 (defn ^:private assert-chat-not-stopped! [{:keys [chat-id db*] :as chat-ctx}]
   (when (identical? :stopping (get-in @db* [:chats chat-id :status]))
@@ -367,7 +367,7 @@
 
 (defn ^:private prompt-messages!
   [user-messages
-   {:keys [db* config chat-id behavior full-model instructions messenger] :as chat-ctx}]
+   {:keys [db* config chat-id behavior full-model instructions messenger metrics] :as chat-ctx}]
   (let [db @db*
         [provider model] (string/split full-model #"/" 2)
         past-messages (get-in db [:chats chat-id :messages] [])
@@ -490,7 +490,7 @@
                                              (delay
                                                (future
                                                  ;; assert: In :executing
-                                                 (let [result (f.tools/call-tool! name arguments db* config messenger behavior chat-id)
+                                                 (let [result (f.tools/call-tool! name arguments behavior chat-id db* config messenger metrics)
                                                        details (f.tools/tool-call-details-after-invocation name arguments details result)
                                                        {:keys [start-time]} (get-tool-call-state @db* chat-id id)]
                                                    (add-to-history! {:role "tool_call"
@@ -631,7 +631,8 @@
   [{:keys [message model behavior contexts chat-id]}
    db*
    messenger
-   config]
+   config
+   metrics]
   (let [message (string/trim message)
         chat-id (or chat-id
                     (let [new-id (str (random-uuid))]
@@ -666,6 +667,7 @@
                   :instructions instructions
                   :full-model full-model
                   :db* db*
+                  :metrics metrics
                   :config config
                   :messenger messenger}
         decision (message->decision message)
@@ -743,6 +745,6 @@
       (finish-chat-prompt! :stopping chat-ctx))))
 
 (defn delete-chat
-  [{:keys [chat-id]} db*]
+  [{:keys [chat-id]} db* metrics]
   (swap! db* update :chats dissoc chat-id)
-  (db/update-workspaces-cache! @db*))
+  (db/update-workspaces-cache! @db* metrics))