-
Notifications
You must be signed in to change notification settings - Fork 888
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
Add specs on DistributedContext and propagation. #97
Add specs on DistributedContext and propagation. #97
Conversation
e4d9179
to
7291575
Compare
The order of entries is not significant. The iterator MUST not modify the underlying collection of | ||
entries in this `DistributedContext`. | ||
|
||
## GetEntryValue |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be GetEntry
? GetEntryValue
seems to return the EntryValue
which doesn't include the EntryMetadata
.
DistributedContext.GetEntry('name').EntryMetadata
DistributedContext.GetEntry('name').EntryValue
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The operations are from Java APIs (https:/open-telemetry/opentelemetry-java/blob/master/api/src/main/java/io/opentelemetry/distributedcontext/DistributedContext.java) and currently there isn't an API GetEntry
. I think it makes sense to have this GetEntry
API that looks up entries by name - would like to hear others' opinions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please file an issue with suggestion of a better name.
c91b83d
to
90a08e8
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With a few suggestions
@@ -2,6 +2,12 @@ | |||
An `Entry` is used to label anything that is associated | |||
with a specific operation, such as an HTTP request. | |||
|
|||
`DistributedContext` is an abstract data type that represents collection of entries. | |||
i.e., each key is associated with exactly one value. `DistributedContext` is serializable, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is meant by key? It's not defined here when reading top to bottom. If it's what I think, then I would write: "DistributedContext
is an abstract data type that maps EntryKey
s to Entry
objects."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rephrased with Sergey's suggestion.
4b2b5a9
to
2a569ab
Compare
bd15397
to
3177d3f
Compare
Thanks for all the suggestions (really like the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
bcf2423
to
dfd2c8d
Compare
* Add specs on DistributedContext and propagation. * Clarify DistributedContext only includes entries. * Fix typos. * Apply suggestions. * Copy the description to terminology. * Example on propagation across boundaries.
* Remove RELEASING.md requirement * Apply PR suggestions * Make RELEASING.md optional * Removed unnecessary line * Update specification/repository.md Co-authored-by: Tyler Yahn <[email protected]> Co-authored-by: Tyler Yahn <[email protected]>
* Define Log Data model This is a proposal of a data model and semantic conventions that allow to represent logs from various sources: application log files, machine generated events, system logs, etc. Existing log formats can be unambiguously mapped to this data model. Reverse mapping from this data model is also possible to the extent that the target log format has equivalent capabilities. The purpose of the data model is to have a common understanding of what a log record is, what data needs to be recorded, transferred, stored and interpreted by a logging system. * Move content from Google Doc to markdown here * Address PR comments * Add Google Cloud Logging mapping * Address PR comments * Resolve Open Questions * Add ECS mapping * Address PR comments
Fixes #41.
Most are a copy-and-paste from https:/census-instrumentation/opencensus-specs/blob/master/tags/TagMap.md#tagmap by renaming
Tag
->Entry
andTagMap
->DistributedContext
./cc @c24t @dinooliva @mayurkale22 @rghetia