The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
security-center prometheus metrics (#73730)
Nicola Mometto9035538f3056
diff --git a/.clj-kondo/config/modules/config.edn b/.clj-kondo/config/modules/config.ednindex 779a50871e2..f343247aba0 100644--- a/.clj-kondo/config/modules/config.edn+++ b/.clj-kondo/config/modules/config.edn@@ -3261,6 +3261,7 @@:api #{metabase-enterprise.security-center.apimetabase-enterprise.security-center.init}:uses #{analytics+ analytics-interfaceapiapp-dbchanneldiff --git a/docs/installation-and-operation/observability-with-prometheus.md b/docs/installation-and-operation/observability-with-prometheus.mdindex 80668414b23..08627a07739 100644--- a/docs/installation-and-operation/observability-with-prometheus.md+++ b/docs/installation-and-operation/observability-with-prometheus.md@@ -162,6 +162,8 @@ Metrics exported by Metabase include:- `metabase_email_messages_created`- `metabase_email_message_errors_total`- `metabase_email_message_errors_created`+- `metabase_security_center_last_sync_timestamp_seconds`+- `metabase_security_center_vulnerable_advisories`## Further readingdiff --git a/enterprise/backend/src/metabase_enterprise/security_center/init.clj b/enterprise/backend/src/metabase_enterprise/security_center/init.cljindex 89dd33f1fae..17d6ad93cf1 100644--- a/enterprise/backend/src/metabase_enterprise/security_center/init.clj+++ b/enterprise/backend/src/metabase_enterprise/security_center/init.clj@@ -1,9 +1,11 @@(ns metabase-enterprise.security-center.init(:require+ [metabase-enterprise.security-center.metrics][metabase-enterprise.security-center.models.security-advisory][metabase-enterprise.security-center.settings][metabase-enterprise.security-center.task.sync-advisories]))-(comment metabase-enterprise.security-center.models.security-advisory/keep-me+(comment metabase-enterprise.security-center.metrics/keep-me+ metabase-enterprise.security-center.models.security-advisory/keep-memetabase-enterprise.security-center.settings/keep-memetabase-enterprise.security-center.task.sync-advisories/keep-me)diff --git a/enterprise/backend/src/metabase_enterprise/security_center/metrics.clj b/enterprise/backend/src/metabase_enterprise/security_center/metrics.cljnew file mode 100644index 00000000000..8f9cd5149bb--- /dev/null+++ b/enterprise/backend/src/metabase_enterprise/security_center/metrics.clj@@ -0,0 +1,65 @@+(ns metabase-enterprise.security-center.metrics+ "Prometheus metrics for the Security Center: advisory feed freshness and+ vulnerability counts. Exposed so operators can alert when advisories stop+ syncing or when vulnerabilities are present."+ (:require+ [metabase-enterprise.security-center.settings :as settings]+ [metabase.analytics-interface.core :as analytics]+ [metabase.analytics.core :as analytics.core]+ [metabase.util.log :as log]+ [toucan2.core :as t2])+ (:import+ (java.time.temporal Temporal ChronoField)))++(set! *warn-on-reflection* true)++(def ^:private severities [:critical :high :medium :low])++(def ^:private vulnerable-statuses #{:active :error})++(defn- label-of [severity ack?]+ {:severity (name severity)+ :acknowledged (str ack?)})++(def ^:private vulnerable-advisory-labels+ (vec (for [severity severities+ ack? [true false]]+ (label-of severity ack?))))++(defmethod analytics.core/known-labels :metabase-security-center/vulnerable-advisories+ [_]+ vulnerable-advisory-labels)++(defn- last-sync-epoch-seconds+ "Read the last-synced-at setting and convert to Unix epoch seconds, or nil if+ no sync has ever completed."+ []+ (when-let [^Temporal t (settings/security-center-last-synced-at)]+ (.getLong t ChronoField/INSTANT_SECONDS)))++(defn- vulnerable-counts+ "Return a map of [severity acknowledged?] → count for advisories whose+ match_status places them in the vulnerable bucket."+ []+ (->> (t2/reducible-select [:model/SecurityAdvisory :severity :acknowledged_at]+ :match_status [:in vulnerable-statuses])+ (reduce (fn [acc {:keys [severity acknowledged_at]}]+ (update acc (label-of severity (some? acknowledged_at)) (fnil inc 0)))+ {})))++(defn refresh-metrics!+ "Recompute and set Security Center Prometheus gauges from the appdb."+ []+ (try+ (when-let [epoch (last-sync-epoch-seconds)]+ (analytics/set-gauge! :metabase-security-center/last-sync-timestamp-seconds epoch))+ (catch Exception e+ (log/warn e "Failed to set :metabase-security-center/last-sync-timestamp-seconds metric")))+ (try+ (let [counts (vulnerable-counts)]+ (doseq [label vulnerable-advisory-labels]+ (analytics/set-gauge! :metabase-security-center/vulnerable-advisories+ label+ (get counts label 0))))+ (catch Exception e+ (log/warn e "Failed to set :metabase-security-center/vulnerable-advisories metric"))))diff --git a/enterprise/backend/src/metabase_enterprise/security_center/task/sync_advisories.clj b/enterprise/backend/src/metabase_enterprise/security_center/task/sync_advisories.cljindex af379a2196c..3eba542c350 100644--- a/enterprise/backend/src/metabase_enterprise/security_center/task/sync_advisories.clj+++ b/enterprise/backend/src/metabase_enterprise/security_center/task/sync_advisories.clj@@ -9,6 +9,7 @@[java-time.api :as t][metabase-enterprise.security-center.fetch :as fetch][metabase-enterprise.security-center.matching :as matching]+ [metabase-enterprise.security-center.metrics :as metrics][metabase-enterprise.security-center.notification :as notification][metabase-enterprise.security-center.settings :as settings][metabase.premium-features.core :as premium-features]@@ -63,6 +64,7 @@(log/info "Syncing security advisories")(try(fetch/sync-advisories!)+ (settings/security-center-last-synced-at! (t/offset-date-time))(catch Exception e(log/warn e "Error fetching advisories from HM")))(try@@ -73,7 +75,7 @@(send-repeat-notifications!)(catch Exception e(log/warn e "Error sending repeat notifications")))- (settings/security-center-last-synced-at! (t/offset-date-time))))+ (metrics/refresh-metrics!)))(task/defjob ^{:doc "Periodically fetch and re-evaluate security advisories."DisallowConcurrentExecution true} SyncAdvisories [_]@@ -95,6 +97,9 @@(cron/cron-schedule cron-str)(cron/with-misfire-handling-instruction-do-nothing))))](task/schedule-task! job trigger)+ ;; Populate metrics from existing appdb state so freshness and vulnerability+ ;; gauges survive restarts without waiting for the next scheduled sync.+ (metrics/refresh-metrics!);; on first run of the feature, we sync immediately to seed advisories(when-not (settings/security-center-last-synced-at)(task/trigger-now! (jobs/key job-key))))))diff --git a/enterprise/backend/test/metabase_enterprise/security_center/metrics_test.clj b/enterprise/backend/test/metabase_enterprise/security_center/metrics_test.cljnew file mode 100644index 00000000000..a0fcf98f203--- /dev/null+++ b/enterprise/backend/test/metabase_enterprise/security_center/metrics_test.clj@@ -0,0 +1,100 @@+(ns metabase-enterprise.security-center.metrics-test+ (:require+ [clojure.test :refer :all]+ [java-time.api :as t]+ [metabase-enterprise.security-center.metrics :as metrics]+ [metabase.test :as mt]+ [metabase.test.fixtures :as fixtures]))++(set! *warn-on-reflection* true)++(use-fixtures :once (fixtures/initialize :test-users))++(defn- advisory+ [overrides]+ (merge {:title "x"+ :description "x"+ :remediation "x"+ :affected_versions []+ :published_at #t "2026-04-01T00:00:00Z"+ :updated_at #t "2026-04-01T00:00:00Z"}+ overrides))++(deftest refresh-metrics!-vulnerable-advisories-test+ (testing "vulnerable-advisories gauge counts active+error advisories grouped by severity and acknowledgement"+ (mt/with-premium-features #{:admin-security-center}+ (mt/with-prometheus-system! [_ system]+ (mt/with-temp [:model/SecurityAdvisory _ (advisory {:advisory_id "SC-METRIC-CRIT-UNACK"+ :severity "critical"+ :match_status "active"})+ :model/SecurityAdvisory _ (advisory {:advisory_id "SC-METRIC-CRIT-ACK"+ :severity "critical"+ :match_status "active"+ :acknowledged_at #t "2026-04-02T00:00:00Z"+ :acknowledged_by (mt/user->id :crowberto)})+ ;; :error is treated as a vulnerability (matching query couldn't verify)+ :model/SecurityAdvisory _ (advisory {:advisory_id "SC-METRIC-HIGH-ERR"+ :severity "high"+ :match_status "error"})+ :model/SecurityAdvisory _ (advisory {:advisory_id "SC-METRIC-MED-RESOLVED"+ :severity "medium"+ :match_status "resolved"})+ :model/SecurityAdvisory _ (advisory {:advisory_id "SC-METRIC-LOW-NOT-AFFECTED"+ :severity "low"+ :match_status "not_affected"})]+ (metrics/refresh-metrics!)+ (testing "critical: 1 unacked active"+ (is (= 1.0 (mt/metric-value system :metabase-security-center/vulnerable-advisories+ {:severity "critical" :acknowledged "false"}))))+ (testing "critical: 1 acked active"+ (is (= 1.0 (mt/metric-value system :metabase-security-center/vulnerable-advisories+ {:severity "critical" :acknowledged "true"}))))+ (testing "high: 1 unacked error"+ (is (= 1.0 (mt/metric-value system :metabase-security-center/vulnerable-advisories+ {:severity "high" :acknowledged "false"}))))+ (testing "high: 0 acked"+ (is (= 0.0 (mt/metric-value system :metabase-security-center/vulnerable-advisories+ {:severity "high" :acknowledged "true"}))))+ (testing "resolved/not_affected do not count as vulnerable"+ (is (= 0.0 (mt/metric-value system :metabase-security-center/vulnerable-advisories+ {:severity "medium" :acknowledged "false"})))+ (is (= 0.0 (mt/metric-value system :metabase-security-center/vulnerable-advisories+ {:severity "low" :acknowledged "false"})))))))))++(deftest refresh-metrics!-clears-stale-counts-test+ (testing "set-gauge! is called for every (severity, acknowledged) pair so counts that drop to 0 are observable"+ (mt/with-premium-features #{:admin-security-center}+ (mt/with-prometheus-system! [_ system]+ (mt/with-temp [:model/SecurityAdvisory _ (advisory {:advisory_id "SC-METRIC-STALE"+ :severity "critical"+ :match_status "active"})]+ (metrics/refresh-metrics!)+ (is (= 1.0 (mt/metric-value system :metabase-security-center/vulnerable-advisories+ {:severity "critical" :acknowledged "false"}))))+ ;; advisory is gone now (with-temp cleaned up) — refresh should set the gauge back to 0+ (metrics/refresh-metrics!)+ (is (= 0.0 (mt/metric-value system :metabase-security-center/vulnerable-advisories+ {:severity "critical" :acknowledged "false"})))))))++(deftest refresh-metrics!-last-sync-timestamp-test+ (testing "last-sync-timestamp-seconds gauge reflects the security-center-last-synced-at setting"+ (mt/with-premium-features #{:admin-security-center}+ (mt/with-prometheus-system! [_ system]+ (testing "no sync yet → gauge stays at 0 (initial value)"+ (mt/with-temporary-setting-values [security-center-last-synced-at nil]+ (metrics/refresh-metrics!)+ (is (= 0.0 (mt/metric-value system :metabase-security-center/last-sync-timestamp-seconds)))))+ (testing "after a sync → gauge is the unix epoch seconds of the setting"+ (let [ts (t/offset-date-time 2026 5 6 12 0 0 0 (t/zone-offset 0))]+ (mt/with-temporary-setting-values [security-center-last-synced-at ts]+ (metrics/refresh-metrics!)+ (is (= (double (.toEpochSecond ts))+ (mt/metric-value system :metabase-security-center/last-sync-timestamp-seconds))))))))))++(deftest known-labels-test+ (testing "all 4×2 severity × acknowledged combinations are enumerated for initial-value seeding"+ (let [labels (set @#'metrics/vulnerable-advisory-labels)]+ (is (= 8 (count labels)))+ (doseq [severity ["critical" "high" "medium" "low"]+ ack ["true" "false"]]+ (is (contains? labels {:severity severity :acknowledged ack}))))))diff --git a/enterprise/backend/test/metabase_enterprise/security_center/task/sync_advisories_test.clj b/enterprise/backend/test/metabase_enterprise/security_center/task/sync_advisories_test.cljindex 3c0a2af6e6c..6181b54cd39 100644--- a/enterprise/backend/test/metabase_enterprise/security_center/task/sync_advisories_test.clj+++ b/enterprise/backend/test/metabase_enterprise/security_center/task/sync_advisories_test.clj@@ -3,6 +3,7 @@[clojure.test :refer :all][metabase-enterprise.security-center.fetch :as fetch][metabase-enterprise.security-center.matching :as matching]+ [metabase-enterprise.security-center.settings :as settings][metabase-enterprise.security-center.task.sync-advisories :as sync-advisories][metabase.config.core :as config][metabase.premium-features.core :as premium-features]@@ -36,6 +37,38 @@(#'sync-advisories/sync-and-evaluate!)(is (= [:evaluate] @called)))))))+(deftest sync-and-evaluate-last-synced-at-test+ (testing "security-center-last-synced-at is bumped only when fetch/sync-advisories! succeeds"+ (mt/with-premium-features #{:admin-security-center}+ (testing "successful fetch updates the setting"+ (mt/with-temporary-setting-values [security-center-last-synced-at nil]+ (mt/with-dynamic-fn-redefs [premium-features/security-center-enabled? (constantly true)+ fetch/sync-advisories! (constantly nil)+ matching/evaluate-all-advisories! (constantly nil)]+ (#'sync-advisories/sync-and-evaluate!)+ (is (some? (settings/security-center-last-synced-at))+ "fetch succeeded, so last-synced-at should be set"))))+ (testing "failed fetch leaves the setting untouched"+ ;; If a previous sync succeeded the setting holds that older timestamp;+ ;; a subsequent failed fetch must not overwrite it (otherwise the+ ;; freshness gauge tracks 'last attempt' rather than 'last success'+ ;; and alerts on stale advisories would never fire).+ (let [previous #t "2026-01-01T00:00:00Z"]+ (mt/with-temporary-setting-values [security-center-last-synced-at previous]+ (mt/with-dynamic-fn-redefs [premium-features/security-center-enabled? (constantly true)+ fetch/sync-advisories! #(throw (Exception. "HM unreachable"))+ matching/evaluate-all-advisories! (constantly nil)]+ (#'sync-advisories/sync-and-evaluate!)+ (is (= previous (settings/security-center-last-synced-at))+ "fetch failed, so last-synced-at must not be advanced")))))+ (testing "failed fetch on a never-synced instance keeps the setting nil"+ (mt/with-temporary-setting-values [security-center-last-synced-at nil]+ (mt/with-dynamic-fn-redefs [premium-features/security-center-enabled? (constantly true)+ fetch/sync-advisories! #(throw (Exception. "HM unreachable"))+ matching/evaluate-all-advisories! (constantly nil)]+ (#'sync-advisories/sync-and-evaluate!)+ (is (nil? (settings/security-center-last-synced-at)))))))))+(deftest sync-and-evaluate-e2e-test(testing "full flow: sync-and-evaluate! runs matching queries and updates match_status"(with-redefs [config/mb-version-info {:tag "v1.55.0"}]diff --git a/src/metabase/analytics/prometheus.clj b/src/metabase/analytics/prometheus.cljindex bfffc4645c9..dd914385e1a 100644--- a/src/metabase/analytics/prometheus.clj+++ b/src/metabase/analytics/prometheus.clj@@ -684,7 +684,13 @@:labels [:experiment]})(prometheus/counter :experiment/candidate-error-duration-ms{:description "Cumulative duration in milliseconds of experiment candidate code path when it threw."- :labels [:experiment]})])+ :labels [:experiment]})+ ;; security center metrics+ (prometheus/gauge :metabase-security-center/last-sync-timestamp-seconds+ {:description "Unix timestamp (seconds since epoch) of the last successful Security Center."})+ (prometheus/gauge :metabase-security-center/vulnerable-advisories+ {:description "Number of advisories where this Metabase instance is potentially affected."+ :labels [:severity :acknowledged]})])(defn- quartz-collectors[]