Skip to content

Commit 2659ccf

Browse files
authored
opentelemetry: fix exception fields defaults in docs (#2200)
## Motivation Currently, the `tracing-opentelemetry` docs indicate that the support for OpenTelemetry's exception semantic conventions added in #2135 is enabled by default. However, this is not the case --- this feature was changed to opt-in rather than opt-out prior to merging PR #2135. ## Solution This branch updates the docs to state that these features are disabled by default, rather than enabled by default.
1 parent 4a3f299 commit 2659ccf

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

tracing-opentelemetry/src/layer.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -483,7 +483,7 @@ where
483483
/// These attributes follow the [OpenTelemetry semantic conventions for
484484
/// exceptions][conv].
485485
///
486-
/// By default, these fields are enabled
486+
/// By default, these attributes are not recorded.
487487
///
488488
/// [conv]: https://opentelemetry.io/docs/reference/specification/trace/semantic_conventions/exceptions/
489489
pub fn with_exception_fields(self, exception_fields: bool) -> Self {
@@ -506,7 +506,7 @@ where
506506
/// These attributes follow the [OpenTelemetry semantic conventions for
507507
/// exceptions][conv].
508508
///
509-
/// By default, this is enabled
509+
/// By default, these attributes are not propagated to the span.
510510
///
511511
/// [conv]: https://opentelemetry.io/docs/reference/specification/trace/semantic_conventions/exceptions/
512512
pub fn with_exception_field_propagation(self, exception_field_propagation: bool) -> Self {

0 commit comments

Comments
 (0)