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

Update documentation for span/3 #101

Merged
merged 2 commits into from Dec 13, 2021
Merged

Conversation

stefanchrobot
Copy link
Contributor

It wasn't really clear to me how SpanFunction works.

It wasn't really clear to me how `SpanFunction` works.
@stefanchrobot
Copy link
Contributor Author

%% When providing `StartMetadata' and `StopMetadata', these values will be sent independently to `start' and
%% `stop' events. If an exception occurs, exception metadata will be merged onto the `StartMetadata'. In general,
%% `StopMetadata' should only provide values that are additive to `StartMetadata' so that handlers, such as those
%% used for metrics, can rely entirely on the `stop' event.

This section is unclear to me. Can this be reworded into "stop metadata should be a superset of start metadata"?

josevalim
josevalim previously approved these changes Dec 2, 2021
@stefanchrobot
Copy link
Contributor Author

@josevalim sorry for the trouble, pushed a minor reword.

@stefanchrobot
Copy link
Contributor Author

@josevalim can you please have another look?

@josevalim josevalim merged commit cfbe641 into beam-telemetry:main Dec 13, 2021
@josevalim
Copy link
Contributor

💚 💙 💜 💛 ❤️

@stefanchrobot stefanchrobot deleted the patch-1 branch December 13, 2021 11:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants