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 OpenTelemetry API package layout #86

Merged
merged 4 commits into from
Jun 10, 2019

Conversation

mayurkale22
Copy link
Member

@mayurkale22 mayurkale22 commented Jun 8, 2019

├── trace
│ ├── propagation # headers that are the public API for trace propagation, using different encodings.
│ └── samplers # is used to make decisions on `Span` sampling.
├── distributedcontext
Copy link
Member

Choose a reason for hiding this comment

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

Does distributedcontext intend to cover local context (in-process propagation) as well?
If yes, suggest to consider context.

Copy link
Member

Choose a reason for hiding this comment

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

looks like a hot topic for the Tuesday specification group call =)

Copy link
Member

Choose a reason for hiding this comment

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

Based on the current Java reference implementation context (in-process) is a separate package, probably we should keep it that way as we discussed (currently we document the way java reference implementation did then later change if we agree otherwise).

Copy link
Member

Choose a reason for hiding this comment

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

missed this. @mayurkale22 can you please fix?

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

@@ -0,0 +1,56 @@
# OpenTelemetry Project Package Layout
Copy link
Member

Choose a reason for hiding this comment

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

@mayurkale22 great document!

### `/internal` (_Optional_)
Private application and library code.

### `/log` (_In the future_)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
### `/log` (_In the future_)
### `/logs` (_In the future_)

I think it will be plural. Like metrics and resources

Copy link
Member

Choose a reason for hiding this comment

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

I think log (singular) is a convention as package name? /cc @reyang

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.

Generally great. Few suggestions, please fix before this can be merged

Copy link
Member

@songy23 songy23 left a comment

Choose a reason for hiding this comment

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

LGTM overall

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 f4eac5c into open-telemetry:master Jun 10, 2019
SergeyKanzhelev pushed a commit to SergeyKanzhelev/opentelemetry-specification that referenced this pull request Feb 18, 2020
* Add basic package layout

* Fix review comments

* Add context package
TuckTuckFloof pushed a commit to TuckTuckFloof/opentelemetry-specification that referenced this pull request Oct 15, 2020
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
…etry#86)

* Explicitly forbid granting any permissions to individuals

According to GDI security guidelines.

* Update specification/repository.md

Co-authored-by: Robert Pająk <[email protected]>

Co-authored-by: Robert Pająk <[email protected]>
carlosalberto pushed a commit to carlosalberto/opentelemetry-specification that referenced this pull request Oct 31, 2024
* Add basic package layout

* Fix review comments

* Add context package
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.

Package structure common description
5 participants