[**Documentation**](#documentation) | [Latest releases](#latest-releases) | [Get support][GitHub issues] # Telemere ### Structured telemetry library for Clojure/Script > This library is **still under development**!! **Telemere** is an [**upcoming**](https://www.taoensso.com/roadmap) next-generation observability toolkit for **capturing all kinds of un/structured information** in your running Clojure and ClojureScript programs. It offers a **simple, clean, unified API** that covers: **logging**, **events**, **performance measurement**, **tracing**, etc. Taking full advantage of Clojure's unique **macro and interop** capabilities, Telemere represents the **refinement and culmination** of ideas brewing for 10+ years in [Timbre](https://www.taoensso.com/timbre), [Tufte](https://www.taoensso.com/tufte), [Truss](https://www.taoensso.com/truss), etc. ## Latest release/s - Stable release: coming [~Apr 2024](https://www.taoensso.com/roadmap) - `v1.0.0-SNAPSHOT` (dev): [release info](https://clojars.org/com.taoensso/telemere) (for early adopters) [![Main tests][Main tests SVG]][Main tests URL] [![Graal tests][Graal tests SVG]][Graal tests URL] See [here][GitHub releases] for earlier releases. ## Why Telemere? - Simple, lightweight API that's **easy to use**, **easy to configure**, and **deeply flexible**. - An **unmatched logging experience** designed to **scale comfortably** from the smallest disposable code, to the most massive production applications. - **Easy integration** with the **tooling of your choice**, including first-class **out-the-box interop** with [OpenTelemetry](https://opentelemetry.io/), [SLF4J v2](https://www.slf4j.org/), [clojure.tools.logging](https://github.com/clojure/tools.logging), and [Tufte](https://www.taoensso.com/tufte). - Hyper-optimized and **blazing fast**, see [performance](#performance). - Expressive **per-call** and **per-handler** filtering at both **runtime** and **compile-time**. - Easily filter by namespace and id pattern, level, **level by namespace pattern**, etc. - Support for auto **sampling**, **rate-limiting**, and **back-pressure monitoring**. - Support for **fully configurable a/sync dispatch** (blocking, dropping, sliding, etc.). - **Sensible defaults** to make getting started **fast and easy**. - Extensive **beginner-oriented** [documentation](#documentation), docstrings, examples, etc. ## Video demo See for intro and usage: (**TODO**: coming later) ## Quick example ```clojure ;; TODO: coming later ``` ## Observability tips See [here](/TODO) for general advice re: building and maintaining **highly observable** Clojure/Script systems. ## Performance Telemere is **highly optimized** and offers terrific performance at any scale: | Compile-time filtering? | Runtime filtering? | Time? | Trace? | nsecs | :-: | :-: | :-: | :-: | --: | ✓ (elide) | - | - | - | 0 | - | ✓ | - | - | 200 | - | ✓ | ✓ | - | 280 | - | ✓ | ✓ | ✓ | 650 Measurements: - Are **~nanoseconds per signal call** (= milliseconds per 1e6 calls) - Exclude handler runtime (which depends on handler/s, is usually async) - Taken on a 2020 Macbook Pro M1, running OpenJDK 21 **Tip**: Telemere offers extensive per-call and per-handler **filtering**, **sampling**, and **rate-limiting**. Use these to ensure that you're not capturing useless/low-value information in production. See [here](/TODO) for more tips! ## Documentation - [Wiki][GitHub wiki] (getting started, usage, etc.) (**TODO:** coming later) - API reference: [Codox][Codox docs], [clj-doc][clj-doc docs] ## Funding You can [help support][sponsor] continued work on this project, thank you!! 🙏 ## License Copyright © 2023-2024 [Peter Taoussanis][]. Licensed under [EPL 1.0](LICENSE.txt) (same as Clojure). [GitHub releases]: ../../releases [GitHub issues]: ../../issues [GitHub wiki]: ../../wiki [Peter Taoussanis]: https://www.taoensso.com [sponsor]: https://www.taoensso.com/sponsor [Codox docs]: https://taoensso.github.io/telemere/ [clj-doc docs]: https://cljdoc.org/d/com.taoensso/telemere/ [Clojars SVG]: https://img.shields.io/clojars/v/com.taoensso/telemere.svg [Clojars URL]: https://clojars.org/com.taoensso/telemere [Main tests SVG]: https://github.com/taoensso/telemere/actions/workflows/main-tests.yml/badge.svg [Main tests URL]: https://github.com/taoensso/telemere/actions/workflows/main-tests.yml [Graal tests SVG]: https://github.com/taoensso/telemere/actions/workflows/graal-tests.yml/badge.svg [Graal tests URL]: https://github.com/taoensso/telemere/actions/workflows/graal-tests.yml