diff --git a/modules/ROOT/content-nav.adoc b/modules/ROOT/content-nav.adoc index 556da86a8..40c3b36e0 100644 --- a/modules/ROOT/content-nav.adoc +++ b/modules/ROOT/content-nav.adoc @@ -143,7 +143,10 @@ Generic Start * xref:user-management.adoc[User management] -* xref:billing.adoc[Billing] +* Billing +** xref:billing/original.adoc[Billing] +** xref:billing/usage-based-billing.adoc[Usage-based billing] +** xref:billing/billing-dimensions.adoc[Billing dimensions] * Connecting applications ** xref:connecting-applications/overview.adoc[Drivers and libraries] diff --git a/modules/ROOT/pages/billing/billing-dimensions.adoc b/modules/ROOT/pages/billing/billing-dimensions.adoc new file mode 100644 index 000000000..14bbb0445 --- /dev/null +++ b/modules/ROOT/pages/billing/billing-dimensions.adoc @@ -0,0 +1,171 @@ += Billing dimensions +:description: Neo4j offers cloud services through two billing models. +Pay-as-you-go, where usage is invoiced and charged on your credit card monthly in arrears. +Prepaid, where credits are deducted from the available balance each month. + +[NOTE] +==== +This section is currently a work in progress. +It’s an initial idea of what might go here — content and structure may change as feedback comes in. +==== + +== Aura Billing Models + +Aura usage is metered and aggregated based on billing dimensions, the result is priced according to Aura pricing plans. + +=== Pay-as-you-go + +* Get started by creating an Aura account. No sales team needed. +* Cancel at any time, no extra charge. +* No expiration date. Continues as long as you use Aura. +* Usage is billed monthly, for the previous month. At every billing cycle, all the usage from the previous month is priced, invoiced and then charged to the customer’s payment method. + +=== Billing processor + +* Directly with Neo4j using a credit card as a payment method. +* Or through GCP, AWS or Azure Marketplace - usage is reported hourly to the marketplace. Then, at the marketplace’s billing cycle, Aura usage is aggregated and charged as part of the customer’s cloud bill. + +=== Prepaid + +* Commit to using Aura for a minimum of one year +* Buy Aura Consumption Units. +* Does not renew automatically. +* Signing up requires the sales team. + +=== Aura Consumption Unit (ACU) + +To aggregate and then pay for usage across different dimensions, we use ACUs. +All Aura resources are priced in ACUs. + +Customers purchase ACUs as part of their prepaid contract, and then use them to cover for the usage that is also expressed in ACU. + +* The nominal value of an Aura Consumption Unit is $1 (excluding any discounts at the point of credits purchase). If a customer runs out of Aura Consumption Units and needs to pay the overage in dollars, the exchange rate of ACU-usage-to-dollars is 1 ACU = $1. +* ACUs have a start date and an expiration date. ACUs need to be used before their expiration date, or they are forfeited. + +=== Contract lifecycle + +. The customer signs a contract with Neo4j for a given period (one or more contract terms) and buys a number of Aura Consumption Units to be used in each yearly contract term. +. The customer uses Aura resources priced in ACUs. +. The usage (priced in ACU) is deducted from the ACU balance throughout the month. +. If the customer runs out of ACUs before their expiration date, they will be invoiced for the overage, at a conversion rate of 1 ACU = $1. +. At expiration date, all ACUs remaining are forfeited. If the current term is part of a multi-year contract, some of the remaining balance can be rolled over to the next term, if one exists. This has to be documented in the initial contract. + +=== Billing processor + +As for pay-as-you-go, customers can use two separate procurement channels for purchasing Aura Consumption Units: + +* Direct invoicing with Neo4j +* Purchase ACUs through marketplace private offers (GCP, AWS or Azure). + +There is *no billing integration* with marketplaces for prepaid contracts. +The contract is executed as a *private offer* - Neo4j instructs the marketplace to invoice the customer for a number of ACUs and nothing else. +Neo4j does not provision an Aura environment automatically in this case, does not report usage to the marketplace for these deals, and the marketplace does not keep track of the remaining balance. + += Aura product and pricing plan availability matrix + +[.tabbed-example] +==== + +[.include-with-AuraDB] +===== + +Free, Professional, Business Critical, and Virtual Dedicated Cloud plans + +[cols="1,1,1,1", options="header"] +|=== +|Pricing Plan |Billing model |Payment method |Billing processor +|Free |N/A |N/A |Direct through Neo4j +|Professional |Pay-as-you-go |Credit card |Direct through Neo4j +|Professional |Pay-as-you-go |Marketplace |GCP Marketplace, AWS Marketplace, Azure Marketplace +|Business Critical |Pay-as-you-go |Credit card |Direct through Neo4j +|Business Critical |Pay-as-you-go |Marketplace |GCP Marketplace +|Professional |Prepaid |Credit balance + invoicing |Direct through Neo4j +|Professional |Prepaid |Credit balance + invoicing |Private offers through GCP Marketplace, AWS Marketplace, Azure Marketplace +|Business Critical |Prepaid |Credit balance + invoicing |Direct through Neo4j +|Business Critical |Prepaid |Credit balance + invoicing |Private offers through GCP Marketplace, AWS Marketplace, Azure Marketplace +|Virtual Dedicated Cloud |Prepaid |Credit balance + invoicing |Direct through Neo4j +|Virtual Dedicated Cloud |Prepaid |Credit balance + invoicing |Private offers through GCP Marketplace, AWS Marketplace, Azure Marketplace +|=== + +===== + +[.include-with-AuraDB-additional-storage] +===== + +Extra storage and secondaries are only available for Business Critical and Virtual Dedicated Cloud + +[cols="1,1,1,1", options="header"] +|=== +|Pricing Plan |Billing model |Payment method |Billing processor +|Professional, Business Critical |Pay-as-you-go |Credit card |Direct through Neo4j +|Professional, Business Critical |Pay-as-you-go |Marketplace |GCP Marketplace +|Virtual Dedicated Cloud |Prepaid |Credit balance + invoicing |Direct through Neo4j +|Virtual Dedicated Cloud |Prepaid |Credit balance + invoicing |Private offers through GCP Marketplace, AWS Marketplace, Azure Marketplace +|=== + +===== + +[.include-with-AuraDS] +===== + +Available in Professional and Enterprise tiers + +[cols="1,1,1,1", options="header"] +|=== +|Pricing Plan |Billing model |Payment method |Billing processor +|Professional |Pay-as-you-go |Credit card |Direct through Neo4j +|Professional |Pay-as-you-go |Marketplace |GCP, AWS, Azure Marketplace +|Professional |Prepaid |Credit balance + invoicing |Direct through Neo4j +|Professional |Prepaid |Credit balance + invoicing |Private offers through GCP Marketplace, AWS Marketplace, Azure Marketplace +|Enterprise |Prepaid |Credit balance + invoicing |Direct through Neo4j +|Enterprise |Prepaid |Credit balance + invoicing |Private offers through GCP Marketplace, AWS Marketplace, Azure Marketplace +|=== + +===== + +[.include-with-Aura-Graph-Analytics] +===== + +Flat pricing across all plans + +[cols="1,1,1,1", options="header"] +|=== + +|Pricing plan |Billing model |Payment method |Billing processor +|N/A |Pay-as-you-go |Credit card |Direct through Neo4j +|N/A |Pay-as-you-go |Marketplace |GCP Marketplace +|N/A |Prepaid |Credit balance + invoicing |Direct through Neo4j +|N/A |Prepaid |Credit balance + invoicing |Private offers through GCP Marketplace, AWS Marketplace, Azure Marketplace +|=== + +===== + +[.include-with-GraphQL] +===== + +Inherits the plan of the AuraDB instance it runs on: Professional or Business Critical + +[cols="1,1,1,1", options="header"] +|=== +|Billing model |Payment method |Billing processor +|Professional, Business Critical |Pay-as-you-go |Credit card |Direct through Neo4j +|Professional, Business Critical |Pay-as-you-go |Marketplace |GCP Marketplace +|Professional, Business Critical |Prepaid |Credit balance + invoicing |Direct through Neo4j +|Professional, Business Critical |Prepaid |Credit balance + invoicing |Private offers through GCP, AWS, Azure Marketplace +|=== + +===== + +[.include-with-Query-log-forwarding] +===== +[cols="1,1,1,1", options="header"] +|=== +|Pricing Plan |Billing Model |Payment Method |Billing Processor (Procurement Channel) +|Query log forwarding |Business Critical |Pay-as-you-go |Credit card |Direct through Neo4j +|Query log forwarding |Business Critical |Pay-as-you-go |Marketplace |GCP Marketplace +|Query log forwarding |Business Critical, Virtual Dedicated Cloud, AuraDS Enterprise |Prepaid |Credit balance + invoicing |Direct through Neo4j +|Query log forwarding |Business Critical, Virtual Dedicated Cloud, AuraDS Enterprise |Prepaid |Credit balance + invoicing |Private offers through GCP, AWS, Azure Marketplace +|=== + +===== +==== \ No newline at end of file diff --git a/modules/ROOT/pages/billing/original.adoc b/modules/ROOT/pages/billing/original.adoc new file mode 100644 index 000000000..0183f7de8 --- /dev/null +++ b/modules/ROOT/pages/billing/original.adoc @@ -0,0 +1,63 @@ +[[aura-Billing]] += Billing +:description: usage reporting allows customers to monitor their billing and credit consumption. + +label:Aura-DB-Professional[] +label:AuraDB-Business-Critical[] +label:AuraDB-Virtual-Dedicated-Cloud[] + +== Usage report + +The usage report gives real-time insights into resource usage for the current project, including both running and paused states. +You can also Export a CSV file containing usage in a selected period. + +The default time frame is month-to-date. +The usage report is updated hourly. + +=== Filters + +* Filter the usage data by predefined and custom date intervals. +* Look back for a period of up to 180 days. +* Filter by `Last 24 hours`, `Last 7 days`, `Last 30 days`, `Last 90 days` or a `Custom range`. + +=== Instances and Sessions + +There are two tabs for reviewing consumption by type: + +* The *Instances* tab includes a billing summary for database instances. +* The *Sessions* tab includes a billing summary for any Graph Analytics sessions + +== Project billing + +At the top-right corner of the Billing page, there's a summary of the total amount due for the current month. +This value is shown in Aura Credits (ACU), providing a real-time estimate of your projected billing. + +=== Required roles + +The report is available to the following roles: `Organization Owner`, `Organization Admin`, and `Project Admin`. + +To view the report, a payment method must be attached to the account. +If there's no billing method attached, in a project, on the *Billing* page there's a button to *Add new payment information*. + +=== Product name and pricing + +For more information, refer to link:https://console-preview.neo4j.io/pricing[Aura Pricing] for the specific product names and their prices. +If a database is paused, its charge is reduced to 20% of the standard hourly rate. + +=== Billing status + +Can be `ongoing` (currently being billed) or `ended` (historical usage). + +==== Units of measure + +Usage is displayed in the specified unit of measure. +GB-hours usage is calculated by multiplying the number of hours a database is running (whether actively used or not) by the memory size in gigabytes (GB). + +== Organization billing + +An 'Organization admin' can see an overview of all project's billing info. + +=== Usage tab + +=== Payment methods + diff --git a/modules/ROOT/pages/billing/usage-based-billing.adoc b/modules/ROOT/pages/billing/usage-based-billing.adoc new file mode 100644 index 000000000..16b8106d8 --- /dev/null +++ b/modules/ROOT/pages/billing/usage-based-billing.adoc @@ -0,0 +1,79 @@ += Billing dimensions +:description: An overview of the usage based billing model, how the metrics are tracked and implemented based on billing dimensions, and a description of the billing dimensions with examples of calculations for different uses. + +[NOTE] +==== +This section is currently a work in progress. +It’s an initial idea of what might go here - content and structure may change as feedback comes in. +==== + +Aura has a *usage-based billing model* (also known as consumption-based billing or metered billing). +Customers pay for the actual amount of a product or service consumed, rather than a fixed fee. + +=== AuraDB + +For AuraDB, we track *compute* and *storage*. + +. *Compute*: measured in GB-hours, based on RAM capacity. +For example, if your AuraDB instance has 4GB of RAM, and runs for 1 hour, you’ll be charged for 4 GB-hours of compute usage. + +* Compute is billed both in a running state and a paused state. + +* Compute is billed for the primary database and for any secondary databases. +For secondary databases, the total running capacity is the number of secondaries multiplied by the primary DB capacity. + +. *Storage*: each AuraDB instance has a free storage quota of twice the RAM capacity. +You can purchase additional storage beyond the quota, and it will be billed the same as compute in GB-hours. + +* Each secondary DB benefits from the same free storage quota as the primary DB. + +=== Example: + +Example: + +You have set up a 4GB AuraDB instance, with 2 secondaries, and a primary DB storage of 32GB. +Every hour the primary DB and its secondaries are running, you will be charged for: + +4 GB-hours (primary DB) +2 (secondaries) x 4 GB-hours = 8 GB-hours (secondary DB) +3 (1 primary + 2 secondaries) x (32GB - 2 x 4GB) = 72 GB-hours (storage) + +== AuraDS + +For AuraDS, we track *compute*: + +* Measured in GB-hours, based on RAM capacity. +* Billed both in a running state and in a paused state +* AuraDS includes a free quota of twice the RAM capacity for storage, without the possibility to purchase more storage +* Secondaries are not available for AuraDS + +== Aura Graph Analytics + +Aura Graph Analytics does not require a persistent instance run at all times. + +Users can start Graph Analytics sessions execute graph algorithms in-memory. +They specify the allocated memory size when the session is launched. + +The billing dimension for Aura Graph Analytics sessions is compute. +We calculate the duration of a session in minutes and multiply by the RAM capacity used by the session. + +Example: You launched a session with a size of 4GB of RAM, and it ran for 25 minutes. +We bill 25 minutes x 4GB = 100 GB-minutes of usage. + +Note: The minimum billed duration of a session is 10 minutes. +So in our example, if the session ran for 8 minutes and had a 4GB size, we would bill 10 minutes x 4GB = 40 GB-minutes. + +== GraphQL API + +Data APIs like GraphQL run on top of an existing AuraDB instance but consume additional memory. +We bill for compute, measured in MB-hours, based on the RAM capacity of the GraphQL additional memory. + +Example: if you set up a GraphQL API with 256MB of RAM, every hour the database is running will trigger a usage record of 256 MB-hours. + +== Query log forwarding + +With log forwarding, you can stream logs directly to a cloud project owned by your organization. +For query log forwarding, we bill for *data egress*. +Egress is measured in GB, and is added to the customer usage periodically. + + diff --git a/modules/ROOT/pages/dashboards/parameters-and-filters.adoc b/modules/ROOT/pages/dashboards/parameters-and-filters.adoc index 4a5e00bcb..13e7f204d 100644 --- a/modules/ROOT/pages/dashboards/parameters-and-filters.adoc +++ b/modules/ROOT/pages/dashboards/parameters-and-filters.adoc @@ -1,7 +1,6 @@ = Parameters and filters :description: Use parameters in your dashboards to further customize queries or use them in filters for node and relationship properties. - == Parameters Parameters are associated with a specific dashboard. @@ -27,13 +26,6 @@ Each parameter has an icon next to it hinting at its data type: . From the **Parameters** drawer, use the **Add** button. . In the dialog, enter a parameter name, select a data type and optionally an initial value for the parameter, then **Save**. - -=== Editing a parameter - -. From the **Parameters** drawer, hover over the parameter you wish to edit. -. In the dialog, edit the parameter name, data type and/or initial value, then **Save**. - - === Using a parameter in a query To use a parameter in a query, prefix the parameter name with `$`. @@ -51,6 +43,10 @@ RETURN p.productName as product, p.unitsInStock AS units .Using a parameter in a query to display products with a certain number of units in stock image::dashboards/parameters-and-filters/parameter-in-query.png[] +=== Editing a parameter + +. From the **Parameters** drawer, hover over the parameter you wish to edit. +. In the dialog, edit the parameter name, data type and/or initial value, then **Save**. === Deleting a parameter @@ -82,25 +78,12 @@ image::dashboards/parameters-and-filters/filter-units-in-stock.png[] Making filters dependent on a node or relationship property is necessary to let the dashboard infer values for the filter card to chose from. ==== - -=== Editing a filter - -. In the **Dashboards** page, use the more menu *[...]* of the filter you wish to edit and select **Edit filter**. -. Edit your filter and **Save**. - - -=== Deleting a filter - -In the **Dashboards** page, use the more menu *[...]* of the filter you wish to edit and select **Delete**, then confirm. - - //=== Highlight all cards using a filter // //In the **Dashboards** page, use the target icon of a filter to highlight all cards that make use of this particular filter. // screenshot - === Using a filter in a card Use the filter parameter as you normally would in the query of the card. @@ -111,4 +94,13 @@ You can select a value from the filter card drop down to let the dashboard assig .Selecting a new value for the unitsInStock filter image::dashboards/parameters-and-filters/filter-and-card.gif[] -All cards which make use of the parameter are updated with the new value. \ No newline at end of file +All cards which make use of the parameter are updated with the new value. + +=== Editing a filter + +. In the **Dashboards** page, use the more menu *[...]* of the filter you wish to edit and select **Edit filter**. +. Edit your filter and **Save**. + +=== Deleting a filter + +In the **Dashboards** page, use the more menu *[...]* of the filter you wish to edit and select **Delete**, then confirm. \ No newline at end of file diff --git a/modules/ROOT/pages/visual-tour/index.adoc b/modules/ROOT/pages/visual-tour/index.adoc index a9108d9f0..d3d882aa4 100644 --- a/modules/ROOT/pages/visual-tour/index.adoc +++ b/modules/ROOT/pages/visual-tour/index.adoc @@ -175,7 +175,7 @@ See xref:user-management.adoc[User management] for more information. === Billing -View and export real-time credit consumption reports by instance or session, add payment info, and track usage with filtering options. +View and export real-time credit usage reports by instance or session, add payment info, and track usage with filtering options. See xref:billing.adoc[Billing] for more information. // === Roles