Skip to content

Commit

Permalink
~wip
Browse files Browse the repository at this point in the history
  • Loading branch information
ptaoussanis committed Aug 31, 2024
1 parent 415b1e3 commit 694835d
Showing 1 changed file with 20 additions and 8 deletions.
28 changes: 20 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,19 @@

### Structured telemetry library for Clojure/Script

**Telemere** is a next-generation replacement for [Timbre](https://www.taoensso.com/timbre) that offers one simple **unified API** for **traditional logging**, **structured logging**, **tracing**, and **basic performance monitoring**.
**Telemere** is a **pure Clojure/Script library** that offers an elegant and simple **unified API** to cover all of the most common telemetry needs:

It's implemented in **pure Clojure/Script**, and **just works out the box** with none of the mess of Java logging.
- **Traditional logging** (string messages)
- **Structured logging** (rich Clojure data types and structures)
- **Events** (named occurrences, with optional data)
- **Tracing** (nested flow tracking, with optional data)
- Basic **performance monitoring** (nested form runtimes)

It's friendly enough for complete beginners, but flexible enough for the most complex and performance-sensitive real-world projects.
It's small, *super* fast, easy to learn, easy to use, and **absurdly flexible**.

It helps enable Clojure/Script systems that are easily **observable**, **robust**, and **debuggable** - and it represents the refinement and culmination of ideas brewing over 12+ years in [Timbre](https://www.taoensso.com/timbre), [Tufte](https://www.taoensso.com/tufte), [Truss](https://www.taoensso.com/truss), etc.
Ultimately, it helps enable Clojure/Script systems that are easily **observable**, **robust**, and **debuggable** - and it represents the refinement and culmination of ideas brewing over 12+ years in [Timbre](https://www.taoensso.com/timbre), [Tufte](https://www.taoensso.com/tufte), [Truss](https://www.taoensso.com/truss), etc.

Supports Clojure, ClojureScript, [GraalVM](https://en.wikipedia.org/wiki/GraalVM), but not ([yet](../../wiki/6-FAQ#does-telemere-work-with-babashka)) [Babashka](https://github.com/babashka/babashka).

See [here](../../wiki/1-Getting-started) for **full introduction**.
See [here](../../wiki/1-Getting-started) for **full introduction** (concepts, terminology, getting started).

## Latest release/s

Expand All @@ -24,8 +26,18 @@ See [here](../../wiki/1-Getting-started) for **full introduction**.
[![Main tests][Main tests SVG]][Main tests URL]
[![Graal tests][Graal tests SVG]][Graal tests URL]

See [here][GitHub releases] for earlier releases.
<!--See [here][GitHub releases] for earlier releases.-->

<details>
<summary>Click to expand</summary>

```clojure
(println "foo")
```

</details>

```clojure
## Quick examples

```clojure
Expand Down

0 comments on commit 694835d

Please sign in to comment.