ring-logging.core — ring-logging 0.3.8

deep-select-keys clj/s

(deep-select-keys m x)

A utility function for filtering requests and responses. Behaves like select-keys, but with arbitrary nesting. When a value is missing in the source map, it will not be included in the result. For example:

(deep-select-keys
  {:method       :get
   :url          "http://google.com"
   :query-params {:a        "some"
                  :password "safe"}
   :headers      {"Authentication" "safe"}} [:method :url :form-params {:query-params [:a :b]}])

; =>
  {:method       :get
   :url          "http://google.com"
   :query-params {:a "some"}}

And

(deep-select-keys
  {:status  302
   :headers {"Location"     "http://elsewhere.com"
             "Authencation" "safe"}
   :body    {:number 25
             :key    :xyz}}
  [:status {:headers "Location"
            :body    :number}])

; =>
  {:status  302
   :headers {"Location" "http://elsewhere.com"}
   :body    {:number 25}}

default-censor-keys clj/s

exp clj/s

(exp x n)

extend-trace clj/s

(extend-trace prior)

json-inbound-config clj/s

A basic configuration for wrap-logging, when receiving requests, usually via ring. Logs as json

json-outbound-config clj/s

A basic configuration for wrap-logging, when making outbound requests to other services, usually via clj-http/client. Logs as json

json-req clj/s

(json-req req)

A json request format, which converts the request to json.

json-resp clj/s

(json-resp req resp)

A json response format, which converts the resp and the req to json.

max-trace-opts clj/s

pr-req clj/s

(pr-req req)

A basic request format, which just uses pr-str on the request.

pr-resp clj/s

(pr-resp req resp)

A basic response format, which just uses pr-str on the request and response.

simple-inbound-config clj/s

A basic configuration for wrap-logging, when receiving requests, usually via ring.

simple-outbound-config clj/s

A basic configuration for wrap-logging, when making outbound requests to other services, usually via clj-http/client.

structured-inbound-config clj/s

structured-outbound-config clj/s

structured-output-config clj/s

structured-req clj/s

(structured-req req)

A map request format, which returns structured data

structured-resp clj/s

(structured-resp req resp)

A map response format, which returns structured data

to-json clj/s

(to-json value)

trace clj/s

(trace)

Returns a 4 character string of random alphanumeric characters

trace-length clj/s

trace-padding clj/s

trace-radix clj/s

txfm-inbound-req clj/s

(txfm-inbound-req req)

A basic tranformation for requests this service receives and processes, usually via ring. Includes request-method, uri, params, remote-addr and the host and request-trace headers.

txfm-outbound-req clj/s

(txfm-outbound-req req)

A basic tranformation for requests this service makes to other services, usually via clj-http/client. Includes method, url, query-params, form-params, and the request-trace header.

txfm-resp clj/s

(txfm-resp resp)

A basic response tranformation. Includes response status, request-time and the Location header for redirects.

wrap-logging clj/s

(wrap-logging handler logger)

(wrap-logging handler
              logger
              {:keys [censor-keys txfm-req format-req txfm-resp format-resp]
               :or {censor-keys #{}
                    txfm-req identity
                    format-req pr-req
                    txfm-resp identity
                    format-resp pr-resp}})

Middleware that logs at the start of the request and the end of the response. Accepts optional configuration parameters: :param: censor-keys A set of keys, which if they match (lower-case contain), will appear in the log but whose values will be redacted. Default: #{}. :param: txfm-req A function which will transform the request before it is formatted. Useful for filtering sensitive information from the request. Default: identity. :param: format-req A function which will format the request. Default: pr-req :param: txfm-resp A function which will transform the response before it is formatted. Useful for selecting a small piece of the response to be logged, possibly in combination with pr-resp. Default: identity. :param: format-resp A function which will format the response. Receives both the request and response as arguments. Default: pr-resp.

wrap-request-timing clj/s

(wrap-request-timing handler)

Middleware that times the request, putting the total time (in milliseconds) of the request into the :request-time key in the response. This is part of default-middleware in clj-http.client, so it doesn't always need to be added. Extends the response so must execute later than wrap-logging.

wrap-trace-request clj/s

(wrap-trace-request handler)

(wrap-trace-request handler {:keys [keyseq]})

Middleware that adds an id (4 hex digits) into the request, at the provided key, as by assoc-in, by default at [:headers "request-trace"]. If an id is already present, extends it so that '6d3d' becomes '6d3d.ef66'. The recommended usage is to pass traces from one service to another, so that a log aggregator can follow requests between the services. Extends the request, so must execute earlier than wrap-logging.