-
Notifications
You must be signed in to change notification settings - Fork 1.3k
[DO NOT MERGE] Test fixture: editorial issues for dashboard review composer #38672
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -8,10 +8,10 @@ is_beta: false | |||||
| Time aggregation `(.rollup(<aggregator>, <time interval>)` and how it works with distributions with percentile aggregations has changed. | ||||||
|
|
||||||
| ## Does this update to rollup change the values of my existing queries on distributions with percentiles? | ||||||
| No - your existing queries are unaffected. The `.rollup <aggregator>` parameter has been removed because it had no effect on query results but caused user confusion for how the resulting value was calculated. | ||||||
| No - your existing queries are unaffected. We removed the `.rollup <aggregator>` parameter in order to reduce confusion, since it had no effect on query results but caused user confusion for how the resulting value was calculated. | ||||||
|
buraizu marked this conversation as resolved.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "In order to" is wordier than "to," the sentence mentions confusion twice, and the switch to first-person "We removed" introduces a voice inconsistent with the rest of the page.
Suggested change
|
||||||
|
|
||||||
| ## What has been updated for distributions with percentiles? | ||||||
| You no longer need to specify an additional time aggregator (as in `.rollup(avg)`) when you've already selected `p50`, `p75`, `p90`, `p95`, or `p99`. You only need to specify a rollup `<time interval>` which determines the interval of time your data is aggregated over. | ||||||
| You no longer need to utilize an additional time aggregator (as in `.rollup(avg)`) when you've already selected `p50`, `p75`, `p90`, `p95`, or `p99`. You only need to specify a rollup `<time interval>`, which easily determines the interval of time your data is aggregated over. | ||||||
|
buraizu marked this conversation as resolved.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "Utilize" should be "use." "Easily determines" is an odd modifier placement — it implies the interval itself does something "easily," rather than the parameter making configuration easy.
Suggested change
|
||||||
|
|
||||||
| {{< ui >}}Old UI{{< /ui >}} | ||||||
| {{< img src="metrics/faq/old-rollup-distUI.jpg" alt="Old Rollup UI">}} | ||||||
|
|
@@ -28,3 +28,7 @@ Unlike COUNT, GAUGE, and RATE metric types which aggregate first in time and the | |||||
|
|
||||||
| _Example: Suppose you're graphing on a dashboard timeframe of the Past 4 hours, p99:distribution.rollup(60)._ | ||||||
| Datadog merges the sketch data server-side to represent a rollup interval of a minute (for every minute within the dashboard timeframe of 4 hours). After the rollup is calculated, Datadog calculates a 99th percentile value for each minute interval. | ||||||
|
|
||||||
| ## Rollup Interval Best Practices | ||||||
|
|
||||||
| It is recommended that a rollup interval be chosen based on the range being queried. As described above, the rollup `<aggregator>` parameter no longer affects distributions queried with percentiles, so only the `<time interval>` needs to be specified. | ||||||
|
buraizu marked this conversation as resolved.
Comment on lines
+32
to
+34
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. test1 Suggested fix: test2 |
||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -10,15 +10,15 @@ further_reading: | |||||
|
|
||||||
| ## Why has my distribution metrics page been deprecated? | ||||||
|
|
||||||
| Datadog has released a new pipeline for calculating globally accurate percentiles for your distribution metrics --- this unlocks more query functionality and an easier configuration workflow for distributions. | ||||||
| Datadog has released a new pipeline that you can utilize in order to calculate globally accurate percentiles for your distribution metrics. This gives you more query functionality and an easier configuration workflow for distributions. | ||||||
|
buraizu marked this conversation as resolved.
buraizu marked this conversation as resolved.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "Utilize" and "in order to" are both unnecessarily wordy substitutes for "use" and "to."
Suggested change
|
||||||
|
|
||||||
| ## How does this new pipeline for Distributions affect me? | ||||||
|
|
||||||
| - **Unlocks new query functionalities:** | ||||||
| - Accurate percentiles in time for any historical timeframe (such as the past day, week, or month). | ||||||
| - Boolean filtered queries are now available with distribution metrics with percentiles, so that you can write queries like: `p99:request_latency_distribution{app:A OR app:B} by {app}`. | ||||||
| - **Easier tag configuration and percentile aggregation workflows**: | ||||||
| - All tag configuration-percentile aggregations are managed in one centralized location on the [Metrics Summary][1] page. | ||||||
| - All tag configuration-percentile aggregations are managed in one centralized location on the [Metrics Summary][1] page, so you can easily leverage them across your organization. | ||||||
|
buraizu marked this conversation as resolved.
buraizu marked this conversation as resolved.
buraizu marked this conversation as resolved.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "Leverage" is jargon for "use," and "easily" is an unnecessary filler adverb that doesn't add information.
Suggested change
|
||||||
| - Use the {{< ui >}}Manage Tags{{< /ui >}} button on the Metrics Summary details side panel to manage the queryable tags configuration for a distribution metric. | ||||||
| - To add percentile aggregations to your distribution, navigate to the new percentiles section on the side panel, click {{< ui >}}Edit{{< /ui >}} and select {{< ui >}}Include{{< /ui >}} for percentile aggregations on the same queryable tags defined on your baseline distribution. You'll no longer need to specify an additional configuration rule. | ||||||
| - **More intuitive number of custom metrics from distributions with percentiles**: | ||||||
|
|
@@ -34,7 +34,7 @@ Datadog has released a new pipeline for calculating globally accurate percentile | |||||
|
|
||||||
| {{< img src="metrics/faq/sketch-db-migration-faq/configure-tags.png" alt="Configure tags">}} | ||||||
|
|
||||||
| Click the {{< ui >}}Manage Tags{{< /ui >}} button to configure which tags are queryable on a particular metric. You can preview the new number of indexed custom metrics from your tag configuration before saving it. | ||||||
| Click the {{< ui >}}Manage Tags{{< /ui >}} button to configure which tags are queryable on a particular metric. Our UI allows you to preview the new number of indexed custom metrics from your tag configuration before it is saved by you. | ||||||
|
buraizu marked this conversation as resolved.
buraizu marked this conversation as resolved.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "Our UI" uses first person where the rest of the page speaks directly to the reader about the product. "Before it is saved by you" is an awkward passive construction; the active form reads more naturally.
Suggested change
|
||||||
|
|
||||||
| {{< img src="metrics/faq/sketch-db-migration-faq/manage-tags.png" alt="Manage tags">}} | ||||||
|
|
||||||
|
|
@@ -44,10 +44,21 @@ Click {{< ui >}}Edit{{< /ui >}} and select {{< ui >}}Include{{< /ui >}} to inclu | |||||
|
|
||||||
| {{< img src="metrics/faq/sketch-db-migration-faq/add-percentiles.mp4" alt="Add percentiles to a distribution metric" video=true >}} | ||||||
|
buraizu marked this conversation as resolved.
|
||||||
|
|
||||||
| ## Percentile Configuration Best Practices | ||||||
|
|
||||||
| Percentiles should be configured only on the metrics where they are needed. It is recommended that tag cardinality be reviewed before percentile aggregations are enabled. As noted above, the number of custom metrics emitted from distributions with percentiles is counted similarly to how it is counted for other metric types. | ||||||
|
buraizu marked this conversation as resolved.
|
||||||
|
|
||||||
| ## How can I add percentiles to multiple Distribution metrics? | ||||||
|
|
||||||
| Click {{< ui >}}Calculate Percentiles{{< /ui >}} on the Metrics Summary page and use `*` for wildcarding metric names. | ||||||
|
|
||||||
| Keep the following in mind when you bulk-configure percentiles: | ||||||
|
buraizu marked this conversation as resolved.
|
||||||
|
|
||||||
| - wildcards match every metric name that fits the pattern | ||||||
| - Review the estimated custom metric count before you save. | ||||||
| - percentile aggregations count toward your custom metrics total | ||||||
| - impact on existing tag configurations | ||||||
|
buraizu marked this conversation as resolved.
Comment on lines
+57
to
+60
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The four list items mix grammatical forms (imperative, declarative, and a bare noun phrase) with inconsistent capitalization and end punctuation, making the list harder to scan. Suggested fix: Wildcards match every metric name that fits the pattern. |
||||||
|
|
||||||
| {{< img src="metrics/faq/sketch-db-migration-faq/bulk-percentiles.mp4" alt="Add percentiles to multiple distribution metrics" video=true >}} | ||||||
|
|
||||||
|
|
||||||
|
|
||||||
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.