diff --git a/README.md b/README.md index 75eacf1..99a6fbb 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ Taoensso open source -[**Documentation**](#documentation) | [Latest releases](#latest-releases) | [Get support][GitHub issues] +[**Documentation**](#documentation) | [Latest releases](#latest-releases) | [Slack channel][] -# Telemere +# Telemere logo ### Structured telemetry library for Clojure/Script **Telemere** is a next-generation replacement for [Timbre](https://www.taoensso.com/timbre). It handles **structured and traditional logging**, **tracing**, and **basic performance monitoring** with a simple unified API. -It helps enable the creation of Clojure/Script systems that are highly **observable**, **robust**, and **debuggable** - and it represents the refinement and culmination of ideas brewing over 12+ years in [Timbre](https://github.com/taoensso/timbre), [Tufte](https://github.com/taoensso/tufte), [Truss](https://github.com/taoensso/truss), etc. +It helps enable Clojure/Script systems that are **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. -> [Terminology] *Telemetry* is derived from the Greek roots *tele* (remote) and *metron* (measure). It refers to the collection of *in situ* (in position) information, for transmission to other systems for monitoring/analysis. *Logs* are the most common form of software telemetry. So think of telemetry as the *superset of logging-like activities* that help monitor and understand (software) systems. +> [Terminology] *Telemetry* derives from the Greek *tele* (remote) and *metron* (measure). It refers to the collection of *in situ* (in position) data, for transmission to other systems for monitoring/analysis. *Logs* are the most common form of software telemetry. So think of telemetry as the *superset of logging-like activities* that help monitor and understand (software) systems. ## Latest release/s @@ -32,8 +32,8 @@ See [here][GitHub releases] for earlier releases. #### Interop -- 1st-class **out-the-box interop** with [SLF4J v2](https://www.slf4j.org/), [clojure.tools.logging](https://github.com/clojure/tools.logging), [OpenTelemetry](https://opentelemetry.io/), and [Tufte](https://www.taoensso.com/tufte) (soon). -- Included shim for easy/gradual [migration from Timbre](../../wiki/7-Migrating). +- 1st-class **out-the-box interop** with [SLF4J v2](https://www.slf4j.org/), [clojure.tools.logging](https://github.com/clojure/tools.logging), [OpenTelemetry](https://opentelemetry.io/), and [Tufte](https://www.taoensso.com/tufte). +- Included [shim](https://cljdoc.org/d/com.taoensso/telemere/CURRENT/api/taoensso.telemere.timbre) for easy/gradual [migration from Timbre](../../wiki/5-Migrating). #### Scaling @@ -43,7 +43,7 @@ See [here][GitHub releases] for earlier releases. #### Flexibility - Config via plain **Clojure vals and fns** for easy customization, composition, and REPL debugging. -- Unmatched support for **environmental config** (JVM props, ENV vars, edn resources, etc.). +- Unmatched support for **system-level config** (JVM props, ENV vars, classpath resources). - Expressive **per-call** and **per-handler** filtering at both **runtime** and **compile-time**. - Filter by namespace and id pattern, level, **level by namespace pattern**, etc. - **Sampling**, **rate-limiting**, and **back-pressure monitoring**. @@ -53,7 +53,7 @@ See [here][GitHub releases] for earlier releases. See for intro and usage: -**TODO**: soon +**TODO**: coming soon