From ca830d2406deebdfb08165d19545d5de58946714 Mon Sep 17 00:00:00 2001 From: Eliza Weisman Date: Fri, 1 Jul 2022 10:00:11 -0700 Subject: [PATCH] opentelemetry: fix exception fields defaults in docs 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. This branch updates the docs to state that these features are disabled by default, rather than enabled by default. --- tracing-opentelemetry/src/layer.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tracing-opentelemetry/src/layer.rs b/tracing-opentelemetry/src/layer.rs index a722dfd185..533fe19406 100644 --- a/tracing-opentelemetry/src/layer.rs +++ b/tracing-opentelemetry/src/layer.rs @@ -483,7 +483,7 @@ where /// These attributes follow the [OpenTelemetry semantic conventions for /// exceptions][conv]. /// - /// By default, these fields are enabled + /// By default, these attributes are not recorded. /// /// [conv]: https://opentelemetry.io/docs/reference/specification/trace/semantic_conventions/exceptions/ pub fn with_exception_fields(self, exception_fields: bool) -> Self { @@ -506,7 +506,7 @@ where /// These attributes follow the [OpenTelemetry semantic conventions for /// exceptions][conv]. /// - /// By default, this is enabled + /// By default, these attributes are not propagated to the span. /// /// [conv]: https://opentelemetry.io/docs/reference/specification/trace/semantic_conventions/exceptions/ pub fn with_exception_field_propagation(self, exception_field_propagation: bool) -> Self {