Skip to content

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

Validate analytics keys (#83812)

Nathan Voxland33932d7ab855
diff --git a/src/metabase/analytics/api.clj b/src/metabase/analytics/api.clj
index e818fcde97d..71a86b731ec 100644
--- a/src/metabase/analytics/api.clj
+++ b/src/metabase/analytics/api.clj
@@ -1,5 +1,6 @@
(ns metabase.analytics.api
(:require
+ [metabase.analytics-interface.core :as analytics.interface]
[metabase.analytics.prometheus :as prometheus]
[metabase.analytics.stats :as stats]
[metabase.api.macros :as api.macros]
@@ -20,26 +21,53 @@
(perms/check-has-application-permission :monitoring)
(stats/legacy-anonymous-usage-stats))
+(def ^:private frontend-metrics
+ "Metrics the browser is allowed to report through `POST /internal`. No frontend code reports metrics today, so
+ this is empty and the endpoint ignores every event.
+
+ To let the frontend report a counter, make sure it is defined in `metabase.analytics.prometheus`, then map it to its
+ labels: each label key to the set of values the browser may send for it. A metric with no labels maps to `{}`.
+ Value sets are required because Prometheus keeps a time series for every distinct label value forever, so accepting
+ arbitrary strings from any logged-in user would let them grow memory without bound.
+
+ {:experiment/runs-total {:experiment #{\"my-experiment\"}}
+ :my-module/clicks-total {}}"
+ {})
+
+(def ^:private max-events-per-batch
+ "The frontend buffers at most [[analytics.interface/frontend-buffer-capacity]] events plus one dropped-count event
+ per flush."
+ (inc analytics.interface/frontend-buffer-capacity))
+
(def ^:private InternalAnalyticsEvent
[:map {:closed true}
- [:op [:enum :inc :dec :set :observe :clear]]
+ [:op [:= :inc]]
[:metric :keyword]
- [:labels {:optional true} [:maybe (ms/string-keyed-map :string)]]
+ [:labels {:optional true} [:maybe (ms/string-keyed-map [:string {:max 200}])]]
[:amount {:optional true} [:maybe number?]]])
+(defn- allowed-event?
+ "Only positive increments of [[frontend-metrics]], with exactly that metric's label keys and only allowed label
+ values, are accepted."
+ [{:keys [metric labels amount]}]
+ (let [allowed-labels (get frontend-metrics metric)]
+ (and (some? allowed-labels)
+ (= (set (keys allowed-labels)) (set (keys labels)))
+ (every? (fn [[label-key value]] (contains? (get allowed-labels label-key) value)) labels)
+ (or (nil? amount) (pos? amount)))))
+
(api.macros/defendpoint :post "/internal" :- :nil
- "Receive a batch of internal analytics events from the frontend and record them as Prometheus metrics."
+ "Receive a batch of internal analytics events from the frontend and record them as Prometheus metrics. Only the
+ counters in [[frontend-metrics]] can be incremented; other events are ignored."
[_route-params
_query-params
- {:keys [events]} :- [:map {:closed true} [:events [:sequential InternalAnalyticsEvent]]]]
- (doseq [{:keys [op metric labels amount]} events
- :let [labels (some-> labels (update-keys keyword))]]
- (try
- (case op
- :inc (prometheus/inc! metric labels (or amount 1))
- :dec (prometheus/dec! metric labels (or amount 1))
- :set (prometheus/set! metric labels amount)
- :observe (prometheus/observe! metric labels (or amount 1))
- :clear (prometheus/clear! metric))
- (catch Exception e
- (log/warnf "Failed to record internal analytics event %s %s: %s" op metric (ex-message e))))))
+ {:keys [events]} :- [:map {:closed true}
+ [:events [:sequential {:max max-events-per-batch} InternalAnalyticsEvent]]]]
+ (doseq [event events
+ :let [{:keys [op metric labels amount] :as event} (update event :labels #(some-> % (update-keys keyword)))]]
+ (if-not (allowed-event? event)
+ (log/debugf "Ignoring disallowed internal analytics event %s %s" op metric)
+ (try
+ (prometheus/inc! metric labels (or amount 1))
+ (catch Exception e
+ (log/warnf "Failed to record internal analytics event %s %s: %s" op metric (ex-message e)))))))
diff --git a/src/metabase/analytics/impl.cljs b/src/metabase/analytics/impl.cljs
index c2664f577ea..2920bcfff03 100644
--- a/src/metabase/analytics/impl.cljs
+++ b/src/metabase/analytics/impl.cljs
@@ -13,7 +13,7 @@
(def ^:private flush-interval-ms 5000)
-(def ^:private buffer-capacity 1000)
+(def ^:private buffer-capacity analytics.interface/frontend-buffer-capacity)
(def ^:private dropped-metric :metabase-frontend/analytics-events-dropped)
@@ -57,6 +57,13 @@
[event]
(swap! state enqueue event buffer-capacity))
+;; The backend only accepts counter increments from the browser, so fail loudly rather than buffer events it would
+;; silently ignore.
+(defn- unsupported-op
+ [op metric]
+ (ex-info (str "The frontend analytics reporter only supports inc!, not " (name op))
+ {:op op :metric metric}))
+
(analytics.interface/set-reporter!
(reify analytics.interface/Reporter
(-inc! [_ metric labels amount]
@@ -64,21 +71,11 @@
:metric metric
:labels labels
:amount amount}))
- (-dec-gauge! [_ metric labels amount]
- (buffer-event! {:op :dec
- :metric metric
- :labels labels
- :amount amount}))
- (-set-gauge! [_ metric labels amount]
- (buffer-event! {:op :set
- :metric metric
- :labels labels
- :amount amount}))
- (-observe! [_ metric labels amount]
- (buffer-event! {:op :observe
- :metric metric
- :labels labels
- :amount amount}))
+ (-dec-gauge! [_ metric _labels _amount]
+ (throw (unsupported-op :dec-gauge! metric)))
+ (-set-gauge! [_ metric _labels _amount]
+ (throw (unsupported-op :set-gauge! metric)))
+ (-observe! [_ metric _labels _amount]
+ (throw (unsupported-op :observe! metric)))
(-clear! [_ metric]
- (buffer-event! {:op :clear
- :metric metric}))))
+ (throw (unsupported-op :clear! metric)))))
diff --git a/src/metabase/analytics_interface/core.cljc b/src/metabase/analytics_interface/core.cljc
index 73120644e48..460a515d796 100644
--- a/src/metabase/analytics_interface/core.cljc
+++ b/src/metabase/analytics_interface/core.cljc
@@ -23,6 +23,11 @@
(analytics/set-gauge! :my-gauge/current-value 10)
(analytics/dec-gauge! :my-gauge/active-count)")
+(def frontend-buffer-capacity
+ "Maximum number of events the CLJS reporter buffers between flushes. The backend sizes its per-request batch limit
+ from this, so both sides share one definition."
+ 1000)
+
(defprotocol Reporter
(-inc! [this metric labels amount]
"Increment a counter metric.")
diff --git a/test/metabase/analytics/api_test.clj b/test/metabase/analytics/api_test.clj
index f24bf1ad4aa..386c20888e3 100644
--- a/test/metabase/analytics/api_test.clj
+++ b/test/metabase/analytics/api_test.clj
@@ -1,7 +1,10 @@
(ns metabase.analytics.api-test
"See also [[metabase-enterprise.advanced-permissions.api.monitoring-test/anonymous-stats-permission-test]]"
(:require
+ [clojure.string :as str]
[clojure.test :refer :all]
+ [metabase.analytics.api :as analytics.api]
+ [metabase.analytics.prometheus :as prometheus]
[metabase.test :as mt]))
(deftest ^:parallel permissions-test
@@ -12,15 +15,90 @@
(testing "Call successful for superusers"
(is (map? (mt/user-http-request :crowberto :get 200 "analytics/anonymous-stats"))))))
-(deftest ^:parallel internal-analytics-test
+(def ^:private test-frontend-metrics
+ {:experiment/runs-total {:experiment #{"my-exp" "e"}}
+ :experiment/control-duration-ms {:experiment #{"my-exp" "e"}}
+ :metabase-frontend/analytics-events-dropped {}})
+
+(defn- post-events! [events]
+ (with-redefs [analytics.api/frontend-metrics test-frontend-metrics]
+ (mt/user-http-request :rasta :post 204 "analytics/internal" {:events events})))
+
+(deftest internal-analytics-records-frontend-metrics-test
+ (testing "POST /api/analytics/internal records the counters the frontend reports"
+ (mt/with-prometheus-system! [_ system]
+ (is (nil? (post-events! [{:op :inc :metric :experiment/runs-total :labels {:experiment "my-exp"} :amount 1}
+ {:op :inc :metric :experiment/runs-total :labels {:experiment "my-exp"}}
+ {:op :inc :metric :experiment/control-duration-ms :labels {:experiment "my-exp"} :amount 2.5}
+ {:op :inc :metric :metabase-frontend/analytics-events-dropped :labels nil :amount 3}])))
+ (is (= 2.0 (mt/metric-value system :experiment/runs-total {:experiment "my-exp"})))
+ (is (= 2.5 (mt/metric-value system :experiment/control-duration-ms {:experiment "my-exp"})))
+ (is (= 3.0 (mt/metric-value system :metabase-frontend/analytics-events-dropped))))))
+
+(deftest internal-analytics-cannot-touch-server-metrics-test
+ (testing "POST /api/analytics/internal ignores metrics the frontend does not own"
+ (mt/with-prometheus-system! [_ system]
+ (prometheus/inc! :metabase-email/messages nil 5)
+ (post-events! [{:op :inc :metric :metabase-email/messages :amount 100}])
+ (is (= 5.0 (mt/metric-value system :metabase-email/messages))))))
+
+(deftest internal-analytics-only-increments-frontend-metrics-test
+ (testing "POST /api/analytics/internal only allows positive increments on frontend metrics"
+ (mt/with-prometheus-system! [_ system]
+ (post-events! [{:op :inc :metric :experiment/runs-total :labels {:experiment "e"} :amount 4}])
+ (post-events! [{:op :inc :metric :experiment/runs-total :labels {:experiment "e"} :amount -1}])
+ (is (= 4.0 (mt/metric-value system :experiment/runs-total {:experiment "e"}))))))
+
+(deftest internal-analytics-rejects-non-inc-ops-test
+ (testing "POST /api/analytics/internal rejects any op other than :inc"
+ (doseq [op [:dec :set :observe :clear]]
+ (mt/user-http-request :rasta :post 400 "analytics/internal"
+ {:events [{:op op :metric :experiment/runs-total :labels {:experiment "e"} :amount 1}]}))))
+
+(deftest internal-analytics-blocks-everything-by-default-test
+ (testing "No frontend code reports metrics yet, so the real allowlist is empty"
+ (is (= {} @#'analytics.api/frontend-metrics))
+ (mt/with-prometheus-system! [_ system]
+ (mt/user-http-request :rasta :post 204 "analytics/internal"
+ {:events [{:op :inc :metric :experiment/runs-total :labels {:experiment "e"}}
+ {:op :inc :metric :metabase-frontend/analytics-events-dropped :amount 3}]})
+ (is (= 0.0 (mt/metric-value system :experiment/runs-total {:experiment "e"})))
+ (is (= 0.0 (mt/metric-value system :metabase-frontend/analytics-events-dropped))))))
+
+(deftest internal-analytics-rejects-undeclared-labels-test
+ (testing "POST /api/analytics/internal ignores events whose label keys don't match the metric's labels"
+ (mt/with-prometheus-system! [_ system]
+ (post-events! [{:op :inc :metric :experiment/runs-total :labels {:experiment "e" :bogus "x"}}
+ {:op :inc :metric :experiment/runs-total :labels {:bogus "x"}}
+ {:op :inc :metric :experiment/runs-total}
+ {:op :inc :metric :metabase-frontend/analytics-events-dropped :labels {:bogus "x"}}])
+ (is (= 0.0 (mt/metric-value system :experiment/runs-total {:experiment "e"})))
+ (is (= 0.0 (mt/metric-value system :experiment/runs-total {:experiment ""})))
+ (is (= 0.0 (mt/metric-value system :metabase-frontend/analytics-events-dropped))))))
+
+(deftest internal-analytics-ignores-unknown-label-values-test
+ (testing "POST /api/analytics/internal does not record label values missing from the allowlist"
+ (mt/with-prometheus-system! [_ system]
+ (post-events! [{:op :inc :metric :experiment/runs-total :labels {:experiment "attacker-chosen"}}])
+ (is (= 0.0 (mt/metric-value system :experiment/runs-total {:experiment "attacker-chosen"}))))))
+
+(deftest internal-analytics-ignores-oversized-label-values-test
+ (testing "POST /api/analytics/internal does not record events with oversized label values"
+ (mt/with-prometheus-system! [_ system]
+ (let [long-name (str/join (repeat 1000 "x"))]
+ (post-events! [{:op :inc :metric :experiment/runs-total :labels {:experiment long-name}}])
+ (is (= 0.0 (mt/metric-value system :experiment/runs-total {:experiment long-name})))
+ (is (= 0.0 (mt/metric-value system :experiment/runs-total {:experiment ""})))))))
+
+(deftest ^:parallel internal-analytics-payload-bounds-test
(testing "POST /api/analytics/internal"
- (testing "accepts a valid batch of events"
- (is (nil? (mt/user-http-request :crowberto :post 204 "analytics/internal"
- {:events [{:op :inc :metric :test/counter :labels {:x "y"} :amount 1}
- {:op :observe :metric :test/histogram :amount 42}]}))))
(testing "rejects invalid payload"
(mt/user-http-request :rasta :post 400 "analytics/internal"
{:events [{:op :bad :metric :test/counter}]}))
(testing "rejects missing events key"
(mt/user-http-request :rasta :post 400 "analytics/internal"
- {:not-events []}))))
+ {:not-events []}))
+ (testing "rejects oversized batches"
+ (mt/user-http-request :rasta :post 400 "analytics/internal"
+ {:events (repeat 5000 {:op :inc :metric :experiment/runs-total
+ :labels {:experiment "e"}})}))))