-
Notifications
You must be signed in to change notification settings - Fork 1.2k
[DOCS-11406] Clean up inaccurate mentions of metrics #30424
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
base: master
Are you sure you want to change the base?
[DOCS-11406] Clean up inaccurate mentions of metrics #30424
Conversation
✅ Documentation Team ReviewThe documentation team has approved this pull request. Thank you for your contribution! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approving this for now so it's not blocked, but I have a suggestion on the terminology.
It looks like the goal was to separate the new RUM without Limits metrics from raw event data, which makes sense. However, completely replacing the word 'metric' might be an overcorrection that makes things less clear for users.
For example, directly replacing metrics with "telemetry" seems a bit too vague. Our users understand telemetry to mean logs, metrics, traces, but in these examples they are still referring to specific metrics.
What if we standardized on this rule instead?
- We keep calling the event-level data (like
view.time_spent
) metrics. - We call the aggregated
rum.measure.*
data Performance Metrics.
I think this would create the intended distinction while still using terms our users know.
content/en/real_user_monitoring/mobile_and_tv_monitoring/android/data_collected.md
Outdated
Show resolved
Hide resolved
content/en/real_user_monitoring/mobile_and_tv_monitoring/android/data_collected.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suggested some changes on /browser/data_collected.md
. Could you apply the comments also to the iOS, Android, React Native, Flutter, Roku, and Unity pages please?
Thanks a lot 🙇
content/en/real_user_monitoring/browser/monitoring_page_performance.md
Outdated
Show resolved
Hide resolved
content/en/real_user_monitoring/platform/dashboards/performance.md
Outdated
Show resolved
Hide resolved
content/en/real_user_monitoring/platform/dashboards/performance.md
Outdated
Show resolved
Hide resolved
content/en/real_user_monitoring/platform/dashboards/testing_and_deployment.md
Outdated
Show resolved
Hide resolved
content/en/real_user_monitoring/platform/dashboards/testing_and_deployment.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Maël Lilensten <mael.lilensten@datadoghq.com>
Co-authored-by: Maël Lilensten <mael.lilensten@datadoghq.com>
@MaelNamNam - Thanks for your replies! That got me thinking some more, so I did some digging. I found that the term
With that in mind, it seems like we could adopt this term here? For example:
What do you think about this? All good either way! Just wanted to offer another idea. Thanks! 🫡 |
@brett0000FF measure is not a bad idea, I'm just wondering wether it could cause additional confusion with "RUM Measure", which is one of the new SKUs we introduced with the launch of RUM without Limits. |
@MaelNamNam - Noted! Good point. Our terminology debt definitely makes these challenges tricky. 😅 |
Haha and wait till we start tackling miss-usage of |
What does this PR do? What is the motivation?
Received internal feedback that "metrics" is being used incorrectly in several areas in
~/browser/data_collected
. This is a sweep and check for inaccurate usage of metric/metrics throughout the docs, since metrics now exist with the introduction of RUM without Limits.Merge instructions
Merge readiness:
For Datadog employees:
Your branch name MUST follow the
<name>/<description>
convention and include the forward slash (/
). Without this format, your pull request will not pass CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.If your branch doesn't follow this format, rename it or create a new branch and PR.
[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.
Additional notes