diff --git a/README.md b/README.md index eec411c..b57e5a0 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ [![all](https://github.com/KodrAus/emit/actions/workflows/all.yml/badge.svg)](https://github.com/KodrAus/emit/actions/workflows/all.yml) +[Current docs](https://docs.rs/emit/0.11.0-alpha.1/emit/index.html) + ## Structured diagnostics for Rust applications. `emit` is a structured logging framework for manually instrumenting Rust applications with an expressive syntax inspired by [Message Templates](https://messagetemplates.org). diff --git a/batcher/README.md b/batcher/README.md index f16b135..5b85a67 100644 --- a/batcher/README.md +++ b/batcher/README.md @@ -2,4 +2,6 @@ [![batcher](https://github.com/KodrAus/emit/actions/workflows/batcher.yml/badge.svg)](https://github.com/KodrAus/emit/actions/workflows/batcher.yml) +[Current docs](https://docs.rs/emit_batcher/0.11.0-alpha.1/emit_batcher/index.html) + Infrastructure for emitting diagnostic events in the background. diff --git a/emitter/file/README.md b/emitter/file/README.md index 1d46a10..e2f4b90 100644 --- a/emitter/file/README.md +++ b/emitter/file/README.md @@ -2,4 +2,6 @@ [![file](https://github.com/KodrAus/emit/actions/workflows/file.yml/badge.svg)](https://github.com/KodrAus/emit/actions/workflows/file.yml) +[Current docs](https://docs.rs/emit_file/0.11.0-alpha.1/emit_file/index.html) + Emit diagnostic events to rolling files. diff --git a/emitter/opentelemetry/README.md b/emitter/opentelemetry/README.md index 80b50ea..01f6d41 100644 --- a/emitter/opentelemetry/README.md +++ b/emitter/opentelemetry/README.md @@ -2,6 +2,8 @@ [![opentelemetry](https://github.com/KodrAus/emit/actions/workflows/opentelemetry.yml/badge.svg)](https://github.com/KodrAus/emit/actions/workflows/opentelemetry.yml) +[Current docs](https://docs.rs/emit_opentelemetry/0.11.0-alpha.1/emit_opentelemetry/index.html) + Integrate `emit` with the OpenTelemetry SDK. This library forwards diagnostic events from emit through the OpenTelemetry SDK as log records and spans. diff --git a/emitter/otlp/README.md b/emitter/otlp/README.md index a13e7a0..a00a67f 100644 --- a/emitter/otlp/README.md +++ b/emitter/otlp/README.md @@ -2,6 +2,8 @@ [![otlp](https://github.com/KodrAus/emit/actions/workflows/otlp.yml/badge.svg)](https://github.com/KodrAus/emit/actions/workflows/otlp.yml) +[Current docs](https://docs.rs/emit_otlp/0.11.0-alpha.1/emit_otlp/index.html) + Emit diagnostic events via the OpenTelemetry Protocol (OTLP). This library sends export requests directly to some remote OTLP receiver. If you need to integrate `emit` with the OpenTelemetry SDK, see `emit-opentelemetry`. diff --git a/emitter/term/README.md b/emitter/term/README.md index 6e8aef4..5aea6be 100644 --- a/emitter/term/README.md +++ b/emitter/term/README.md @@ -2,6 +2,8 @@ [![term](https://github.com/KodrAus/emit/actions/workflows/term.yml/badge.svg)](https://github.com/KodrAus/emit/actions/workflows/term.yml) +[Current docs](https://docs.rs/emit_term/0.11.0-alpha.1/emit_term/index.html) + Emit diagnostic events to the console. This library implements a text-based format that's intended for direct end-user consumption, such as in interactive applications. diff --git a/macros/README.md b/macros/README.md index 75b4c66..83a2cf7 100644 --- a/macros/README.md +++ b/macros/README.md @@ -2,6 +2,8 @@ [![macros](https://github.com/KodrAus/emit/actions/workflows/macros.yml/badge.svg)](https://github.com/KodrAus/emit/actions/workflows/macros.yml) +[Current docs](https://docs.rs/emit_macros/0.11.0-alpha.1/emit_macros/index.html) + Implementation details for `emit!` macros. This crate is not intended to be consumed directly. diff --git a/src/lib.rs b/src/lib.rs index 8700a94..1c7d234 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -34,9 +34,9 @@ fn main() { In real applications, you'll want to use a more sophisticated emitter, such as: -- `emit_term`: Emit diagnostics to the console. -- `emit_file`: Emit diagnostics to a set of rolling files. -- `emit_otlp`: Emit diagnostics to a remote collector via OpenTelemetry Protocol. +- [`emit_term`](https://docs.rs/emit_term/0.11.0-alpha.1/emit_term/index.html): Emit diagnostics to the console. +- [`emit_file`](https://docs.rs/emit_file/0.11.0-alpha.1/emit_file/index.html): Emit diagnostics to a set of rolling files. +- [`emit_otlp`](https://docs.rs/emit_otlp/0.11.0-alpha.1/emit_otlp/index.html): Emit diagnostics to a remote collector via OpenTelemetry Protocol. For more advanced setup options, see the [`mod@setup`] module.