refactor: fallback between sentry and telemere

style: rm secrets

squash: rm commit with secrets

Author: J0sueTM

docker/docker-compose.yml

@@ -5,3 +5,16 @@ services:
       - "6379:6379"
     volumes:
       - ./redis:/redis
+
+  # https://docs.localstack.cloud/user-guide/aws/s3/#s3-docker-image
+  localstack:
+    image: localstack/localstack:s3-latest
+    ports:
+      - "127.0.0.1:4566:4566" # Gateway
+    environment:
+      - AWS_ACCESS_KEY_ID="foo"
+      - AWS_SECRET_ACCESS_KEY="bar"
+      - AWS_DEFAULT_REGION=us-east-1
+      - DEBUG=${DEBUG:-1}
+    volumes:
+      - "${LOCALSTACK_DIR:-./localstack}:/var/lib/localstack"

resources/config.example.edn

@@ -3,6 +3,7 @@
                 :default :dev
                 :prod :prod}
  :release "1.0.0"
+ :logger {:min-level :info}
  :moclojer {:config-path #profile {:default "resources/moclojer.yml"
                                    :prod "moclojer.yml"}
             :join? #profile {:default false
@@ -25,7 +26,8 @@
  :opensearch {:username #or [#env OPENSEARCH_USERNAME "foobar"]
               :password #or [#env OPENSEARCH_PASSWORD "foobar"]
               :host #or [#env OPENSEARCH_HOST "foobar.com"]
-              :port #or [#env OPENSEARCH_PORT 00000]}
+              :port #or [#env OPENSEARCH_PORT 00000]
+              :index "my-logs"}
  :mq  {:uri #or [#env MQ_URL "redis://localhost:6379"]}
  :database {:dbtype "postgres"
             :jdbc-url #or [#env DATABASE_URL "postgresql://localhost:5432/postgres?user=postgres&password=postgres"]}}

src/com/moclojer/components/core.clj

@@ -17,7 +17,9 @@
   ([filepath input-map]
    (config/map->Config {:config (config/read-config filepath input-map)})))
 
-(def setup-logger logs/setup)
+(defn new-logger
+  []
+  (logs/map->Logger {}))
 
 (defn new-database []
   (database/map->Database {}))

src/com/moclojer/components/database.clj

@@ -13,8 +13,7 @@
   "Builds a simple logger for debugging purposes."
   [ctx]
   (fn [operation query]
-    (logs/log :info operation
-              :ctx (assoc ctx :query query))))
+    (logs/log :info operation (assoc ctx :query query))))
 
 (defprotocol DatabaseProvider
   (execute [self command ctx]
@@ -24,7 +23,7 @@
   component/Lifecycle
   (start [this]
     (let [{:keys [jdbc-url]} (get-in config [:config :database])]
-      (logs/log :info "starting database")
+      (logs/log :info "starting database" (select-keys config [:env]))
       (if datasource
         this
         (assoc this :datasource (connection/->pool HikariDataSource {:jdbcUrl (to-jdbc-uri jdbc-url)})))))

src/com/moclojer/components/http.clj

@@ -38,15 +38,15 @@
   (request
     [_ {:keys [method url] :as request-input} ctx]
     (logs/log :info "sending http request"
-              :ctx (merge ctx {:method method
-                               :url url}))
+              (merge ctx {:method method
+                          :url url}))
     (let [start-time (System/currentTimeMillis)
           {:keys [status] :as response} (request-fn request-input)
           end-time (System/currentTimeMillis)
           total-time (- end-time start-time)]
       (logs/log :info "received http response"
-                :ctx (merge ctx {:response-time-millis total-time
-                                 :status status}))
+                (merge ctx {:response-time-millis total-time
+                            :status status}))
       response))
   (request-or-throw
     [this req expected-status ctx]
@@ -55,9 +55,9 @@
         resp
         (do
           (logs/log :error "failed critical request. throwing..."
-                    :ctx (merge ctx {:url (:url req)
-                                     :status status
-                                     :expected-status expected-status}))
+                    (merge ctx {:url (:url req)
+                                :status status
+                                :expected-status expected-status}))
           (throw (ex-info "failed critical request"
                           (merge ctx {:status status
                                       :expected-status expected-status
@@ -90,9 +90,7 @@
                    first :response
                    (or {:status 500
                         :body "mocked response not set"}))]
-      (logs/log :info "sending http request"
-                :ctx (merge ctx mreq))
-
+      (logs/log :info "sending http request" (merge ctx mreq))
       (assoc
        (if (fn? resp) (resp req) resp)
        :instant (System/currentTimeMillis))))
@@ -103,9 +101,9 @@
         resp
         (do
           (logs/log :error "failed critical request. throwing..."
-                    :ctx (merge ctx {:url (:url req)
-                                     :status status
-                                     :expected-status expected-status}))
+                    (merge ctx {:url (:url req)
+                                :status status
+                                :expected-status expected-status}))
           (throw (ex-info "failed critical request"
                           (merge ctx {:status status
                                       :expected-status expected-status

src/com/moclojer/components/logs.clj

@@ -1,16 +1,27 @@
 (ns com.moclojer.components.logs
   (:require
+   [com.moclojer.components.logs :as logs]
+   [com.stuartsierra.component :as component]
    [clojure.core.async :as async]
    [clojure.data.json :as json]
    [clj-http.client :as http-client]
-   [com.moclojer.components.sentry :as sentry]
    [taoensso.telemere :as t])
-  (:import [clojure.core.async.impl.channels ManyToManyChannel]))
-
-(defn send-sentry-evt-from-req! [req ex]
-  (if-let [sentry-cmp (get-in req [:components :sentry])]
-    (sentry/send-event! sentry-cmp {:throwable ex})
-    (prn :error "failed to send sentry event (nil component)")))
+  (:import
+   [clojure.core.async.impl.channels ManyToManyChannel]))
+
+(let [log! (t/handler:console nil)]
+  (defn log-console!
+    "Uses telemere's console logger explicitly
+    so other added handlers don't trigger."
+    ([level msg]
+     (log-console! level msg nil nil))
+    ([level msg data]
+     (log-console! level msg data nil))
+    ([level msg data error]
+     (log! {:level level
+            :data data
+            :error error
+            :msg_ msg}))))
 
 (defn ->str-values
   "Adapts all values (including nested maps' values) from given
@@ -20,28 +31,30 @@
   [m]
   (reduce-kv
    (fn [acc k v]
-     (assoc acc k (cond
-                    (map? v) (->str-values v)
-                    (string? v) (identity v)
-                    :else (pr-str v))))
+     (assoc acc k (cond-> v
+                    (map? v) ->str-values
+                    (string? v) identity
+                    (boolean? v) identity
+                    :else str)))
    {} m))
 
 (defn signal->opensearch-log
   "Adapts a telemere signal to a pre-defined schema for OpenSearch."
   [{:keys [thread location] :as signal}]
-  (-> (select-keys signal [:level :ctx :data :msg_ :error :uid :inst])
+  (-> (select-keys signal [:level :ctx :data :msg_ :uid :inst])
       (merge {"thread/group" (:group thread)
               "thread/name" (:name thread)
               "thread/id" (:id thread)
               "location" (str (:ns location) ":"
                               (:line location) "x"
                               (:column location))})
       (->str-values)
+      (assoc :error (:error signal))
       (json/write-str)))
 
 (defn build-opensearch-base-req
-  [config index]
-  (let [{:keys [username password host port]} config
+  [config]
+  (let [{:keys [username password host port index]} config
         url (str "https://" host ":" port "/_bulk")]
     {:method :post
      :url url
@@ -55,59 +68,72 @@
     (http-client/request
      (update base-req :body str \newline log \newline))
     (catch Exception e
-      (send-sentry-evt-from-req! base-req e))))
-
-(defonce log-ch (atom nil))
-
-(defn setup
-  "If on dev `env`, does basically nothing besides setting the min
-  level. On `prod` env however, an async channel waits for log events,
-  which are then sent to OpenSearch."
-  [config level env & [index]]
-  (let [prod? (= env :prod)]
-
-    (when-let [ch @log-ch]
-      (async/close! ch))
-    (reset! log-ch (async/chan))
-
-    (t/set-min-level! level)
-
-    (when (and prod? (instance? ManyToManyChannel @log-ch))
-      (let [os-cfg (when prod? (:opensearch config))
-            os-base-req (build-opensearch-base-req os-cfg index)]
-
+      (log-console! :error "failed to send opensearch log"
+                    {:log log} e))))
+
+;; If on dev `env`, does basically nothing besides setting the min
+;; level. On `prod` env however, an async channel waits for log events,
+;; which are then sent to OpenSearch.
+(defrecord Logger [config]
+  component/Lifecycle
+  (start [this]
+    (let [prod? (= (:env config) :prod)
+          os-cfg (:opensearch config)
+          log-ch (async/chan)
+          os-base-req (build-opensearch-base-req os-cfg)]
+
+      (t/set-min-level!
+       (or (get-in config [:logger :min-level]) :info))
+
+      (when (and prod? (instance? ManyToManyChannel log-ch))
         (t/set-ns-filter! {:disallow #{"*jetty*" "*hikari*"
                                        "*pedestal*" "*migratus*"}})
 
         (t/add-handler!
-         :opensearch
+         ::opensearch
          (fn [signal]
            (async/go
-             (async/>! @log-ch (signal->opensearch-log signal)))))
+             (async/>! log-ch (signal->opensearch-log signal)))))
 
         (async/go
           (while true
-            (let [[log _] (async/alts! [@log-ch])]
-              (send-opensearch-log-req os-base-req log))))))))
-
-(defn log [level msg & [data]]
-  (t/log! {:level level
-           :data data}
-          (str msg)))
+            (let [[log _] (async/alts! [log-ch])]
+              (send-opensearch-log-req os-base-req log)))))
+
+      (assoc this :log-ch log-ch)))
+  (stop [this]
+    (t/remove-handler! ::opensearch)
+    (update this :log-ch #(when % (async/close! %)))))
+
+(defn log
+  ([level msg]
+   (log level msg nil nil nil))
+  ([level msg data]
+   (log level msg data nil nil))
+  ([level msg data ctx]
+   (log level msg data ctx nil))
+  ([level msg data ctx error]
+   (t/log! {:level level
+            :ctx ctx
+            :data data
+            :error error}
+           (str msg))))
 
 (defn gen-ctx-with-cid []
   {:cid (str "cid-" (random-uuid) "-" (System/currentTimeMillis))})
 
 (comment
-  @log-ch
-
-  (setup {:opensearch
-          {:username "foobar"
-           :password "foobar"
-           :host "foobar"
-           :port 25060}}
-         :info :prod "moclojer-api-logs")
-
-  (log :error "something happened" {:user "j0suetm"})
+  (component/start
+   (map->Logger
+    {:config
+     {:env :prod
+      :opensearch
+      {:username "foobar"
+       :password "foobar"
+       :host "foobar"
+       :port 25060
+       :index "components-test-logs"}}}))
+
+  (log :error "something happened" {:hello true})
   ;;
   )

src/com/moclojer/components/moclojer.clj

@@ -16,9 +16,9 @@
   component/Lifecycle
   (start [this]
     (let [{:keys [config-path join?]} (-> config :config :moclojer)]
-      (logs/log :info :moclojer-start
-                :info-server {:config-path config-path
-                              :join? join?})
+      (logs/log :info "starting moclojer server"
+                {:server {:config-path config-path
+                          :join? join?}})
       (on-startup-fn storage config-path)
       (assoc this :moclojer
              (moclojer-server!

src/com/moclojer/components/mq.clj

@@ -40,10 +40,11 @@
              (try
                (handler-fn message components)
                (catch Throwable ex
-                 (logs/log :error "failed to handle worker"
-                           :ctx {:worker worker
-                                 :message message
-                                 :ex-message (.getMessage ex)})
+                 (logs/log
+                  :error "worker failed to handle message"
+                  {:worker worker
+                   :message message}
+                  nil ex)
                  (sentry/send-event! sentry {:throwable ex})))))))
 
 (defrecord MQ [config database storage http sentry workers jobs blocking?]
@@ -79,25 +80,24 @@
         (apply op-fn op-args))
       (catch Throwable ex
         (logs/log :error "failed to exec mq operation"
-                  :ctx (merge ctx {:op-name op-name
-                                   :args args
-                                   :ex-message (.getMessage ex)}))
+                  (merge ctx {:op-name op-name
+                              :args args})
+                  nil ex)
         (sentry/send-event! (get-in this [:components :sentry])
                             {:throwable ex}))))
   (start-job! [this job]
     (let [{:keys [channel event sleep max-attempts]
            :or {sleep 2000
                 ;; max-attempts of `0` means infinite attempts.
                 max-attempts 0}} job]
-      (logs/log :info "starting job" :ctx {:job job})
+      (logs/log :info "starting job" {:job job})
       (future
         (loop [attempt 1]
           (let [infinite-attempts? (<= max-attempts 0)
                 attempt? (<= attempt max-attempts)]
             (when (or infinite-attempts? attempt?)
-              (logs/log :info "running job"
-                        :ctx {:job job
-                              :attempt attempt})
+              (logs/log :info "running job" {:job job
+                                             :attempt attempt})
               (try-op! this :publish! [channel event] {})
               (Thread/sleep sleep)
               (recur (inc attempt)))))))))