Skip to content

Commit

Permalink
More style fixes (#454)
Browse files Browse the repository at this point in the history
  • Loading branch information
nvitucci authored Sep 5, 2024
1 parent d08edeb commit ef9742a
Show file tree
Hide file tree
Showing 14 changed files with 26 additions and 21 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Aura retains some of your provisioned resources for managing your instance.

[NOTE]
======
Pay-as-you-go (PAYG) is available on all instance sizes up to 128GB. Prepaid is available from 16GB+.
Pay-as-you-go (PAYG) is available on all instance sizes up to 128 GB. Prepaid is available from 16 GB+.
======

To create an *AuraDB Business Critical* instance in Neo4j AuraDB:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ To access *Advanced metrics*:
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.
* *Instance* - Information about the Neo4j instances 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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,8 @@ You cannot clone from a Neo4j version 5 instance to a Neo4j version 4 instance.

. Select the ellipsis (*...*) button on the instance you want to clone.
. Select *Clone To New* and then *AuraDB Professional/Business Critical/Virtual Dedicated Cloud* from the contextual menu.
. Set your desired settings for the new database. For more information on AuraDB database creation, see xref:auradb/getting-started/create-database.adoc[].
. Set your desired settings for the new database.
For more information on AuraDB database creation, see xref:auradb/getting-started/create-database.adoc[].
. Check the *I understand* box and select *Clone Database*.
+
[WARNING]
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/aurads/importing-data/load-csv.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Furthermore:
* `RETURN count({star})` is used to show the number of processed rows.

Note that the CSV files in this example are curated, so some assumptions are made for simplicity.
In a real-world scenario, for example, a CSV file could contain multiple rows that would attempt to assign different property values to the same node; in this case, an link:{neo4j-docs-base-uri}/cypher-manual/current/clauses/merge/#merge-merge-with-on-match[`ON MATCH SET`^] clause must be added to ensure this case is dealt with appropriately.
In a real-world scenario, for example, a CSV file could contain multiple rows that would try to assign different property values to the same node; in this case, an link:{neo4j-docs-base-uri}/cypher-manual/current/clauses/merge/#merge-merge-with-on-match[`ON MATCH SET`^] clause must be added to ensure this case is dealt with appropriately.

[.tabbed-example]
====
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ To access *Advanced metrics*:
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.
* *Instance* - Information about the Neo4j instances 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:
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/platform/api/authentication.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -159,5 +159,5 @@ print(response.json())

=== Token expiration

If you attempt to send a request to the Aura API, authenticated using an expired access token, you will receive a 403 Forbidden response.
If you send a request to the Aura API while authenticated with an expired access token, you will receive a 403 Forbidden response.
You will need to obtain a new token to continue using the API.
2 changes: 1 addition & 1 deletion modules/ROOT/pages/platform/api/overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Rate limiting is set to 125 requests per minute.
You should consider your use of the Rate Limit before attempting to retry, and we recommend using an exponential backoff delay with a limited number of retries before giving up.

A request is only guaranteed to be safe to retry if it uses an idempotent HTTP method, such as `GET`.
If for example, you attempt to retry a request for creating an instance, you may end up with duplicate instances and end up being charged extra as a result.
If, for example, you retry a request for creating an instance, you may end up with duplicate instances and end up being charged extra as a result.

In the case of `429 Too Many Requests`, we would recommend slowing down the rate of all requests sent from your client application and consider retrying with a suitable minimum delay and backoff strategy.

Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/platform/logging/download-logs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ A query log provides a log of queries executed on an instance within a specified

[NOTE]
====
Queries that complete successfully within 50ms are not logged.
Queries that complete successfully within 50 ms are not logged.
====

=== Requesting query logs
Expand Down
3 changes: 2 additions & 1 deletion modules/ROOT/pages/platform/logging/query-log-analyzer.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ To access *Query log analyzer*:
. Select the *Logs* tab.
. Select the *Query log analyzer* button.

It is also possible to enter Query log analyzer from the _Query rate_ or _Query latency_ charts in the _Database_ tab of *Advanced Metrics*. To do so, click the ellipsis button (*...*) on the chart and select *Explore query logs*.
It is also possible to enter Query log analyzer from the _Query rate_ or _Query latency_ charts in the _Database_ tab of *Advanced Metrics*.
To do so, click the ellipsis button (*...*) on the chart and select *Explore query logs*.

== Overview

Expand Down
12 changes: 7 additions & 5 deletions modules/ROOT/pages/platform/metrics-integration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ aura instances get --instance-id <YOUR_INSTANCE_ID> | jq '.metrics_integration_u
* Reference: link:https://neo4j.com/labs/aura-cli/1.0/cheatsheet/[Aura CLI cheatsheet^]

[aura-cmi-metrics-granularity]
== Metrics Granularity
== Metrics granularity

The metrics returned by the integration endpoint are grouped based on the labels provided: `aggregation`, `instance_id`, and `database`.

Expand All @@ -261,17 +261,18 @@ This view can be enabled on demand.
Contact link:https://support.neo4j.com/[Customer Support] to enable more granular metrics of instances for your tenant.
====

.Example metric datapoints
.Example metric data points
[source]
----
neo4j_aura_cpu_usage{aggregation="MAX",instance_id="a59d71ae",availability_zone="eu-west-1a",instance_mode="PRIMARY"} 0.025457 1724245310000
neo4j_aura_cpu_usage{aggregation="MAX",instance_id="a59d71ae",availability_zone="eu-west-1b",instance_mode="PRIMARY"} 0.047088 1724245310000
neo4j_aura_cpu_usage{aggregation="MAX",instance_id="a59d71ae",availability_zone="eu-west-1c",instance_mode="PRIMARY"} 0.021874 1724245310000
----

.Additional Metric labels
.Additional metric labels
* `availability_zone` - User selected Cloud provider zone.
* `instance_mode` - `PRIMARY` based on user selected workload requirement of reads and writes. (Minimum 3 primaries per instance)
* `instance_mode` - `PRIMARY` based on user selected workload requirement of reads and writes.
(Minimum 3 primaries per instance)

.Usage
The following is an example of gaining more insights into your Aura instance CPU usage for capacity planning:
Expand Down Expand Up @@ -322,7 +323,8 @@ m| MAX
| Metric name
m| neo4j_aura_cpu_usage
| Description
| CPU usage (cores). CPU is used for planning and serving queries.
| CPU usage (cores).
CPU is used for planning and serving queries.
If this metric is constantly spiking or at its limits, consider increasing the size of your instance.
| Metric type
| _Gauge_
Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/platform/security/encryption.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Aura has no control over the availability of your externally managed key in the

[WARNING]
====
The loss of a Customer Managed Key — through deletion, disabling, or expiration — makes all data encrypted with that key inaccessible.
The loss of a Customer Managed Key —- through deletion, disabling, or expiration —- makes all data encrypted with that key inaccessible.
Neo4j is unable to manage database instances if the key is disabled, deleted, expired, or if permissions are revoked.
====

Expand Down Expand Up @@ -53,7 +53,7 @@ You can override this to use another CMK key - but you can not use the Neo4j Man

When using a Customer Managed Key within Aura to encrypt one or more Aura database instances, it cannot be removed from Aura.
If you no longer need to use this Customer Managed Key to encrypt Aura databases, first delete the Aura database instances that are encrypted with the key, then you can remove the key from Aura.
Keep in mind that this process only breaks the link between the key and Aura — it does not delete the actual key from the Cloud KMS.
Keep in mind that this process only breaks the link between the key and Aura —- it does not delete the actual key from the Cloud KMS.

== AWS keys

Expand Down
5 changes: 3 additions & 2 deletions modules/ROOT/pages/platform/security/single-sign-on.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ Access beyond log-in is managed via RBAC.
* *Tenant level SSO:* Impacts new database instances created within that tenant.
It ensures users logging in with SSO have access to the database instances within the tenant.
It depends on RBAC if the user can access and view or modify data within the database instances themselves.
For this level, the role mapping may be used to grant users different levels of access based on a role in their identity provider (IdP). It *does not* give access to edit the tenant settings, for example to edit the tenant name, network access, or to edit the instance settings such as to rename an instance, or pause and resume.
For this level, the role mapping may be used to grant users different levels of access based on a role in their identity provider (IdP).
It *does not* give access to edit the tenant settings, for example to edit the tenant name, network access, or to edit the instance settings such as to rename an instance, or pause and resume.

== Log-in methods

Expand Down Expand Up @@ -63,6 +64,6 @@ Support can assist with:

If you require support assistance, visit link:https://support.neo4j.com/[Customer Support] and raise a support ticket including the following information:

. The _Tenant ID_ of the tenant(s) you want to use SSO for.
. The _Tenant ID_ of the tenants you want to use SSO for.
See xref:platform/user-management.adoc#_tenants[Tenants] for more information on how to find your __Tenant ID__.
. The name of your IdP
4 changes: 2 additions & 2 deletions modules/ROOT/pages/platform/user-management.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -97,9 +97,9 @@ Select the trash can icon next to the user's name, and then select **Revoke**.

When invited to a tenant, you will receive an email with a link to accept the invite.
This link will direct you to the Aura Console, where a **Tenant invitation** modal will appear.
You can select the tenant(s) you have been invited to and choose to accept or decline the invite(s).
You can select the tenants you have been invited to and choose to accept or decline the invites.

You can also close the **Tenant invitation** modal without accepting or declining the invite(s) and later manually re-open the modal by selecting the **Pending invites** envelope icon in the Console header.
You can also close the **Tenant invitation** modal without accepting or declining the invites and later manually re-open the modal by selecting the **Pending invites** envelope icon in the Console header.

[TIP]
====
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/tutorials/troubleshooting.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ RETURN command + " " + description
+
. In Neo4j Browser, select the "Enable multi statement query editor" option under the browser settings.
. Take the list of commands from the 2nd step and copy them in one list of multiple queries into Browser and run those queries.
. After the indexes are recreated, attempt the `database upload` command again.
. After the indexes are recreated, try the `database upload` command again.

=== `InconsistentData`

Expand Down

0 comments on commit ef9742a

Please sign in to comment.