Skip to content
This repository has been archived by the owner on May 23, 2023. It is now read-only.

Docs reference outdated API #362

Open
AdrianSchneble opened this issue Oct 16, 2019 · 3 comments
Open

Docs reference outdated API #362

AdrianSchneble opened this issue Oct 16, 2019 · 3 comments

Comments

@AdrianSchneble
Copy link

AdrianSchneble commented Oct 16, 2019

The "Scopes" doc references Tracer.SpanBuilder.startActiveSpan(boolean finishOnClose), which does not match the latest version of OpenTracing.

As far as I can tell, the default is now simply that every span is set as active when .started. Regardless, the docs should be changed to reflect the latest version.

This is not the only issue with the docs, there are also numerous other examples of outdated example code (in the "Scopes" doc or other sections of the docs).

I'm aware that OpenTracing is merging with OpenCensus into OpenTelemetry, but I don't think that's an "excuse" for incorrect documentation (insofar as voluntary contributors have to make "excuses").

@whiskeysierra
Copy link

As far as I can tell, the default is now simply that every span is set as active when .started.

That is not correct. The pattern is that span lifecycle (start/finish) is now properly separated from scope lifecycle (activate/close).

@MxKaras
Copy link

MxKaras commented Nov 22, 2019

Given the changes, I'm trying to think under what conditions one would want to manage a scope's lifecycle. Is there any need to pay attention to it now?

@whiskeysierra
Copy link

Scopes are optional and users should be very interested in controlling the timeframe in which a span is active. It's not something that anyone should ignore.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants