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.

Sign up for GitHub

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

Jump to bottom

Update Documentation for Internal Metric Naming Conventions #5178

Merged
merged 13 commits into from
Sep 13, 2024
Merged

Update Documentation for Internal Metric Naming Conventions #5178

merged 13 commits into from
Sep 13, 2024

Conversation

Tharanishwaran
Copy link
Contributor

@Tharanishwaran Tharanishwaran commented Sep 10, 2024 •
edited
Loading

This PR updates the documentation to clarify the internal metric naming conventions for the OpenTelemetry Collector.

Changes:
Added a note to explain:
1.Starting from v0.106.1: Metrics from Collector components are prefixed with otelcol_, while metrics from
instrumentation libraries are not prefixed.

          2.Versions before v0.106.1: All internal metrics, regardless of their source, had the otelcol_ prefix.

This update ensures that users understand the changes in metric naming conventions across different versions of the Collector.

Related Issue:
Fixes #4933

@Tharanishwaran Tharanishwaran requested a review from a team September 10, 2024 19:51
@linux-foundation-easycla Linux Foundation: EasyCLA
Copy link

linux-foundation-easycla bot commented Sep 10, 2024 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

@opentelemetrybot opentelemetrybot requested review from a team and jpkrohling and removed request for a team September 10, 2024 19:51
@opentelemetrybot opentelemetrybot requested a review from a team September 10, 2024 19:56
@Tharanishwaran Tharanishwaran changed the title Update Documentation for Internal Metric Naming Conventions #4933 Clarify Internal Metric Naming Conventions in Documentation Sep 10, 2024
@Tharanishwaran Tharanishwaran changed the title Clarify Internal Metric Naming Conventions in Documentation Update Documentation for Internal Metric Naming Conventions Sep 10, 2024
tiffany76
tiffany76 requested changes Sep 10, 2024
View reviewed changes
Copy link
Contributor

@tiffany76 tiffany76 left a comment

Choose a reason for hiding this comment

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

Great job! I added short code formatting for the call-out to match others on the page.

I also think this note would be better placed further down where the list of metrics occurs. Right about line 189 should do it.

content/en/docs/collector/internal-telemetry.md Outdated Show resolved Hide resolved
content/en/docs/collector/internal-telemetry.md Outdated Show resolved Hide resolved
@Tharanishwaran
Copy link
Contributor Author

Hi @tiffany76,
I have realized that some unintended commits were included in this pull request. I apologize for the oversight and any inconvenience this may have caused. I will address this issue promptly by removing the extraneous commits and ensuring that only the intended changes remain.

@tiffany76
Copy link
Contributor

/fix:format

@opentelemetrybot
Copy link
Collaborator

You triggered fix:format action run at https://github.com/open-telemetry/opentelemetry.io/actions/runs/10819988623

@opentelemetrybot
Copy link
Collaborator

fix:format was successful.

IMPORTANT: (RE-)RUN /fix:all to ensure that there are no remaining check issues.

@tiffany76
Copy link
Contributor

LGTM, @Tharanishwaran! Thanks for your contribution.

@open-telemetry/collector-approvers, PTAL.

codeboten
codeboten reviewed Sep 11, 2024
View reviewed changes
Copy link
Contributor

@codeboten codeboten left a comment

Choose a reason for hiding this comment

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

Thanks @Tharanishwaran! Added a note, the prefix was not applied to internal metrics emitted via OTLP

content/en/docs/collector/internal-telemetry.md Outdated Show resolved Hide resolved
@Tharanishwaran @codeboten
Update content/en/docs/collector/internal-telemetry.md
d6c5b04 
Co-authored-by: Alex Boten <223565+codeboten@users.noreply.github.com>
@opentelemetrybot opentelemetrybot requested a review from a team September 12, 2024 02:47
@Tharanishwaran
Copy link
Contributor Author

Many thanks to @tiffany76, @codeboten for your useful comments and taking the time to review the changes. I am glad that the checks passed and the PR finally got approval. If possible, one of the maintainers kindly goes ahead and merges the PR. Truly I appreciate the time and your support

@songy23
Copy link
Member

songy23 commented Sep 12, 2024

Thank you @Tharanishwaran for calling it out, we have run into the same issue in 0.106 & 0.107

@Tharanishwaran @songy23
Update content/en/docs/collector/internal-telemetry.md
3fb40d4 
Co-authored-by: Yang Song <songy23@users.noreply.github.com>
@opentelemetrybot opentelemetrybot requested a review from a team September 12, 2024 17:26
@Tharanishwaran
Copy link
Contributor Author

Thank you @songy23 for your comment I’ve implemented the suggested change regarding the otelcol_ prefix

tiffany76
tiffany76 reviewed Sep 12, 2024
View reviewed changes
Copy link
Contributor

@tiffany76 tiffany76 left a comment

Choose a reason for hiding this comment

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

One tiny change.

content/en/docs/collector/internal-telemetry.md Outdated Show resolved Hide resolved
@opentelemetrybot opentelemetrybot requested a review from a team September 12, 2024 20:40
@tiffany76
Copy link
Contributor

/fix:format

@opentelemetrybot
Copy link
Collaborator

You triggered fix:format action run at https://github.com/open-telemetry/opentelemetry.io/actions/runs/10838462302

@opentelemetrybot
Copy link
Collaborator

fix:format was successful.

IMPORTANT: (RE-)RUN /fix:all to ensure that there are no remaining check issues.

@Tharanishwaran
Copy link
Contributor Author

/fix:all

@opentelemetrybot
Copy link
Collaborator

You triggered fix:all action run at https://github.com/open-telemetry/opentelemetry.io/actions/runs/10842811641

@opentelemetrybot
Copy link
Collaborator

fix:all was successful.

IMPORTANT: (RE-)RUN /fix:all to ensure that there are no remaining check issues.

@Tharanishwaran Tharanishwaran mentioned this pull request Sep 13, 2024
Closed
@svrnm svrnm added this pull request to the merge queue Sep 13, 2024
Merged via the queue into open-telemetry:main with commit 2ef1279 Sep 13, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@codeboten codeboten codeboten left review comments

@tiffany76 tiffany76 tiffany76 approved these changes

@songy23 songy23 songy23 approved these changes

@jpkrohling jpkrohling Awaiting requested review from jpkrohling

Assignees
No one assigned
Labels
sig:collector
Projects
SIG Comms: PRs & Issues
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Clarify Collector internal metric names by version
6 participants
@Tharanishwaran @tiffany76 @opentelemetrybot @songy23 @codeboten @svrnm