-
Notifications
You must be signed in to change notification settings - Fork 20
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
Add documentation for advanced metrics #320
Changes from all commits
732ee82
a2e2b1b
fd294ba
d640ab4
bb74519
ae61dec
7e95d9d
e49c802
3edf7b6
802465e
f0af7fd
93cf71b
438cd3c
28222df
4b082e1
582abe7
9d6e48b
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 |
---|---|---|
@@ -0,0 +1,82 @@ | ||
[[aura-monitoring]] | ||
= Advanced metrics | ||
|
||
label:AuraDB-Enterprise[] | ||
|
||
Advanced metrics is a feature that enables access to a broad range of different instance and database metrics. | ||
|
||
To access *Advanced metrics*: | ||
|
||
. Navigate to the https://console.neo4j.io/?product=aura-db[Neo4j Aura Console] in your browser. | ||
. Select the instance you want to access. | ||
. Select the *Metrics* tab. | ||
. Select the *Advanced metrics* button. | ||
|
||
The presented metrics will be laid out across three tabs according to their category: | ||
|
||
* *Resources* - Overall system resources, such as CPU, RAM and disk usage. | ||
* *Instance* - Information about the Neo4j instance(s) running the database. | ||
* *Database* - Metrics concerning the database itself, such as usage statistics and entity counts. | ||
|
||
When viewing metrics, you can select from the following time intervals: | ||
|
||
* 30 minutes | ||
* 6 hours | ||
* 24 hours | ||
* 3 days | ||
* 7 days | ||
* 14 days | ||
* 30 days | ||
|
||
== Chart interactions | ||
|
||
[NOTE] | ||
==== | ||
Memory and storage charts can be toggled between absolute and relative values using the *%* toggle. | ||
==== | ||
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. I think this note would be better at the end of the section in terms of flow. 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. 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I am/was considering adding a section on "chart interactions" that would include:
But I feel like they're mostly pretty self explanatory. 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. Yeah - I think so too. And probably more confusing to try to describe them! Bottom of the first section works for me. |
||
|
||
=== Toggle data series | ||
|
||
label:AuraDB-Enterprise[] | ||
|
||
To hide or show individual data series, select the corresponding data series in the legend below the chart. | ||
|
||
=== 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. | ||
|
||
To reset zoom, double-click anywhere inside the chart or use the option in the context menu. | ||
|
||
=== Expand | ||
|
||
Any chart can be expanded to take up all the available screen estate by clicking the *expand* button (shown as two opposing arrows). | ||
To exit this mode, click the *x* button on the expanded view. | ||
|
||
=== Context menu | ||
|
||
To access the chart context menu, select the *...* button on any chart. | ||
|
||
* *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. | ||
|
||
* *Reset zoom* - If the zoom level has been altered by selecting and dragging across a chart, *Reset zoom* resets the zoom back to the selected interval. | ||
|
||
== Aggregations | ||
|
||
label:AuraDB-Enterprise[] | ||
|
||
Most metrics will have several values for a given timestamp because of the following reasons: | ||
|
||
* Multiple database replicas | ||
* Compressing several data points into one, depending on zoom level | ||
|
||
Aggregating functions are used to reconcile metrics having multiple data points and make the most sense of that particular metric. | ||
To convey an even more detailed picture of the state of the system, several aggregations can be shown. | ||
|
||
The possible aggregations are: | ||
|
||
* *Min* - The minimum value of the metric across all cluster members. | ||
* *Max* - The maximum value of the metric across all cluster members. | ||
* *Average* - The average value of the metric across all cluster members. | ||
* *Sum* - The sum of the metric across all cluster members. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
[[aura-monitoring]] | ||
= Advanced metrics | ||
|
||
label:AuraDS-Enterprise[] | ||
|
||
Advanced metrics is a feature that enables access to a broad range of different instance and database metrics. | ||
|
||
To access *Advanced metrics*: | ||
|
||
. Navigate to the https://console.neo4j.io/?product=aura-db[Neo4j Aura Console] in your browser. | ||
. Select the instance you want to access. | ||
. Select the *Metrics* tab. | ||
. Select the *Advanced metrics* button. | ||
|
||
The presented metrics will be laid out across three tabs according to their category: | ||
|
||
* *Resources* - Overall system resources, such as CPU, RAM and disk usage. | ||
* *Instance* - Information about the Neo4j instance(s) running the database. | ||
* *Database* - Metrics concerning the database itself, such as usage statistics and entity counts. | ||
|
||
When viewing metrics, you can select from the following time intervals: | ||
|
||
* 30 minutes | ||
* 6 hours | ||
* 24 hours | ||
* 3 days | ||
* 7 days | ||
* 14 days | ||
* 30 days | ||
|
||
== Chart interactions | ||
|
||
[NOTE] | ||
==== | ||
Memory and storage charts can be toggled between absolute and relative values using the *%* toggle. | ||
==== | ||
SeBBBe marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
=== 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. | ||
|
||
To reset zoom, double-click anywhere inside the chart or use the option in the context menu. | ||
|
||
=== Expand | ||
|
||
Any chart can be expanded to take up all the available screen estate by clicking the *expand* button (shown as two opposing arrows). | ||
To exit this mode, click the *x* button on the expanded view. | ||
|
||
=== Context menu | ||
|
||
To access the chart context menu, select the *...* button on any chart. | ||
|
||
* *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. | ||
|
||
* *Reset zoom* - If the zoom level has been altered by selecting and dragging across a chart, *Reset zoom* resets the zoom back to the selected interval. |
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.