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

Adding new Metrics Volume Management Doc #21935

Merged
merged 28 commits into from
Aug 2, 2024
Merged

Conversation

ijkaylin
Copy link
Contributor

What does this PR do? What is the motivation?

A new page describing the functionality of the metrics volume management page

Merge instructions

  • Please merge after reviewing

Additional notes

@ijkaylin ijkaylin requested a review from a team as a code owner February 23, 2024 21:23
@github-actions github-actions bot added the Images Images are added/removed with this PR label Feb 23, 2024
@hestonhoffman hestonhoffman added the editorial review Waiting on a more in-depth review label Feb 23, 2024
estherk15 and others added 3 commits March 13, 2024 12:51
* Create volume_management page for Metris

* Update volume_management

* Update volume_management

Added related assets / unqueried metrics sections

* Create volume

* Delete static/images/metrics/volume

* Create Test

* Add files via upload

Adding images for team filter, unqueried features

* Update volume_management

* Documentation editorial review suggestions

* Fix links

* Apply suggestions from code review

* Add Volume to left nav

---------

Co-authored-by: Kathy L <[email protected]>
@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Jul 1, 2024
Copy link
Contributor

github-actions bot commented Jul 1, 2024

Preview links (active after the build_preview check completes)

New or renamed files

@ijkaylin ijkaylin marked this pull request as draft July 9, 2024 20:39
ijkaylin added 5 commits July 10, 2024 13:31
Adding new Est CM usage graphs / ingestde sort column
Slowly iterating here
Updated structure
Copy link
Contributor

@estherk15 estherk15 left a comment

Choose a reason for hiding this comment

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

Looks good, let me know if you have any questions on my suggestions! I think we can publish by the end of the week.

content/en/metrics/volume.md Outdated Show resolved Hide resolved
Comment on lines +26 to +32
- What is my overall account's realtime estimated Indexed Custom Metrics usage?
- What is my overall account's realtime estimated Ingested Custom Metrics usage?
- What are the Top 500 largest Metrics without Limits configured metric names by Ingested Custom Metrics volume?
- What are the Top 500 largest metric names by Indexed Custom Metrics volume?
- What are the Top 500 spiking cardinality metric names?
- Which team owns these Top 500 metric names and is responsible for optimizing?
- Which metrics are actually valuable (or not) to my organization?
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- What is my overall account's realtime estimated Indexed Custom Metrics usage?
- What is my overall account's realtime estimated Ingested Custom Metrics usage?
- What are the Top 500 largest Metrics without Limits configured metric names by Ingested Custom Metrics volume?
- What are the Top 500 largest metric names by Indexed Custom Metrics volume?
- What are the Top 500 spiking cardinality metric names?
- Which team owns these Top 500 metric names and is responsible for optimizing?
- Which metrics are actually valuable (or not) to my organization?
- Your account's estimated Indexed Custom Metrics usage and Ingested Custom Metrics usage
- The Top 500 largest Metrics without Limits™ configured metric names by Ingested Custom Metrics volume
- The Top 500 largest metric names by Indexed Custom Metrics volume
- The Top 500 spiking cardinality metric names
- The team that owns and is responsible for optimizing metric names
- The metrics that are or are not valuable to your organization

Copy link
Contributor

Choose a reason for hiding this comment

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

After reading the whole page, I'm not sure we need this section. Your headers are very clear in what a reader can expect to gain from the Metrics Volume, and adding this puts more friction for a user to scroll through. Let me know what you think

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah agreed it adds a lot of overhead but we should assume that folks don't have patience to scroll vertically to read through the docs' headers -- an overview bulleted section of questions they can answer with this doc is present in other dd docs like logs' docs and other external docs too. Let's keep it

Comment on lines +28 to +30
- What are the Top 500 largest Metrics without Limits configured metric names by Ingested Custom Metrics volume?
- What are the Top 500 largest metric names by Indexed Custom Metrics volume?
- What are the Top 500 spiking cardinality metric names?
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a way to group these into one sentence? A short list of bullet points is easier to digest.

Suggested change
- What are the Top 500 largest Metrics without Limits configured metric names by Ingested Custom Metrics volume?
- What are the Top 500 largest metric names by Indexed Custom Metrics volume?
- What are the Top 500 spiking cardinality metric names?
- The largest metrics grouped by Indexed and Ingested Custom Metrics
- The Top 500 spiking cardinality metric names

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can we preserve it as 3 different questions? here's why:

  • Was hopeful we can keep this summary section framed as questions that customers would ask. And wanted to follow the example external docs' (see gdoc for governance guide) where they call out each individual functionality to emphasize the huge value the tool brings. Even if people gloss over the summary section, they'll at least see numerically that the page offers a lot.
  • Think it still makes sense to keep as separate bullets here because indexed vs ingested are separate SKUs.
  • conceptually my top 500 largest metric names by indexed volume are likely a different group of metrics and require a different user action to access than the top 500 spiking metric names.

content/en/metrics/volume.md Outdated Show resolved Hide resolved
content/en/metrics/volume.md Outdated Show resolved Hide resolved
content/en/metrics/volume.md Outdated Show resolved Hide resolved
content/en/metrics/volume.md Outdated Show resolved Hide resolved
content/en/metrics/volume.md Outdated Show resolved Hide resolved
content/en/metrics/volume.md Outdated Show resolved Hide resolved
content/en/metrics/volume.md Outdated Show resolved Hide resolved
@estherk15 estherk15 marked this pull request as ready for review August 2, 2024 13:28
@estherk15 estherk15 merged commit 9c5671e into master Aug 2, 2024
14 checks passed
@estherk15 estherk15 deleted the kathy.lin/metricsvolumepage branch August 2, 2024 19:06
rtrieu pushed a commit that referenced this pull request Sep 3, 2024
* Create volume_management page for Metris

* Update volume_management

* Update volume_management

Added related assets / unqueried metrics sections

* Create volume

* Delete static/images/metrics/volume

* Create Test

* Add files via upload

Adding images for team filter, unqueried features

* Update volume_management

* Documentation editorial review (#22185)

* Create volume_management page for Metris

* Update volume_management

* Update volume_management

Added related assets / unqueried metrics sections

* Create volume

* Delete static/images/metrics/volume

* Create Test

* Add files via upload

Adding images for team filter, unqueried features

* Update volume_management

* Documentation editorial review suggestions

* Fix links

* Apply suggestions from code review

* Add Volume to left nav

---------

Co-authored-by: Kathy L <[email protected]>

* Re-review of the overview

* Fix links for change alert monitor reference

* Update volume.md

Adding new Est CM usage graphs / ingestde sort column

* Add files via upload

* Update volume.md

Slowly iterating here

* Update volume.md

Updated structure

* Update volume.md

* Update content/en/metrics/volume.md

Co-authored-by: Esther Kim <[email protected]>

* Update content/en/metrics/volume.md

Co-authored-by: Esther Kim <[email protected]>

* Update content/en/metrics/volume.md

Co-authored-by: Esther Kim <[email protected]>

* Update content/en/metrics/volume.md

Co-authored-by: Esther Kim <[email protected]>

* Update content/en/metrics/volume.md

Co-authored-by: Esther Kim <[email protected]>

* Update content/en/metrics/volume.md

Co-authored-by: Esther Kim <[email protected]>

* Update content/en/metrics/volume.md

Co-authored-by: Esther Kim <[email protected]>

---------

Co-authored-by: Heston Hoffman <[email protected]>
Co-authored-by: Esther Kim <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Architecture Everything related to the Doc backend editorial review Waiting on a more in-depth review Images Images are added/removed with this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants