https://github.com/nberger/ring-logger-onelog

Log ring requests & responses using ring-logger & onelog!
https://github.com/nberger/ring-logger-onelog

Last synced: about 1 month ago
JSON representation

Log ring requests & responses using ring-logger & onelog!

• Host: GitHub
• URL: https://github.com/nberger/ring-logger-onelog
• Owner: nberger
• License: epl-1.0
• Created: 2015-09-01T00:17:08.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2016-03-30T01:05:59.000Z (over 8 years ago)
• Last Synced: 2024-07-25T06:05:17.425Z (4 months ago)
• Language: Clojure
• Homepage:
• Size: 22.5 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ring-logger-onelog [![Circle CI](https://circleci.com/gh/nberger/ring-logger-onelog.svg?style=svg)](https://circleci.com/gh/nberger/ring-logger-onelog)

[OneLog](https://github.com/pjlegato/onelog) implementation for [ring-logger](https://github.com/nberger/ring-logger)

[![Clojars Project](http://clojars.org/ring-logger-onelog/latest-version.svg)](http://clojars.org/ring-logger-onelog)

Migration from [ring.middleware.logger](https://github.com/pjlegato/ring.middleware.logger)

-------------------------------------

The migration is pretty straightforward:

* Replace dependency in `project.clj` from `[ring.middleware.logger "0.5.0"]` to `[ring-logger-onelog "0.7.6"]`

* Replace the require from `[ring.middleware.logger :as logger]` to `[ring.logger.onelog :as logger]`

* Pass options to `wrap-with-logger` using a proper map instead of keyword arguments.

## Usage

In your `project.clj`, add the following dependencies:

```clojure

[ring-logger-onelog "0.7.6"]

```

Add the middleware to your stack, using the onelog implementation. It's similar to

using the default ring-logger, but requiring the onelog namespace:

```clojure

(ns foo

  (:require [ring.adapter.jetty :as jetty]

            [ring.logger.onelog :as logger.onelog]))

(defn my-ring-app [request]

  {:status 200

   :headers {"Content-Type" "text/html"}

   :body "Hello world!"})

(jetty/run-jetty (logger.onelog/wrap-with-logger my-ring-app) {:port 8080})

```

Differences from plain [ring-logger](https://github.com/nberger/ring-logger)

---------------------------------

Each request is assigned a random 4-hex-digit ID, so that different log messages

pertaining to the same request can be cross-referenced.

These IDs are printed in random ANSI colors by default, for easy visual

correlation of log messages while reading a log file.

* Q: I don't want ANSI colors, how can I remove them?

* A: Use the `:printer :no-color` option when creating the logger:

```clojure

(logger.onelog/wrap-with-logger my-ring-app {:printer :no-color})

```

Log Levels

----------

The logger logs at `INFO` level by default. More verbose information is logged when the logger is at `DEBUG` level.

We can use OneLog's convenience methods to change the log level:

```clojure

(onelog.core/set-debug!)

(onelog.core/set-info!)

(onelog.core/set-warn!)

```

## Contributing

Pull requests, issues and any feedback are all welcome!

## License

Copyright © 2015 Nicolás Berger, 2012-2014 Paul Legato

Distributed under the Eclipse Public License either version 1.0 or (at

your option) any later version.