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

Updates to http_protocol_proposal_v1.md #14

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

nizarq
Copy link

@nizarq nizarq commented Jun 1, 2017

Found some small trivial errors reading the document.

Found some small trivial errors reading the document.
@@ -62,7 +62,7 @@ Implementation MUST provide read access to `Correlation-Context` for logging sys

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

when you say Implementation MUST provide read access to Correlation-Context for logging systems and MUST support adding properties to Correlation-Context. that feels a little confusing, because throughout the document you say Correlation-Context is read-only, which implies properties cannot be added to the collection. I think what you really mean is existing properties in the collection should be treated as read only but new properties are allowed.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

I think our guidance here is a bit different:

  1. First service should define correlation context.
  2. Next service(s) MUST propagate it further without modifying properties, and SHOULD NOT add other properties.

So the Correlation-Context is indeed read only for every service except the first one, but it is not a strict requirement.

Implementation does not really know which service is the first one so it must allow to add properties anyway.

I agree that I should be more clear about it in the spec. BTW, there is an open PR to move this protocol to .net core repo. I'll do your changes there and also improve description.
Once PR is merged, I'll change this doc to refer to the corefx repo.

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

Successfully merging this pull request may close these issues.

2 participants