itsscb/tracing
1
0
Fork 0
mirror of https://github.com/tokio-rs/tracing.git synced 2025-09-30 22:40:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

opentelemetry: fix exception fields defaults in docs (#2200)

Browse Source 
## 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.
This commit is contained in:
Eliza Weisman 2022-07-01 10:21:44 -07:00 committed by GitHub
parent 4a3f2991bf
commit 2659ccf72f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
tracing-opentelemetry/src/layer.rs
View File

@ -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 {