Skip to content

Commit e56a711

Browse files
authored
Update main readme with logging status (#1102)
1 parent d3c8598 commit e56a711

File tree

1 file changed

+27
-3
lines changed

1 file changed

+27
-3
lines changed

README.md

+27-3
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,33 @@ observability tools.
3434

3535
## Project Status
3636

37-
[OpenTelemetry Signal Status for Rust][otel-signals-rust]. Libraries adhere to [Stability Guarantees.][otel-signal-stability]
37+
| Signal | Status |
38+
| ------- | ---------- |
39+
| Logs | Alpha* |
40+
| Metrics | Alpha |
41+
| Traces | Beta |
42+
43+
*OpenTelemetry Rust is not introducing a new end user callable Logging API.
44+
Instead, it provides [Logs Bridge
45+
API](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/bridge-api.md),
46+
that allows one to write log appenders that can bridge existing logging
47+
libraries to the OpenTelemetry log data model. The following log appenders are
48+
available:
49+
50+
* [opentelemetry-appender-log](opentelemetry-appender-log/README.md)
51+
* opentelemetry-appender-tracing // TODO: Add link once available
52+
* opentelemetry-appender-slog // TODO: Add link once available
53+
54+
If you already use the logging APIs from above, continue to use them, and use
55+
the appenders above to bridge the logs to OpenTelemetry. If you are using a
56+
library not listed here, feel free to contribute a new appender for the same.
57+
58+
If you are starting fresh, then consider using
59+
[tracing](https://github.com/tokio-rs/tracing) as your logging API. It supports
60+
structured logging and is actively maintained.
61+
62+
Project versioning information and stability guarantees can be found
63+
[here](VERSIONING.md).
3864

3965
## Getting Started
4066

@@ -138,8 +164,6 @@ above, please let us know! We'd love to add your project to the list!
138164
[`Tide`]: https://crates.io/crates/tide
139165
[`opentelemetry-stackdriver`]: https://crates.io/crates/opentelemetry-stackdriver
140166
[Cloud Trace]: https://cloud.google.com/trace/
141-
[otel-signals-rust]: https://opentelemetry.io/docs/instrumentation/rust/#status-and-releases
142-
[otel-signal-stability]: https://opentelemetry.io/docs/reference/specification/versioning-and-stability/
143167

144168
## Supported Rust Versions
145169

0 commit comments

Comments
 (0)