Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Strip bloat fields from :tool-output; add logging/metrics around stored metabot message size (#72388)

Noah Mossaf3da5c6b789
diff --git a/src/metabase/analytics/prometheus.clj b/src/metabase/analytics/prometheus.clj
index a7c0a89852c..5165745d1f3 100644
--- a/src/metabase/analytics/prometheus.clj
+++ b/src/metabase/analytics/prometheus.clj
@@ -594,6 +594,11 @@
:labels [:profile-id]
;; 100ms -> 10 minutes
:buckets [100 500 1000 5000 10000 30000 60000 120000 300000 600000]})
+ (prometheus/histogram :metabase-metabot/message-persist-bytes
+ {:description "Size in bytes of persisted metabot message data (JSON)"
+ :labels [:profile-id]
+ ;; 1KB -> 5MB
+ :buckets [1000 5000 10000 50000 100000 500000 1000000 5000000]})
;; release dashboard metrics
(prometheus/counter :metabase-sync/failures
diff --git a/src/metabase/metabot/api.clj b/src/metabase/metabot/api.clj
index fb732e00cf3..037877ee117 100644
--- a/src/metabase/metabot/api.clj
+++ b/src/metabase/metabot/api.clj
@@ -4,6 +4,7 @@
[clojure.core.async :as a]
[clojure.string :as str]
[medley.core :as m]
+ [metabase.analytics.prometheus :as prometheus]
[metabase.api.common :as api]
[metabase.api.macros :as api.macros]
[metabase.api.routes.common :refer [+auth]]
@@ -30,6 +31,7 @@
[metabase.settings.core :as setting]
[metabase.slackbot.api]
[metabase.util :as u]
+ [metabase.util.json :as json]
[metabase.util.log :as log]
[metabase.util.malli :as mu]
[metabase.util.malli.schema :as ms]
@@ -87,6 +89,15 @@
{}
parts))
+(defn- strip-tool-output-bloat
+ "For :tool-output parts, keep only :output in the result map.
+ Both LLM adapters only read (get-in part [:result :output]) when replaying history.
+ Everything else (:structured-output, :resources, :data-parts, :reactions, etc.)
+ is transient runtime data consumed during streaming and can be very large."
+ [{:keys [type] :as part}]
+ (cond-> part
+ (= :tool-output type) (update :result select-keys [:output])))
+
(defn- store-native-parts!
"Store assistant response parts directly to the database.
@@ -104,7 +115,10 @@
;; :data is like `:navigate_to`
content (->> parts
(remove #(#{:start :usage :finish :data} (:type %)))
- vec)]
+ (mapv strip-tool-output-bloat))]
+ (prometheus/observe! :metabase-metabot/message-persist-bytes
+ {:profile-id (or profile-id "unknown")}
+ (u/string-byte-count (json/encode content)))
(t2/with-transaction [_conn]
(when state-part
(app-db/update-or-insert! :model/MetabotConversation {:id conversation-id}
diff --git a/test/metabase/metabot/api_test.clj b/test/metabase/metabot/api_test.clj
index 75d42d45801..84c7d08673e 100644
--- a/test/metabase/metabot/api_test.clj
+++ b/test/metabase/metabot/api_test.clj
@@ -603,6 +603,26 @@
(is (= {:claude-sonnet-4-6 {:prompt 100 :completion 50}}
(:usage msg))))))
+(deftest strip-tool-output-bloat-test
+ (testing "strips transient keys from tool-output results, keeping only :output"
+ (is (= {:type :tool-output :id "call-1" :result {:output "<result>XML</result>"}}
+ (#'api/strip-tool-output-bloat
+ {:type :tool-output
+ :id "call-1"
+ :result {:output "<result>XML</result>"
+ :resources [{:id 1 :name "Orders" :columns [{:field_values [1 2 3]}]}]
+ :structured-output {:result-type :search :data [{:id 1}]}
+ :data-parts [{:type :data :data-type "navigate_to"}]}}))))
+ (testing "leaves non-tool-output parts untouched"
+ (let [text-part {:type :text :text "hello"}]
+ (is (= text-part (#'api/strip-tool-output-bloat text-part)))))
+ (testing "handles result with no :output key"
+ (is (= {:type :tool-output :id "call-2" :result {}}
+ (#'api/strip-tool-output-bloat
+ {:type :tool-output
+ :id "call-2"
+ :result {:structured-output {:some "data"}}})))))
+
(defn- legacy-query
"A legacy inner-query-style map suitable for [[#'api/upgrade-viewing-queries]]."
[]