Skip to content

Consistent warning about debug logs and traces #4752

@coryan

Description

@coryan

The .with_tracing() method should get a consistent warning about the contents of the debug logs and traces.


Thank you, that's a huge warning. Here's an optional nit to update it kind of like what you had (I think it's going to be updated again.)

    /// <div class="warning">
 /// Traces at any level may contain sensitive data like bucket names, object names, full URLs and error messages.
    /// Review the contents of the traces and consult the [tracing][::tracing] framework documentation to set up
    /// filters and formatters to prevent leaking information, depending on your intended use case.
    /// </div>
    ///
    /// Traces at the `INFO` level follow [OpenTelemetry Semantic Conventions] with additional Storage attributes, and are intended to be suitable for production monitoring.
    /// Traces at the `DEBUG` level or lower are meant for detailed debugging and include arbitrary content.
    //
    /// [OpenTelemetry Semantic Conventions]: https://opentelemetry.io/docs/concepts/semantic-conventions/

Originally posted by @westarle in #4740 (comment)

Metadata

Metadata

Assignees

Labels

priority: p2Moderately-important priority. Fix may not be included in next release.type: docsImprovement to the documentation for an API.

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions