diff --git a/src/current/_includes/common/cdc-cloud-costs-link.md b/src/current/_includes/common/cdc-cloud-costs-link.md new file mode 100644 index 00000000000..5f0b169325d --- /dev/null +++ b/src/current/_includes/common/cdc-cloud-costs-link.md @@ -0,0 +1 @@ +If you're using a CockroachDB {{ site.data.products.cloud }} cluster, refer to [Understand CockroachDB Cloud Costs]({% link cockroachcloud/costs.md %}) for detail on how CDC is billed monthly based on usage. \ No newline at end of file diff --git a/src/current/_includes/common/define-watched-cdc.md b/src/current/_includes/common/define-watched-cdc.md new file mode 100644 index 00000000000..20fb749c5e2 --- /dev/null +++ b/src/current/_includes/common/define-watched-cdc.md @@ -0,0 +1 @@ +The main feature of {% if page.name == "change-data-capture-overview.md" %} CockroachDB CDC {% else %} [CockroachDB CDC]({% link {{site.current_cloud_version}}/change-data-capture-overview.md %}) {% endif %} is the _changefeed_, which targets an allowlist of tables, known as _watched tables_. diff --git a/src/current/cockroachcloud/costs.md b/src/current/cockroachcloud/costs.md index 653b11f2ae6..158d9c48516 100644 --- a/src/current/cockroachcloud/costs.md +++ b/src/current/cockroachcloud/costs.md @@ -34,7 +34,7 @@ This table summarizes key details about how costs are calculated for each plan t CockroachDB Basic

Usage-based billing only - CockroachDB Standard

Provisioned compute, usage-based storage, data transfer, backups, and Change Data Capture (CDC) + CockroachDB Standard

Provisioned compute, usage-based storage, data transfer, backups, and Change data capture (CDC) CockroachDB Advanced

Provisioned compute, storage, and IOPS with usage-based billing for data transfer, backups, and CDC @@ -60,8 +60,8 @@ This table summarizes key details about how costs are calculated for each plan t Backups Usage-based via Request Units. - Usage-based.

Managed Backups storage rates vary per cloud provider, region, and backup frequency.

Self-Managed Backups fee incurred per GiB transferred to your own object storage. - Usage-based.

Managed Backups storage rates vary per cloud provider, region, backup frequency, and whether security add-on is enabled.

Self-Managed Backups fee incurred per GiB transferred to your own object storage. Rate varies depending on whether security add-on is enabled. + Usage-based.

Managed backups storage rates vary per cloud provider, region, and backup frequency.

Self-managed backups fee incurred per GiB transferred to your own object storage. + Usage-based.

Managed backups storage rates vary per cloud provider, region, backup frequency, and whether security add-on is enabled.

Self-managed backups fee incurred per GiB transferred to your own object storage. Rate varies depending on whether security add-on is enabled. Data transfer @@ -70,7 +70,7 @@ This table summarizes key details about how costs are calculated for each plan t Usage-based; rates vary per cloud provider and data transfer type. - Change Data Capture + Change data capture Usage-based via Request Units. Usage-based, per GiB-hour watched across all changefeeds. Usage-based, per GiB-hour watched across all changefeeds. Rates vary depending on whether security add-on is enabled. @@ -187,9 +187,9 @@ Backups on Basic clusters are included in the Request Unit costs. Managed backup
-[Managed Backups]({% link cockroachcloud/managed-backups.md %}) are charged per-GiB storage rates that vary per cloud provider, region, and backup [frequency]({% link cockroachcloud/managed-backups.md %}#frequency) (daily vs. more than daily). The per-GiB unit prices are tiered, based on the amount of backup data stored: Less than 5 GiB-Month, 5 to 100 GiB-Month, 100 to 500 GiB-Month, 500 to 1000 GiB-Month, or 1000 GiB-Month and higher. +[Managed backups]({% link cockroachcloud/managed-backups.md %}) are charged per-GiB storage rates that vary per cloud provider, region, and backup [frequency]({% link cockroachcloud/managed-backups.md %}#frequency) (daily vs. more than daily). The per-GiB unit prices are tiered, based on the amount of backup data stored: Less than 5 GiB-Month, 5 to 100 GiB-Month, 100 to 500 GiB-Month, 500 to 1000 GiB-Month, or 1000 GiB-Month and higher. -[Self-Managed Backups]({% link cockroachcloud/take-and-restore-self-managed-backups.md %}) to your own object storage are charged a per-GiB fee for the data transferred. This option provides an advanced backup scheduler and additional control over backup storage placement. +[Self-managed backups]({% link cockroachcloud/take-and-restore-self-managed-backups.md %}) to your own object storage are charged a per-GiB fee for the data transferred. This option provides an advanced backup scheduler and additional control over backup storage placement. For further details, refer to CockroachDB Cloud [Pricing](https://www.cockroachlabs.com/pricing/new/). @@ -197,9 +197,9 @@ For further details, refer to CockroachDB Cloud [Pricing](https://www.cockroachl
-[Managed Backups]({% link cockroachcloud/managed-backups.md %}) are charged per-GiB storage rates that vary per cloud provider, region, backup [frequency]({% link cockroachcloud/managed-backups.md %}#frequency) (daily vs. more than daily), and whether the Advanced security add-on is enabled. The per-GiB unit prices are tiered, based on the amount of backup data stored: Less than 5 GiB-Month, 5 to 100 GiB-Month, 100 to 500 GiB-Month, 500 to 1000 GiB-Month, or 1000 GiB-Month and higher. +[Managed backups]({% link cockroachcloud/managed-backups.md %}) are charged per-GiB storage rates that vary per cloud provider, region, backup [frequency]({% link cockroachcloud/managed-backups.md %}#frequency) (daily vs. more than daily), and whether the Advanced security add-on is enabled. The per-GiB unit prices are tiered, based on the amount of backup data stored: Less than 5 GiB-Month, 5 to 100 GiB-Month, 100 to 500 GiB-Month, 500 to 1000 GiB-Month, or 1000 GiB-Month and higher. -[Self-Managed Backups]({% link cockroachcloud/take-and-restore-self-managed-backups.md %}) to your own object storage are charged a per-GiB fee for the data transferred. The rate varies depending on whether the Advanced security add-on is enabled. Self-Managed Backups offer additional control over backup storage placement, and an advanced backup scheduler. +[Self-managed backups]({% link cockroachcloud/take-and-restore-self-managed-backups.md %}) to your own object storage are charged a per-GiB fee for the data transferred. The rate varies depending on whether the Advanced security add-on is enabled. Self-managed backups offer additional control over backup storage placement, and an advanced backup scheduler. For further details, refer to CockroachDB Cloud [Pricing](https://www.cockroachlabs.com/pricing/new/).
@@ -232,7 +232,7 @@ Cross-region data transfer includes: - CockroachDB replication across nodes that are in different regions. - Data egress from the CockroachDB Cloud cluster via supported [private connectivity]({% link cockroachcloud/connect-to-your-cluster.md %}#establish-private-connectivity) services to a private endpoint in another region. - [Managed backup]({% link cockroachcloud/backup-and-restore-overview.md %}#managed-backups) and [Self-managed backup]({% link cockroachcloud/take-and-restore-self-managed-backups.md %}) data transfer to another region. -- Change Data Capture (changefeed) data transfer to another region. +- Change data capture (changefeed) data transfer to another region. Customers are charged the cloud service provider’s (CSP) list price for metered cross-region data transfer. @@ -266,7 +266,7 @@ Cross-region data transfer includes: - CockroachDB replication across nodes that are in different regions. - Data egress from the CockroachDB Cloud cluster via supported [private connectivity]({% link cockroachcloud/connect-to-your-cluster.md %}#establish-private-connectivity) services to a private endpoint in another region. - [Managed backup]({% link cockroachcloud/backup-and-restore-overview.md %}#managed-backups) and [Self-managed backup]({% link cockroachcloud/take-and-restore-self-managed-backups.md %}) data transfer to another region. -- Change Data Capture (changefeed) data transfer to another region. +- Change data capture (changefeed) data transfer to another region. Customers are charged the cloud service provider’s (CSP) list price for metered cross-region data transfer. @@ -278,9 +278,9 @@ This is the usage for any data leaving CockroachDB such as SQL data being sent t
-### Change Data Capture (Changefeeds) +### Change data capture (changefeeds) -For Change Data Capture (CDC), all CockroachDB {{ site.data.products.cloud }} clusters can use [Enterprise Changefeeds]({% link {{ site.current_cloud_version}}/how-does-an-enterprise-changefeed-work.md %}). +For change data capture (CDC), all CockroachDB {{ site.data.products.cloud }} clusters can use [Enterprise changefeeds]({% link {{ site.current_cloud_version}}/how-does-an-enterprise-changefeed-work.md %}).
@@ -289,13 +289,17 @@ In CockroachDB {{ site.data.products.basic }}, CDC cost is usage-based via Reque
-In CockroachDB {{ site.data.products.standard }}, CDC is billed monthly based on usage, determined by the total GiB-Month watched across all of a cluster’s changefeeds. The per-GiB unit price is tiered, based on the total watched: Less than 5 GiB-Month, 5 to 100 GiB-Month, 100 to 250 GiB-Month, 250 to 500 GiB-Month, or 500 GiB-Month and higher. +{% include common/define-watched-cdc.md %} + +In CockroachDB {{ site.data.products.standard }}, CDC is billed monthly based on the total size in GiB-Month of all of a cluster's watched tables. The per-GiB unit price is tiered, based on the size of watched data: Less than 5 GiB-Month, 5 to 100 GiB-Month, 100 to 250 GiB-Month, 250 to 500 GiB-Month, or 500 GiB-Month and higher.
-In CockroachDB {{ site.data.products.advanced }}, CDC is billed monthly based on usage, determined by the total GiB-Month watched across all of a cluster’s changefeeds and whether the Advanced security add-on is enabled. The per-GiB unit price is tiered, based on the total watched: Less than 5 GiB-Month, 5 to 100 GiB-Month, 100 to 250 GiB-Month, 250 to 500 GiB-Month, or 500 GiB-Month and higher. +{% include common/define-watched-cdc.md %} + +In CockroachDB {{ site.data.products.advanced }}, CDC is billed monthly based on the total size of a cluster's watched tables and whether the {{ site.data.products.advanced }} security add-on is enabled. The per-GiB unit price is tiered, based on the size of watched data: Less than 5 GiB-Month, 5 to 100 GiB-Month, 100 to 250 GiB-Month, 250 to 500 GiB-Month, or 500 GiB-Month and higher.
diff --git a/src/current/v23.2/create-and-configure-changefeeds.md b/src/current/v23.2/create-and-configure-changefeeds.md index 53fab8d09f8..496a810426b 100644 --- a/src/current/v23.2/create-and-configure-changefeeds.md +++ b/src/current/v23.2/create-and-configure-changefeeds.md @@ -17,6 +17,7 @@ This page describes: 1. Enable rangefeeds on CockroachDB {{ site.data.products.advanced }} and CockroachDB {{ site.data.products.core }}. Refer to [Enable rangefeeds](#enable-rangefeeds) for instructions. 1. Decide on whether you will run an {{ site.data.products.enterprise }} or basic changefeed. Refer to the [Overview]({% link {{ page.version.version }}/change-data-capture-overview.md %}) page for a comparative capability table. 1. Plan the number of changefeeds versus the number of tables to include in a single changefeed for your cluster. {% include {{ page.version.version }}/cdc/changefeed-number-limit.md %} Refer to [System resources and running changefeeds](#system-resources-and-running-changefeeds) and [Recommendations for the number of target tables](#recommendations-for-the-number-of-target-tables). + - {% include common/cdc-cloud-costs-link.md %} 1. Consider whether your {{ site.data.products.enterprise }} [changefeed use case](#create) would be better served by [change data capture queries]({% link {{ page.version.version }}/cdc-queries.md %}) that can filter data on a single table. CDC queries can improve the efficiency of changefeeds because the job will not need to encode as much change data. 1. Read the [Considerations](#considerations) section that provides information on changefeed interactions that could affect how you configure or run your changefeed. diff --git a/src/current/v24.1/create-and-configure-changefeeds.md b/src/current/v24.1/create-and-configure-changefeeds.md index b56237149a4..d7b0d5ad034 100644 --- a/src/current/v24.1/create-and-configure-changefeeds.md +++ b/src/current/v24.1/create-and-configure-changefeeds.md @@ -17,6 +17,7 @@ This page describes: 1. Enable rangefeeds on CockroachDB {{ site.data.products.advanced }} and CockroachDB {{ site.data.products.core }}. Refer to [Enable rangefeeds](#enable-rangefeeds) for instructions. 1. Decide on whether you will run an {{ site.data.products.enterprise }} or basic changefeed. Refer to the [Overview]({% link {{ page.version.version }}/change-data-capture-overview.md %}) page for a comparative capability table. 1. Plan the number of changefeeds versus the number of tables to include in a single changefeed for your cluster. {% include {{ page.version.version }}/cdc/changefeed-number-limit.md %} Refer to [System resources and running changefeeds](#system-resources-and-running-changefeeds) and [Recommendations for the number of target tables](#recommendations-for-the-number-of-target-tables). + - {% include common/cdc-cloud-costs-link.md %} 1. Consider whether your {{ site.data.products.enterprise }} [changefeed use case](#create) would be better served by [change data capture queries]({% link {{ page.version.version }}/cdc-queries.md %}) that can filter data on a single table. CDC queries can improve the efficiency of changefeeds because the job will not need to encode as much change data. 1. Read the [Considerations](#considerations) section that provides information on changefeed interactions that could affect how you configure or run your changefeed. diff --git a/src/current/v24.2/create-and-configure-changefeeds.md b/src/current/v24.2/create-and-configure-changefeeds.md index c2815931249..f61991da802 100644 --- a/src/current/v24.2/create-and-configure-changefeeds.md +++ b/src/current/v24.2/create-and-configure-changefeeds.md @@ -17,6 +17,7 @@ This page describes: 1. Enable rangefeeds on CockroachDB {{ site.data.products.advanced }} and CockroachDB {{ site.data.products.core }}. Refer to [Enable rangefeeds](#enable-rangefeeds) for instructions. 1. Decide on whether you will run an {{ site.data.products.enterprise }} or basic changefeed. Refer to the [Overview]({% link {{ page.version.version }}/change-data-capture-overview.md %}) page for a comparative capability table. 1. Plan the number of changefeeds versus the number of tables to include in a single changefeed for your cluster. {% include {{ page.version.version }}/cdc/changefeed-number-limit.md %} Refer to [System resources and running changefeeds](#system-resources-and-running-changefeeds) and [Recommendations for the number of target tables](#recommendations-for-the-number-of-target-tables). + - {% include common/cdc-cloud-costs-link.md %} 1. Consider whether your {{ site.data.products.enterprise }} [changefeed use case](#create) would be better served by [change data capture queries]({% link {{ page.version.version }}/cdc-queries.md %}) that can filter data on a single table. CDC queries can improve the efficiency of changefeeds because the job will not need to encode as much change data. 1. Read the [Considerations](#considerations) section that provides information on changefeed interactions that could affect how you configure or run your changefeed. diff --git a/src/current/v24.3/change-data-capture-overview.md b/src/current/v24.3/change-data-capture-overview.md index 7997456e941..64fa3ea148b 100644 --- a/src/current/v24.3/change-data-capture-overview.md +++ b/src/current/v24.3/change-data-capture-overview.md @@ -15,7 +15,7 @@ For example, you might want to: - Export a snaphot of tables to backfill new applications. - Send updates to data stores for machine learning models. -The main feature of CockroachDB CDC is the _changefeed_, which targets an allowlist of tables, or "watched tables". +{% include common/define-watched-cdc.md %} ## Stream row-level changes with changefeeds diff --git a/src/current/v24.3/changefeed-best-practices.md b/src/current/v24.3/changefeed-best-practices.md index 391018ffabe..3e61a629a48 100644 --- a/src/current/v24.3/changefeed-best-practices.md +++ b/src/current/v24.3/changefeed-best-practices.md @@ -6,6 +6,10 @@ toc: true This page describes best practices to consider when starting changefeeds on a CockroachDB cluster. We recommend referring to this information while planning your cluster's changefeeds and following the links in each of the sections for more details on a topic. +{{site.data.alerts.callout_info}} +To help in planning your cluster's changefeeds on CockroachDB {{ site.data.products.cloud }} clusters, refer to the [Understand CockroachDB Cloud Costs]({% link cockroachcloud/costs.md %}) page for detail on how CDC is billed monthly based on usage. +{{site.data.alerts.end}} + ## Plan the number of watched tables for a single changefeed When creating a changefeed, it's important to consider the number of changefeeds versus the number of tables to include in a single changefeed: diff --git a/src/current/v24.3/create-and-configure-changefeeds.md b/src/current/v24.3/create-and-configure-changefeeds.md index 7ea21b2ece6..4662b2451ba 100644 --- a/src/current/v24.3/create-and-configure-changefeeds.md +++ b/src/current/v24.3/create-and-configure-changefeeds.md @@ -17,6 +17,7 @@ This page describes: 1. Enable rangefeeds on CockroachDB {{ site.data.products.advanced }} and CockroachDB {{ site.data.products.core }}. Refer to [Enable rangefeeds](#enable-rangefeeds) for instructions. 1. Decide on whether you will run an {{ site.data.products.enterprise }} or basic changefeed. Refer to the [Overview]({% link {{ page.version.version }}/change-data-capture-overview.md %}) page for a comparative capability table. 1. Plan the number of changefeeds versus the number of tables to include in a single changefeed for your cluster. {% include {{ page.version.version }}/cdc/changefeed-number-limit.md %} Refer to [System resources and running changefeeds]({% link {{ page.version.version }}/changefeed-best-practices.md %}#maintain-system-resources-and-running-changefeeds) and [Recommendations for the number of target tables]({% link {{ page.version.version }}/changefeed-best-practices.md %}#plan-the-number-of-watched-tables-for-a-single-changefeed). + - {% include common/cdc-cloud-costs-link.md %} 1. Consider whether your {{ site.data.products.enterprise }} [changefeed use case](#create) would be better served by [change data capture queries]({% link {{ page.version.version }}/cdc-queries.md %}) that can filter data on a single table. CDC queries can improve the efficiency of changefeeds because the job will not need to encode as much change data. 1. Read the following: - The [Changefeed Best Practices]({% link {{ page.version.version }}/changefeed-best-practices.md %}) reference for details on planning changefeeds, monitoring basics, and schema changes.