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
Add /livez and /readyz endpoints (#64479)
Rodrigo López Datof568cc793b61
diff --git a/src/metabase/server/middleware/log.clj b/src/metabase/server/middleware/log.cljindex 5b4d5cdf10f..e5ea149b966 100644--- a/src/metabase/server/middleware/log.clj+++ b/src/metabase/server/middleware/log.clj@@ -195,12 +195,13 @@"The set of URIs that should not be logged."[](cond-> #{"/api/logger/logs"}- (not (server.settings/health-check-logging-enabled)) (conj "/api/health")))+ (not (server.settings/health-check-logging-enabled)) (into #{"/api/health" "/livez" "/readyz"})))(defn- should-log-request? [{:keys [uri], :as request}]- ;; don't log calls to /health or /logger/logs because they clutter up the logs (especially the window in admin) with- ;; useless lines- (and (request/api-call? request)+ ;; don't log calls to health checks or /logger/logs because they clutter up the logs (especially the window in admin)+ ;; with useless lines+ (and (or (request/api-call? request)+ (contains? #{"/livez" "/readyz"} uri))(not ((logging-disabled-uris) uri))))(defn log-api-calldiff --git a/src/metabase/server/middleware/misc.clj b/src/metabase/server/middleware/misc.cljindex 4426e9bd5a2..947834c158d 100644--- a/src/metabase/server/middleware/misc.clj+++ b/src/metabase/server/middleware/misc.clj@@ -61,7 +61,7 @@(defn- maybe-set-site-url* [{{:strs [origin x-forwarded-host host user-agent]} :headers, uri :uri}](when (and (mdb/db-is-set-up?)(not (system/site-url))- (not= uri "/api/health")+ (not (#{"/api/health" "/livez" "/readyz"} uri))(or (nil? user-agent) ((complement str/includes?) user-agent "HealthChecker")))(when-let [site-url (or origin x-forwarded-host host)](log/infof "Setting Metabase site URL to %s" site-url)diff --git a/src/metabase/server/middleware/ssl.clj b/src/metabase/server/middleware/ssl.cljindex a166220ca2a..6e57ecf6837 100644--- a/src/metabase/server/middleware/ssl.clj+++ b/src/metabase/server/middleware/ssl.clj@@ -12,7 +12,7 @@(def no-redirect-https-uris"The set of URLs that should not be forced to redirect to their HTTPS equivalents"- #{"/api/health"})+ #{"/api/health" "/livez" "/readyz"})(defn- get-request? [{method :request-method}](or (= method :head)diff --git a/src/metabase/server/routes.clj b/src/metabase/server/routes.cljindex d378cca5c85..f54499b63fe 100644--- a/src/metabase/server/routes.clj+++ b/src/metabase/server/routes.clj@@ -60,6 +60,13 @@([_request respond _raise](respond (health-handler))))+(defn- livez-handler+ "Simple liveness probe that does not perform any database checks. Always returns 200 with the+ same body format as `/api/health` when healthy."+ ([] {:status 200, :body {:status "ok"}})+ ([_request respond _raise]+ (respond (livez-handler))))+#_{:clj-kondo/ignore [:discouraged-var]}(defroutes ^:private static-files-handler(GET "/embedding-sdk.js" request@@ -91,6 +98,10 @@(GET "/favicon.ico" [] (response/resource-response (appearance/application-favicon-url)));; ^/api/health -> Health Check Endpoint(GET "/api/health" [] health-handler)+ ;; ^/readyz -> Readiness probe (same implementation as /api/health)+ (GET "/readyz" [] health-handler)+ ;; ^/livez -> Liveness probe (no DB access)+ (GET "/livez" [] livez-handler);; Handle CORS preflight requests for auth routes(OPTIONS "/auth/*" [] {:status 200 :body ""})diff --git a/test/metabase/server/middleware/log_test.clj b/test/metabase/server/middleware/log_test.cljindex e0d2a1c9fa5..02294c578a5 100644--- a/test/metabase/server/middleware/log_test.clj+++ b/test/metabase/server/middleware/log_test.clj@@ -25,7 +25,11 @@(deftest should-log-request?-test(testing "Health check logging can be disabled via env var"(mt/with-temp-env-var-value! [mb-health-check-logging-enabled true]- (is (#'mw.log/should-log-request? {:uri "/api/health"})))+ (is (#'mw.log/should-log-request? {:uri "/api/health"}))+ (is (#'mw.log/should-log-request? {:uri "/livez"}))+ (is (#'mw.log/should-log-request? {:uri "/readyz"})))(mt/with-temp-env-var-value! [mb-health-check-logging-enabled false]- (is (not (#'mw.log/should-log-request? {:uri "/api/health"}))))))+ (is (not (#'mw.log/should-log-request? {:uri "/api/health"})))+ (is (not (#'mw.log/should-log-request? {:uri "/livez"})))+ (is (not (#'mw.log/should-log-request? {:uri "/readyz"}))))))diff --git a/test/metabase/server/middleware/misc_test.clj b/test/metabase/server/middleware/misc_test.cljindex 2c86eb8089e..7d60ec68aec 100644--- a/test/metabase/server/middleware/misc_test.clj+++ b/test/metabase/server/middleware/misc_test.clj@@ -35,9 +35,10 @@(system/site-url)))))))(testing "Site URL should not be inferred from healthcheck requests"(mt/with-temporary-setting-values [site-url nil]- (let [request (mock-request "/api/health" "https://mb1.example.com" nil nil)]- (maybe-set-site-url request)- (is (nil? (system/site-url))))))+ (doseq [uri ["/api/health" "/livez" "/readyz"]]+ (let [request (mock-request uri "https://mb1.example.com" nil nil)]+ (maybe-set-site-url request)+ (is (nil? (system/site-url)))))))(testing "Site URL should not be inferred if already set in DB"(mt/with-temporary-setting-values [site-url "https://mb1.example.com"](let [request (mock-request "/" "https://mb2.example.com" nil nil)]diff --git a/test/metabase/server/middleware/ssl_test.clj b/test/metabase/server/middleware/ssl_test.cljindex 4f72245f7cf..4c6986fdca7 100644--- a/test/metabase/server/middleware/ssl_test.clj+++ b/test/metabase/server/middleware/ssl_test.clj@@ -35,13 +35,15 @@(deftest test-do-not-redirect-healthcheck(testing "does not redirect when disabled"(tu/with-temporary-setting-values [redirect-all-requests-to-https false]- (let [response (handler (ring.mock/request :get "/api/health"))]- (is (= 200 (:status response))))))+ (doseq [uri ["/api/health" "/livez" "/readyz"]]+ (let [response (handler (ring.mock/request :get uri))]+ (is (= 200 (:status response)))))))(testing "does not redirect when enabled"(tu/with-temporary-setting-values [site-url "https://localhost"redirect-all-requests-to-https true]- (let [response (handler (ring.mock/request :get "/api/health"))]- (is (= 200 (:status response)))))))+ (doseq [uri ["/api/health" "/livez" "/readyz"]]+ (let [response (handler (ring.mock/request :get uri))]+ (is (= 200 (:status response))))))))(deftest test-do-not-redirect-loadbalancer-sessions(testing "does not redirect"