Add documentation for advanced metrics #320
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
eve-bright
reviewed
Feb 20, 2024
| [NOTE] | ||
| ==== | ||
| Some charts can be toggled between absolute and relative values using the *%* toggle. | ||
| ==== |
There was a problem hiding this comment.
I think this note would be better at the end of the section in terms of flow.
There was a problem hiding this comment.
I don't like that that would put it under last subheading 🤔 Perhaps I could move it up to the end of the first section?
There was a problem hiding this comment.
I am/was considering adding a section on "chart interactions" that would include:
- % toggle
- Disabling data series
- Zooming
But I feel like they're mostly pretty self explanatory.
There was a problem hiding this comment.
Yeah - I think so too. And probably more confusing to try to describe them!
Bottom of the first section works for me.
modules/ROOT/pages/auradb/managing-databases/advanced-metrics.adoc
Outdated
Show resolved
Hide resolved
SaschaPeukert
suggested changes
Feb 20, 2024
modules/ROOT/pages/auradb/managing-databases/advanced-metrics.adoc
Outdated
Show resolved
Hide resolved
modules/ROOT/pages/auradb/managing-databases/advanced-metrics.adoc
Outdated
Show resolved
Hide resolved
eve-bright
approved these changes
Mar 6, 2024
Specifically call out the memory and storage charts
eve-bright
approved these changes
Mar 12, 2024
Editing to one sentence per line
|
Thanks for the documentation updates. The preview documentation has now been torn down - reopening this PR will republish it. |
fiquick
approved these changes
Mar 19, 2024
| . Select the *Metrics* tab. | ||
| . Select the *Advanced metrics* button. | ||
|
|
||
| The presented metrics will be laid out across three tabs according to their category: |
There was a problem hiding this comment.
Suggested change
| The presented metrics will be laid out across three tabs according to their category: | |
| The presented metrics are laid out across three tabs according to their category: |
|
|
||
| * *Expand* - Offers a better view of a particular metric by expanding the chart to take up all the available screen estate. | ||
|
|
||
| * *More info* - Selecting *More info* brings up an explanation of the particular metric. For some metrics it also provides hints about possible actions to take if that metric falls outside the expected range. |
There was a problem hiding this comment.
Suggested change
| * *More info* - Selecting *More info* brings up an explanation of the particular metric. For some metrics it also provides hints about possible actions to take if that metric falls outside the expected range. | |
| * *More info* - Selecting *More info* brings up an explanation of the particular metric. | |
| For some metrics it also provides hints about possible actions to take if that metric falls outside the expected range. |
|
|
||
| === Zoom | ||
|
|
||
| To zoom in to a narrower time interval, select and drag inside any chart to select your desired time interval. The data will automatically update to match the increased resolution. |
There was a problem hiding this comment.
Suggested change
| To zoom in to a narrower time interval, select and drag inside any chart to select your desired time interval. The data will automatically update to match the increased resolution. | |
| To zoom in to a narrower time interval, select and drag inside any chart to select your desired time interval. | |
| The data is automatically updated to match the increased resolution. |
Always use present tense and one sentence per line.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds documentation for the Ops Manager team's upcoming Aura feature - Advanced Metrics.