Skip to content

Commit 35be2a5

Browse files
mTsBucy1mladedav
authored andcommitted
docs: add functionality rustdocs to layer
I didn't find this information when I looked, and I think it is very important. I also added the follows-from limitation.
1 parent a31f8db commit 35be2a5

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

src/layer.rs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,15 @@ where
6565

6666
/// Construct a layer to track spans via [OpenTelemetry].
6767
///
68+
/// It will convert the tracing spans to OpenTelemetry spans
69+
/// and tracing events which are in a span to events in the currently active OpenTelemetry span.
70+
/// Child-Parent links will be automatically translated as well.
71+
/// Follows-From links will also be generated, but only if the originating span has not been closed yet.
72+
///
73+
/// Various translations exist between semantic conventions of OpenTelemetry and `tracing`,
74+
/// such as including level information as fields, or mapping error fields to exceptions.
75+
/// See the various `layer().with_*` functions for configuration of these features.
76+
///
6877
/// [OpenTelemetry]: https://opentelemetry.io
6978
///
7079
/// # Examples

0 commit comments

Comments
 (0)