Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sparse documentation on Span.isRecording #81

Open
fabianfett opened this issue Jan 27, 2023 · 1 comment
Open

Sparse documentation on Span.isRecording #81

fabianfett opened this issue Jan 27, 2023 · 1 comment
Labels
0 - new Not sure yet if task is valid / going to be worked on t:docs Improvements or additions to documentation
Milestone

Comments

@fabianfett
Copy link
Member

The current documentation about Span.isRecording is:

    /// Returns true if this `Span` is recording information like events, attributes, status, etc.
    var isRecording: Bool { get }

Does that mean a Span implementation is allowed to drop all the events on the floor? Who consumes that property? Should clients read it before they try to attach massive amounts of data to the Span?

@ktoso
Copy link
Member

ktoso commented Jan 30, 2023

Since this package is not a concrete specific "complete specification" but tries to serve a few such ambigious docs will be somewhat an inherent problem 🤔

The origin of this is from otel: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#isrecording so you can refer to these semantics as the source of truth for most impl that actually exist today.

@ktoso ktoso added 0 - new Not sure yet if task is valid / going to be worked on t:docs Improvements or additions to documentation labels Jan 30, 2023
@ktoso ktoso modified the milestones: 1.0.0, 1.x Feb 24, 2023
@ktoso ktoso modified the milestones: 1.x, 1.1.x May 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
0 - new Not sure yet if task is valid / going to be worked on t:docs Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants