Skip to content
This repository has been archived by the owner on Jun 8, 2024. It is now read-only.

Commit

Permalink
add doc links to readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
KodrAus committed Jun 7, 2024
1 parent 54568bd commit fa275b5
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 3 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
2 changes: 2 additions & 0 deletions batcher/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 2 additions & 0 deletions emitter/file/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 2 additions & 0 deletions emitter/opentelemetry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 2 additions & 0 deletions emitter/otlp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
2 changes: 2 additions & 0 deletions emitter/term/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 2 additions & 0 deletions macros/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
6 changes: 3 additions & 3 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit fa275b5

Please sign in to comment.