Skip to content

Commit c2c1d0a

Browse files
committed
Minor clarifications to docs for log module
1 parent 78c5c08 commit c2c1d0a

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

opentelemetry/src/lib.rs

+10
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,16 @@
8888
//! See the [`metrics`] module docs for more information on creating and
8989
//! managing instruments.
9090
//!
91+
//!
92+
//! //! # Logs
93+
//!
94+
//! The [`logs`] module contains the Logs Bridge API. It is not intended to be
95+
//! called by application developers directly. It is provided for logging
96+
//! library authors to build log appenders, that bridges existing logging
97+
//! systems with OpenTelemetry. OpenTelemetry. Bridges for `log` and `tracing`
98+
//! libraries are provided via the `opentelemetry-log` and
99+
//! `tracing-opentelemetry` crates.
100+
//!
91101
//! ## Crate Feature Flags
92102
//!
93103
//! The following core crate feature flags are available:

opentelemetry/src/logs/mod.rs

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
//! # OpenTelemetry Logs Bridge API
2-
/// This API is not intended to be called by application developers directly. It
3-
/// is provided for logging library authors to build log appenders.
2+
/// This API is not intended to be called by application developers directly.
3+
/// It is provided for logging library authors to build log appenders, that
4+
/// bridges existing logging systems with OpenTelemetry.
45
use crate::ExportError;
56

67
use std::{sync::PoisonError, time::Duration};

0 commit comments

Comments
 (0)