From ee8505933c84a8e56b38f617407dd9e6aa930a1a Mon Sep 17 00:00:00 2001 From: Peter Taoussanis Date: Mon, 15 Apr 2024 09:57:40 +0200 Subject: [PATCH] [doc] Documentation work --- README.md | 61 ++--- examples.cljc | 62 ++++++ .../signal-docstrings/catch-to-error!.txt | 11 +- resources/signal-docstrings/error!.txt | 13 +- resources/signal-docstrings/event!.txt | 19 +- resources/signal-docstrings/log!.txt | 19 +- resources/signal-docstrings/signal!.txt | 26 +-- .../signal-docstrings/signal-creators.txt | 32 +++ resources/signal-docstrings/signal-flow.txt | 6 +- resources/signal-docstrings/spy!.txt | 17 +- resources/signal-docstrings/trace!.txt | 17 +- src/taoensso/telemere.cljc | 7 +- src/taoensso/telemere/tools_logging.clj | 9 +- wiki/1-Getting-started.md | 208 +++++++++++++++++- wiki/2-Architecture.md | 31 +++ wiki/3-Config.md | 123 +++++++++++ wiki/4-Handlers.md | 184 ++++++++++++++++ wiki/5-Migrating.md | 70 ++++++ wiki/6-FAQ.md | 55 +++++ wiki/7-Tips.md | 111 ++++++++++ wiki/8-Community.md | 20 ++ wiki/Home.md | 23 +- 22 files changed, 1023 insertions(+), 101 deletions(-) create mode 100644 resources/signal-docstrings/signal-creators.txt create mode 100644 wiki/2-Architecture.md create mode 100644 wiki/3-Config.md create mode 100644 wiki/4-Handlers.md create mode 100644 wiki/5-Migrating.md create mode 100644 wiki/6-FAQ.md create mode 100644 wiki/7-Tips.md create mode 100644 wiki/8-Community.md 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