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

Document collector's internal telemetry #10695

Merged

Conversation

codeboten
Copy link
Contributor

This documents is to provide guidelines for component authors when making decisions about what the telemetry of their components should look like in order to provide a consistent experience to end users.

Copy link

codecov bot commented Jul 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.60%. Comparing base (a09ec93) to head (c658593).
Report is 141 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #10695      +/-   ##
==========================================
- Coverage   92.39%   91.60%   -0.80%     
==========================================
  Files         403      404       +1     
  Lines       18744    18990     +246     
==========================================
+ Hits        17318    17395      +77     
- Misses       1066     1235     +169     
  Partials      360      360              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@codeboten codeboten added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Jul 22, 2024
@codeboten codeboten marked this pull request as ready for review July 22, 2024 16:20
@codeboten codeboten requested a review from a team as a code owner July 22, 2024 16:20
@codeboten codeboten requested a review from mx-psi July 22, 2024 16:20
@codeboten codeboten added this to the Self observability milestone Jul 22, 2024
docs/rfcs/internal-telemetry.md Outdated Show resolved Hide resolved
docs/rfcs/internal-telemetry.md Outdated Show resolved Hide resolved
to provide this information. The information in this document will be updated once
the OTEP lands to follow its recommendations.

## Internal telemetry properties
Copy link
Member

Choose a reason for hiding this comment

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

Could we get away with adding everything from this point on to the observability.md and call it a day? This accurately describes our existing telemetry expectations.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Moved, please take a look

docs/rfcs/internal-telemetry.md Outdated Show resolved Hide resolved
docs/rfcs/internal-telemetry.md Outdated Show resolved Hide resolved
docs/rfcs/internal-telemetry.md Outdated Show resolved Hide resolved
docs/rfcs/internal-telemetry.md Outdated Show resolved Hide resolved
docs/rfcs/internal-telemetry.md Outdated Show resolved Hide resolved
docs/rfcs/internal-telemetry.md Outdated Show resolved Hide resolved
@arminru arminru added the collector-telemetry healthchecker and other telemetry collection issues label Jul 30, 2024
Copy link
Contributor

This PR was marked stale due to lack of activity. It will be closed in 14 days.

@github-actions github-actions bot added Stale and removed Stale labels Aug 14, 2024
@codeboten codeboten changed the title RFC for collector's internal telemetry Document collector's internal telemetry Aug 16, 2024
@codeboten
Copy link
Contributor Author

Decided to try @TylerHelmuth's suggestion of moving the details of the current state of telemetry into observability.md instead of creating a separate doc. Since it's just documenting what's already there, i think that makes more sense.

docs/observability.md Outdated Show resolved Hide resolved
docs/observability.md Outdated Show resolved Hide resolved
docs/observability.md Outdated Show resolved Hide resolved
docs/observability.md Outdated Show resolved Hide resolved
docs/observability.md Outdated Show resolved Hide resolved
@codeboten
Copy link
Contributor Author

@djaglowski can you take a look, want to make sure your comments are addressed

@codeboten codeboten merged commit f1fe602 into open-telemetry:main Aug 20, 2024
36 checks passed
@codeboten codeboten deleted the codeboten/rfc-telemetry-guidelines branch August 20, 2024 18:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
collector-telemetry healthchecker and other telemetry collection issues Skip Changelog PRs that do not require a CHANGELOG.md entry Skip Contrib Tests
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

5 participants