diff --git a/docs/community/contributing-to-airbyte/writing-docs.md b/docs/community/contributing-to-airbyte/writing-docs.md index 4330d13ee6be..a22507e4a007 100644 --- a/docs/community/contributing-to-airbyte/writing-docs.md +++ b/docs/community/contributing-to-airbyte/writing-docs.md @@ -226,6 +226,7 @@ To enable badges, include `products` in the Markdown metadata. The following val - `oss-community`: Core only - `oss-enterprise`: Self-Managed Enterprise only - `cloud`: Standard and Plus (also enables Pro and Enterprise Flex due to Cloud tier inheritance) +- `cloud-plus`: Plus only (also enables Pro and Enterprise Flex due to Cloud tier inheritance) - `cloud-teams`: Pro only (also enables Enterprise Flex due to Cloud tier inheritance) - `enterprise-flex`: Enterprise Flex only - `embedded`: Embedded only (hidden if not specified - there is no off state for the Embedded badge) @@ -233,6 +234,7 @@ To enable badges, include `products` in the Markdown metadata. The following val **Cloud tier inheritance:** higher Cloud plans automatically inherit availability from lower tiers: - If you specify `cloud`: Standard, Plus, Pro, and Enterprise Flex badges all become enabled +- If you specify `cloud-plus`: Plus, Pro, and Enterprise Flex badges become enabled - Standard turns off - If you specify `cloud-teams`: Pro and Enterprise Flex badges become enabled - Standard and Plus turn off - If you specify `enterprise-flex`: Only Enterprise Flex badge becomes enabled diff --git a/docs/platform/cloud/managing-airbyte-cloud/assets/data-worker-usage.png b/docs/platform/cloud/managing-airbyte-cloud/assets/data-worker-usage.png new file mode 100644 index 000000000000..9912600058c1 Binary files /dev/null and b/docs/platform/cloud/managing-airbyte-cloud/assets/data-worker-usage.png differ diff --git a/docs/platform/cloud/managing-airbyte-cloud/manage-data-workers.md b/docs/platform/cloud/managing-airbyte-cloud/manage-data-workers.md new file mode 100644 index 000000000000..332dc649010e --- /dev/null +++ b/docs/platform/cloud/managing-airbyte-cloud/manage-data-workers.md @@ -0,0 +1,55 @@ +--- +products: cloud-plus +--- + +# Monitor data worker usage + +If you are on a capacity-based plan, you can monitor your data worker usage across your organization. To view data worker usage, you need the **organization admin** role. + +## Open the usage chart + +From the navigation bar, click **Organization settings** > **Usage**. + +## How to interpret the chart + +The chart shows daily maximum concurrent data worker usage, from all workspaces in a region, over a period of time. Each bar represents one day. The chart stacks all workspaces in that region so you can see which workspace uses the most data workers each day. + +![Page showing a region, a period of time, and a bar chart with maximum daily data worker usage within that period of time and region](assets/data-worker-usage.png) + +Hover on a day to see more details about it. + +## Filter the chart + +- To change the region, click the region dropdown in the chart's upper left corner and choose a different region. + +- To change the date range, click the date dropdown in the chart's upper right corner and choose a new date range. + +## What to do if you hit your data worker limit + +An infrequent instance of maximum usage probably isn't a problem. If you're regularly hitting your data worker limit, you have three options. + +- Accept that Airbyte may queue or throttle your connections. + +- Reschedule some connections so they run at different times of the day, week, or month. + +- Buy more data workers to increase capacity. + +### Optimize data worker usage + +If you can, it's preferable to optimize Airbyte by rescheduling connections outside of busy periods. + +- **If your usage has peaks and valleys**, find connections that run on busy days and move them to lower-usage days. + +- **If your usage looks consistently high**, examine your scheduling patterns within a day. If a large number of connections start at the same time, data worker usage spikes. + + - Stagger start times over a longer period to allow some connections to finish before others begin. + + - Avoid starting all your syncs at the top of the hour. Starting them at :15, :30, and :45 can more evenly distribute work. + + - If a large number of connections run overnight, data workers might look fully utilized, but sit unused during daylight hours. + +- **If sandbox/staging workspaces consume too much capacity**, consider reducing the frequency of syncs in less critical workspaces. + +### Buy more data workers + +If you've tried to optimize scheduling and still need more data workers, contact your Airbyte representative or [talk to sales](https://www.airbyte.com/talk-to-sales). diff --git a/docusaurus/sidebar-platform.js b/docusaurus/sidebar-platform.js index 2b3cecec675d..b1a0e117b6be 100644 --- a/docusaurus/sidebar-platform.js +++ b/docusaurus/sidebar-platform.js @@ -382,6 +382,7 @@ module.exports = { items: [ "organizations-workspaces/organizations/switch-organizations", "cloud/managing-airbyte-cloud/manage-credits", + "cloud/managing-airbyte-cloud/manage-data-workers", ], }, { diff --git a/docusaurus/src/components/ProductInformation.jsx b/docusaurus/src/components/ProductInformation.jsx index b2d341fc70d0..1d4dc5cf9820 100644 --- a/docusaurus/src/components/ProductInformation.jsx +++ b/docusaurus/src/components/ProductInformation.jsx @@ -38,6 +38,7 @@ export const ProductInformation = ({ products }) => { products["oss-enterprise"] || products["oss-*"] || products["all"]; const cloud = products["cloud"] || products["cloud-teams"] || products["all"]; // cloud add-ons need to be specifically marked and are not part of the "all" shorthand + const cloudPlus = products["cloud-plus"]; const cloudTeams = products["cloud-teams"]; const enterpriseFlex = products["enterprise-flex"]; const embedded = products["embedded"]; @@ -53,11 +54,11 @@ export const ProductInformation = ({ products }) => { > Standard - Plus - + Plus + Pro - + Enterprise Flex Self-Managed Enterprise