https://github.com/logicblocks/cartus

A structured logging abstraction with multiple backends.
https://github.com/logicblocks/cartus

cambium clojure logger logging logs structured-logging testing

Last synced: 1 day ago
JSON representation

A structured logging abstraction with multiple backends.

• Host: GitHub
• URL: https://github.com/logicblocks/cartus
• Owner: logicblocks
• License: mit
• Created: 2020-07-16T15:11:59.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-12-13T08:52:00.000Z (21 days ago)
• Last Synced: 2024-12-25T22:07:50.465Z (8 days ago)
• Topics: cambium, clojure, logger, logging, logs, structured-logging, testing
• Language: Clojure
• Homepage: https://logicblocks.github.io/cartus/
• Size: 479 KB
• Stars: 22
• Watchers: 8
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# cartus

[![Clojars Project](https://img.shields.io/clojars/v/io.logicblocks/cartus.core.svg)](https://clojars.org/io.logicblocks/cartus.core)

[![Clojars Downloads](https://img.shields.io/clojars/dt/io.logicblocks/cartus.core.svg)](https://clojars.org/io.logicblocks/cartus.core)

[![GitHub Contributors](https://img.shields.io/github/contributors-anon/logicblocks/cartus.svg)](https://github.com/logicblocks/cartus/graphs/contributors)

A structured logging abstraction for logging data rich events with support for 

multiple backends, currently including:

* a test logger for collecting logs in memory and asserting against 

  them; and

* a [`cambium`](https://cambium-clojure.github.io/) logger for logging 

  out via [`SLF4J`](http://www.slf4j.org/) and 

  [`logback`](http://logback.qos.ch/).

* a null logger that ignores all logged events, useful as a default 

  implementation or to turn off logging completely.

  

Heavily inspired by [JUXT's blog post on logging](https://juxt.pro/blog/logging).

## Installation

Add the following to your `project.clj` file:

```clojure

[io.logicblocks/cartus.core "0.1.18"]

```

Depending on which backends you plan to use, add one or more of the following to

your `project.clj` file:

```clojure

[io.logicblocks/cartus.null "0.1.18"]

[io.logicblocks/cartus.test "0.1.18"]

[io.logicblocks/cartus.cambium "0.1.18"]

```

The [`cambium`](https://cambium-clojure.github.io/) backend requires further

configuration. See the 

[Getting Started](https://logicblocks.github.io/cartus/getting-started.html)

guide for more details.

## Documentation

* [API Docs](http://logicblocks.github.io/cartus)

* [Getting Started](https://logicblocks.github.io/cartus/getting-started.html)

## Usage

```clojure

(require '[cartus.core :as log])

(require '[cartus.cambium])

(cartus.cambium/initialise)

(def logger (cartus.cambium/logger))

(log/info logger ::usage.demonstrated

  {:feature-coverage "3%" :customer-satisfaction :low})

(let [logger (log/with-context logger

               {:see "getting started guide" :for "more information"})]

  (log/debug logger ::usage.redirecting {:to "API docs"})

  (log/error logger ::usage.irritating

    {:joke "running thin"}

    {:exception (ex-info "Not funny!" {:stick-to "day job"})}))

```

## License

Copyright © 2023 LogicBlocks Maintainers

Distributed under the terms of the 

[MIT License](http://opensource.org/licenses/MIT).