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

Add specs on DistributedContext and propagation. #97

Merged
merged 6 commits into from
Jun 11, 2019

Conversation

songy23
Copy link
Member

@songy23 songy23 commented Jun 10, 2019

Fixes #41.

Most are a copy-and-paste from https:/census-instrumentation/opencensus-specs/blob/master/tags/TagMap.md#tagmap by renaming Tag -> Entry and TagMap -> DistributedContext.

/cc @c24t @dinooliva @mayurkale22 @rghetia

The order of entries is not significant. The iterator MUST not modify the underlying collection of
entries in this `DistributedContext`.

## GetEntryValue
Copy link
Member

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

Copy link
Member Author

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.

Copy link
Member

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.

terminology.md Outdated Show resolved Hide resolved
Copy link
Member

@SergeyKanzhelev SergeyKanzhelev left a 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

specification/distributedcontext-api.md Outdated Show resolved Hide resolved
terminology.md Outdated Show resolved Hide resolved
@@ -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,
Copy link
Member

@Oberon00 Oberon00 Jun 11, 2019

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 EntryKeys to Entry objects."

Copy link
Member Author

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.

@songy23
Copy link
Member Author

songy23 commented Jun 11, 2019

Thanks for all the suggestions (really like the suggested change feature 💯 ). PTAL

Copy link
Member

@reyang reyang left a comment

Choose a reason for hiding this comment

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

LGTM.

@SergeyKanzhelev SergeyKanzhelev merged commit 3c6e841 into open-telemetry:master Jun 11, 2019
@songy23 songy23 deleted the distributedcontext-2 branch June 11, 2019 21:54
SergeyKanzhelev pushed a commit to SergeyKanzhelev/opentelemetry-specification that referenced this pull request Feb 18, 2020
* 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.
TuckTuckFloof pushed a commit to TuckTuckFloof/opentelemetry-specification that referenced this pull request Oct 15, 2020
rockb1017 pushed a commit to rockb1017/opentelemetry-specification that referenced this pull request Nov 18, 2021
* 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]>
carlosalberto pushed a commit to carlosalberto/opentelemetry-specification that referenced this pull request Oct 21, 2024
* 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
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.

Document Java API: DistributedContext API needs to be described
6 participants