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

Console #409

Closed
wants to merge 20 commits into from
Closed
Show file tree
Hide file tree
Changes from all 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: 1 addition & 1 deletion antora.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: aura
title: Neo4j Aura
version: ~
version: 'preview'
start_page: ROOT:index.adoc
nav:
- modules/ROOT/content-nav.adoc
180 changes: 75 additions & 105 deletions modules/ROOT/content-nav.adoc
Original file line number Diff line number Diff line change
@@ -1,111 +1,81 @@
////
Generic Start
////
* *Neo4j Aura*

* xref:index.adoc[Overview]

* xref:platform/create-account.adoc[]
* xref:platform/cloud-providers.adoc[Cloud provider marketplaces]

* Security
** xref:platform/security/secure-connections.adoc[]
** xref:platform/security/single-sign-on.adoc[]
** xref:platform/security/encryption.adoc[]

* xref:platform/user-management.adoc[]
* xref:platform/apoc.adoc[]
* xref:platform/metrics-integration.adoc[Metrics Integration]

* Logging
** xref:platform/logging/download-logs.adoc[]
** xref:platform/logging/log-forwarding.adoc[]
// ** xref:platform/logging/query-log-analyzer.adoc[]

* Neo4j connectors
** xref:platform/connectors/spark.adoc[]
** xref:platform/connectors/kafka.adoc[]
** xref:platform/connectors/bi.adoc[]

* Aura API
** xref:platform/api/overview.adoc[]
** xref:platform/api/authentication.adoc[]
** link:{neo4j-docs-base-uri}/aura/platform/api/specification/[API Specification]

////
Generic End
////

////
AuraDB Start
////
* *Neo4j AuraDB*

* xref:auradb/index.adoc[Overview]

* Getting Started
** xref:auradb/getting-started/create-database.adoc[]
** xref:auradb/getting-started/connect-database.adoc[]
** xref:auradb/getting-started/query-database.adoc[]

* Importing
** xref:auradb/importing/importing-data.adoc[]
** xref:auradb/importing/import-database.adoc[]

* 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[]

* xref:auradb/connecting-applications/overview.adoc[Connecting applications]
* **Neo4j Aura console**

* **Introduction**
** xref:index.adoc[About Aura]
** xref:visual-tour/index.adoc[Visual tour]

* **Get started**
** xref:platform/create-account.adoc[]
** xref:getting-started/create-database.adoc[Create an instance]
** xref:getting-started/connect-database.adoc[Connect to an instance]
//** xref:importing/importing-data.adoc[Import data]

* **Manage instances**
** xref:managing-databases/database-actions.adoc[Instance actions]
** xref:managing-databases/instance-details.adoc[Instance details]
** xref:managing-databases/instance-resources.adoc[Resources]
** xref:managing-databases/develop.adoc[Develop]

//(tapping on resources will take you to the metrics tab, and then I fully document the metrics tab further down and I link to that in my notes)

* **Import data**
** xref:import/introduction.adoc[What is Import?]
** xref:import/visual-tour.adoc[Visual tour]
** xref:import/file-provision.adoc[File provision]
** xref:import/modeling.adoc[Model data]
** xref:import/mapping.adoc[Map data]
** xref:import/indexes-and-constraints.adoc[Indexes and constraints]
** xref:import/import.adoc[Run the import]


* **Explore data**
** xref:explore/introduction.adoc[What is Explore?]
** xref:explore/explore-quick-start.adoc[Quick start]

** Visual tour
*** xref:explore/explore-visual-tour/explore-overview.adoc[Explore overview]
*** xref:explore/explore-visual-tour/perspective-drawer.adoc[Perspective drawer]
//*** xref:auradb/explore/explore-visual-tour/settings-drawer.adoc[Settings drawer]
*** xref:explore/explore-visual-tour/legend-panel.adoc[Legend panel]
*** xref:explore/explore-visual-tour/search-bar.adoc[Search bar]
*** xref:explore/explore-visual-tour/card-list.adoc[Card list]
*** xref:explore/explore-visual-tour/scene-interactions.adoc[Scene interactions]

** Perspectives
*** xref:explore/explore-perspectives/perspectives.adoc[Perspectives - A business view of the graph]
*** xref:explore/explore-perspectives/perspective-creation.adoc[Creation and use]
*** xref:explore/explore-perspectives/refresh-perspectives.adoc[Refresh Perspectives]
*** xref:explore/explore-perspectives/database-scans.adoc[Database scans]

** Explore features in detail
*** xref:explore/explore-features/graph-pattern-search.adoc[Graph pattern search]
*** xref:explore/explore-features/search-phrases-advanced.adoc[Search phrases for advanced queries]
*** xref:explore/explore-features/scene-actions.adoc[Scene actions]
*** xref:explore/explore-features/full-text-search.adoc[Full-text search]
*** xref:explore/explore-features/edit-graph-data.adoc[Edit graph data]
*** xref:explore/explore-features/slicer.adoc[Slicer]
** xref:explore/explore-default-actions.adoc[Default actions and shortcuts]


* **Query data**
** xref:query/introduction.adoc[What is Query?]
** xref:query/visual-tour.adoc[Visual tour]
** xref:query/operations.adoc[Query operations]

* **Metrics**
** xref:all-metrics.adoc[All metrics]

// * **Logs**
// ** xref:auradb/managing-databases/logs.adoc[Logs coming soon]

* **Manage users**
** xref:user-management.adoc[]

* **Connecting applications**
** xref:connecting-applications/overview.adoc[Drivers and libraries]
////
AuraDB End
////

////
AuraDS Start
////
* *Neo4j AuraDS*

* xref:aurads/index.adoc[Overview]
* xref:aurads/architecture.adoc[]

* xref:aurads/create-instance.adoc[]

* xref:aurads/connecting/index.adoc[]
** xref:aurads/connecting/neo4j-applications.adoc[]
** xref:aurads/connecting/python.adoc[]

* Usage examples
** xref:aurads/tutorials/graph-catalog.adoc[]
** xref:aurads/tutorials/algorithm-modes.adoc[]
** xref:aurads/tutorials/memory-estimation.adoc[]
** xref:aurads/tutorials/algorithm-progress.adoc[]
** xref:aurads/tutorials/model-catalog.adoc[]
** xref:aurads/tutorials/arrow-examples.adoc[]

* xref:aurads/importing-data/index.adoc[]
** xref:aurads/importing-data/import-db.adoc[]
** xref:aurads/importing-data/data-importer.adoc[]
** xref:aurads/importing-data/load-csv.adoc[]

* 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[]
////
AuraDS End
////

* *Tutorials*
* Upgrade and migration
** xref:tutorials/upgrade.adoc[]
** xref:tutorials/migration.adoc[]
* Integrating with Neo4j Connectors
** xref:tutorials/spark.adoc[]
** xref:tutorials/bi.adoc[]
* xref:tutorials/performance-improvements.adoc[]
* xref:tutorials/troubleshooting.adoc[]
* xref:tutorials/create-auradb-instance-from-terminal.adoc[]
Binary file added modules/ROOT/images/action-availability.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/add_range.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/advanced-expansion.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/breadcrumbs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/captions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/card-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/connection-dropdown.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/connectionbanner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/connectionmodal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/constraints-tab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/context-double.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/coordinate-layout.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/create-node.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/create-relationship.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/database-drawer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/dataimporterdocs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/datascan-generate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/datascan-refresh.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/dataservices.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/degree-centrality.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/delete-node.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/delete-relationship.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/develop.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/di-ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/dismiss-single-nodes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/dropdown.png
Binary file added modules/ROOT/images/edit-label.png
Binary file added modules/ROOT/images/edit-properties.png
Binary file added modules/ROOT/images/emptyexplore.png
Binary file added modules/ROOT/images/emptyquery.png
Binary file added modules/ROOT/images/expand-nodes.png
Binary file added modules/ROOT/images/expandedresources.png
Binary file added modules/ROOT/images/explore-overview.png
Binary file added modules/ROOT/images/explore.png
Binary file added modules/ROOT/images/file-filtering.png
Binary file added modules/ROOT/images/files.png
Binary file added modules/ROOT/images/filtering-dismiss.png
Binary file added modules/ROOT/images/filtering-histogram.png
Binary file added modules/ROOT/images/full-text-search.jpg
Binary file added modules/ROOT/images/graph-result-frame.png
Binary file added modules/ROOT/images/icon-add.png
Binary file added modules/ROOT/images/icon-clear.png
Binary file added modules/ROOT/images/icon-dismiss.png
Binary file added modules/ROOT/images/icon-duplicate.png
Binary file added modules/ROOT/images/icon-expand-reveal.png
Binary file added modules/ROOT/images/icon-fit-selection.png
Binary file added modules/ROOT/images/icon-invert.png
Binary file added modules/ROOT/images/icon-jumpto.png
Binary file added modules/ROOT/images/icon-magnifying-glass.png
Binary file added modules/ROOT/images/icon-path.png
Binary file added modules/ROOT/images/icon-pencil.png
Binary file added modules/ROOT/images/icon-redo.png
Binary file added modules/ROOT/images/icon-undo.png
Binary file added modules/ROOT/images/image22.png
Binary file added modules/ROOT/images/instanceactions.png
Binary file added modules/ROOT/images/instancedetails.png
Binary file added modules/ROOT/images/instancedetailsexpanded.png
Binary file added modules/ROOT/images/instanceemptystate.png
Binary file added modules/ROOT/images/instances.png
Binary file added modules/ROOT/images/inviteusers.png
Binary file added modules/ROOT/images/lasso-tool.png
Binary file added modules/ROOT/images/layouts-hierarchy.png
Binary file added modules/ROOT/images/leftsidepanel.png
Binary file added modules/ROOT/images/legend-panel-intro.png
Binary file added modules/ROOT/images/louvain.png
Binary file added modules/ROOT/images/map.png
Binary file added modules/ROOT/images/metrics.png
Binary file added modules/ROOT/images/model-panel.png
Binary file added modules/ROOT/images/moreinfo.png
Binary file added modules/ROOT/images/newinstance.png
Binary file added modules/ROOT/images/node-exclude.png
Binary file added modules/ROOT/images/node-id.png
Binary file added modules/ROOT/images/node-inspector.png
Binary file added modules/ROOT/images/node-mapping.png
Binary file added modules/ROOT/images/node-relationship.png
Binary file added modules/ROOT/images/node-styling.png
Binary file added modules/ROOT/images/northwind-as-a-graph.png
Binary file added modules/ROOT/images/organization.png
Binary file added modules/ROOT/images/parameter-chaining.png
Binary file added modules/ROOT/images/params-assist.png
Binary file added modules/ROOT/images/password.png
Binary file added modules/ROOT/images/perspective-components.png
Binary file added modules/ROOT/images/perspective-creation.png
Binary file added modules/ROOT/images/perspective-drawer.png
Binary file added modules/ROOT/images/perspective-export-import.png
Binary file added modules/ROOT/images/playback.png
Binary file added modules/ROOT/images/proactive-blank-input.png
Binary file added modules/ROOT/images/project.png
Binary file added modules/ROOT/images/projectsettings.png
Binary file added modules/ROOT/images/property-key-refresh.png
Binary file added modules/ROOT/images/query-connected-dropdown.png
Binary file added modules/ROOT/images/query-connection-dropdown.png
Binary file added modules/ROOT/images/query-limit.png
Binary file added modules/ROOT/images/query-styling.png
Binary file added modules/ROOT/images/query.png
Binary file added modules/ROOT/images/raw.png
Binary file added modules/ROOT/images/refresh-data.png
Binary file added modules/ROOT/images/relationship-mapping.png
Binary file added modules/ROOT/images/relationship-styling.png
Binary file added modules/ROOT/images/relationship.png
Binary file added modules/ROOT/images/relationships-of-a-node.png
Binary file added modules/ROOT/images/reveal-relationships.png
Binary file added modules/ROOT/images/roles1.png
Binary file added modules/ROOT/images/roles2.png
Binary file added modules/ROOT/images/rule-based-styling-range.png
Binary file added modules/ROOT/images/rule-based-time.png
Binary file added modules/ROOT/images/save-cypher.png
Binary file added modules/ROOT/images/saved-cypher-drawer.png
Binary file added modules/ROOT/images/scene-action-context.png
Binary file added modules/ROOT/images/scene-action-relationship.png
Binary file added modules/ROOT/images/scene-action.png
Binary file added modules/ROOT/images/search-bar-5.png
Binary file added modules/ROOT/images/search-bar-6.png
Binary file added modules/ROOT/images/search-bar-7.png
Binary file added modules/ROOT/images/select-related-nodes.png
Binary file added modules/ROOT/images/selected-values.png
Binary file added modules/ROOT/images/shortest-path.png
Binary file added modules/ROOT/images/show-me-a-graph.png
Binary file added modules/ROOT/images/slicer.png
Binary file added modules/ROOT/images/static-search-phrase.png
Binary file added modules/ROOT/images/stream.png
Binary file added modules/ROOT/images/table.png
Binary file added modules/ROOT/images/timezones.png
Binary file added modules/ROOT/images/tools.png
Binary file added modules/ROOT/images/tooltip-node-2.png
Binary file added modules/ROOT/images/upx-import.png
Binary file added modules/ROOT/images/upx-query.png
Binary file added modules/ROOT/images/users.png
Binary file added modules/ROOT/images/whiteboardfriendly.png
95 changes: 95 additions & 0 deletions modules/ROOT/pages/all-metrics.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
[[all-metrics]]
= All metrics
:description: This page describes metrics

You can get a view of instance resources from the instance card.

You can also monitor the following metrics of an instance from the *Metrics* tab.
Then from the tabs at the top, you can navigate between resources, instance and database metrics.

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

image::metrics.png[]

Select the info icon to see information about a particular metric, and you can expland the graph.

image::moreinfo.png[]

When viewing metrics, you can select from the following time intervals:

* 6 hours
* 24 hours
* 3 days
* 7 days
* 30 days

== Chart interactions

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

=== Toggle data series

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

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.

== Store size metrics

=== Resources tab

The chart on the _Resources_ tab shows the allocated store size metric for the selected database either as a percentage of the available storage assigned for the database or as absolute values.

=== Database tab

The _Database_ tab provides a chart that shows the store size and the portion of the allocated space that the database is actively utilizing.
Both metrics are represented as percentages of the available storage assigned to the database.

These metrics may differ due to the way Neo4j allocates and reuses space.
Once allocated, space is never automatically de-allocated.
Thus, reducing the data (nodes, relationships, properties) stored in the database does not reduce the top-line store size metric.
However, Neo4j will reuse this 'available' space before allocating more from the system.
The amount of allocated space that is 'available' is reported by the database, and Advanced metrics uses this metric to derive the used space by subtracting it from the allocated store size.
This information can help you understand how close your database is to exceeding the assigned storage size.
Loading