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

Add documentation for advanced metrics #320

Merged
merged 17 commits into from
Mar 19, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions modules/ROOT/content-nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ AuraDB Start
* Managing instances
** xref:auradb/managing-databases/monitoring.adoc[]
** xref:auradb/managing-databases/advanced-metrics.adoc[]
** xref:auradb/managing-databases/backup-restore-export.adoc[]
** xref:auradb/managing-databases/database-actions.adoc[]
Expand Down Expand Up @@ -81,6 +82,7 @@ AuraDS Start
* Managing instances
** xref:aurads/managing-instances/monitoring.adoc[]
** xref:aurads/managing-instances/advanced-metrics.adoc[]
** xref:aurads/managing-instances/backup-restore-export.adoc[]
** xref:aurads/managing-instances/instance-actions.adoc[]
////
Expand Down
66 changes: 66 additions & 0 deletions modules/ROOT/pages/auradb/managing-databases/advanced-metrics.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
[[aura-monitoring]]
= Advanced metrics

label:AuraDB-Professional[]
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:
Copy link
Collaborator

Choose a reason for hiding this comment

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

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:


* *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 options

[NOTE]
====
Some charts can be toggled between absolute and relative values using the *%* toggle.
====
Copy link
Contributor

Choose a reason for hiding this comment

The 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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The 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?

Copy link
Contributor Author

Choose a reason for hiding this comment

The 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:

  • % toggle
  • Disabling data series
  • Zooming

But I feel like they're mostly pretty self explanatory.

Copy link
Contributor

Choose a reason for hiding this comment

The 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.


To access the chart options menu, select the *...* button on any chart.

=== 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.

=== Expand

*Expand* gives you 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.

== Aggregations

label:AuraDB-Enterprise[]

A database may be underpinned by more than one cluster member for increased resilience and performance.

Metrics coming from several cluster members will be aggregated. To convey a 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 summarized value of the metric across all cluster members.
48 changes: 48 additions & 0 deletions modules/ROOT/pages/aurads/managing-instances/advanced-metrics.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
[[aura-monitoring]]
= Advanced metrics

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 options

[NOTE]
====
Some charts can be toggled between absolute and relative values using the *%* toggle.
====

To access the chart options menu, select the *...* button on any chart.

=== 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.

=== Expand

*Expand* gives you 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.
Loading