Skip to content

Misleading documentation on sampled parameter #4305

Open
@Walther

Description

@Walther

Thanks for the useful library! 🧡

The documentation for Span describes the sampled parameter as follows:

sampled (Optional[bool]) – Whether the span should be sampled. Overrides the default sampling decision for this span when provided.

However, it appears that this cannot be used at runtime to skip specific child spans from being reported inside a transaction that is sampled. There was a feature request for this here #1895 and it was closed as not planned.

Additionally, it looks like with the project POTel the plan is to remove the sampled parameter altogether: #4200

Would it be possible to update the documentation to reflect the current (and future) state? Thanks!

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    Waiting for: Community

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions