Clarification needed for IsRecording section of trace API #1507
Labels
area:api
Cross language API specification issue
spec:trace
Related to the specification/trace directory
The IsRecording section of the Span operations contains the following two paragraphs:
The subject of these two paragraphs is a flag which has not been introduced in previous paragraphs of the section. To further complicate the situation, this idea of recording is often associated (sometimes erroneously) with the idea of sampling which is a concept that is tracked by flags. This makes this section of the specification difficult for those without the context of the author to understand.
My guess at the original intent is that the flag referred to here is actually just the returned value of the method. These paragraphs were introduced in [this PR]. It looks like that PR removed the old first sentence of the section:
and replaced it with a sentence not mentioning the returned value should be called a flag. Though I would appreciate help from @SergeyKanzhelev to confirm or correct this.
Once an understood meaning of these sections is reached the specification needs to be updated to clarify this language.
The text was updated successfully, but these errors were encountered: