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

[Documentation] Update docs for selecting specific tags of a metric instrument #5017

Merged
merged 2 commits into from
Nov 2, 2023

Conversation

jwreford99
Copy link
Contributor

This is my first attempted contribution to this repo, most of the guidelines seem to focus around code changes, when I just wanted to add a little extra detail to some documentation! If the format I've done this in is egregiously wrong apologies, just trying to be useful as this confused me for a while.

Changes

The documentation for selecting specific tags on instruments is clear about the tags that are dropped, but isn't super clear on the aggregation side (i.e. what do the resulting values look like when you've dropped the tags).

I ended up going all the way back to #2442 to be 100% confident that it is doing what I was expecting.

Therefore, I figured it would be worth bringing that brief summary to the docs as well. I've tried to be concise and clear, but v happy for feedback if I've done it horribly wrong!

Merge requirement checklist

  • CONTRIBUTING guidelines followed (nullable enabled, static analysis, etc.)

Edit `customizing-the-sdk` page to give more detail about the outcome of tag dropping
@jwreford99 jwreford99 requested a review from a team November 2, 2023 09:10
Copy link

linux-foundation-easycla bot commented Nov 2, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: jwreford99 / name: Julian Wreford (70722be)
  • ✅ login: utpilla / name: Utkarsh Umesan Pillai (afc9573)

@jwreford99
Copy link
Contributor Author

Sorting out CLA with my employer ASAP 😄

@jwreford99 jwreford99 marked this pull request as draft November 2, 2023 10:05
@jwreford99 jwreford99 marked this pull request as ready for review November 2, 2023 16:45
@utpilla
Copy link
Contributor

utpilla commented Nov 2, 2023

@jwreford99 Thanks for sending the PR! I really appreciate the due diligence you exercised to update the documentation!

@utpilla utpilla merged commit defaffa into open-telemetry:main Nov 2, 2023
36 checks passed
@jwreford99 jwreford99 deleted the patch-1 branch November 3, 2023 08:42
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.

2 participants