Skip to content

Commit 4ae9b9c

Browse files
committed
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 11bb7f1 commit 4ae9b9c

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
@@ -60,6 +60,15 @@ where
6060

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

0 commit comments

Comments
 (0)