-
Notifications
You must be signed in to change notification settings - Fork 471
Add Spend Alerts Documentation #6261
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
+67
−0
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| --- | ||
| sidebar_label: 'Spend alerts' | ||
| slug: /cloud/manage/billing/spend-alerts | ||
| title: 'Configure organization spend alerts' | ||
| description: 'Configure spend alerts to monitor ClickHouse Cloud usage against thresholds within a billing period.' | ||
| keywords: ['billing', 'spend alerts', 'usage thresholds', 'notifications', 'cost monitoring', 'organization billing'] | ||
| doc_type: 'guide' | ||
| --- | ||
|
|
||
| import Image from '@theme/IdealImage'; | ||
| import spend_alerts_actions from '@site/static/images/cloud/reference/billing/spend-alerts-actions.png'; | ||
| import spend_alerts_config from '@site/static/images/cloud/reference/billing/spend-alerts-config.png'; | ||
|
|
||
| Spend alerts notify you when your organization's usage reaches configured thresholds within a billing period, so you can avoid unexpected charges. They send notifications only; for thresholds that trigger automatic invoicing, see [Payment thresholds](/cloud/billing/payment-thresholds). | ||
|
|
||
| ## Prerequisites {#prerequisites} | ||
|
|
||
| - You must have an **Organization Admin** or **Billing Admin** role to configure and view spend alerts. | ||
|
|
||
| ## How spend alerts work {#how-spend-alerts-work} | ||
|
|
||
| - Alerts are based on gross usage within a billing period and reset at the start of each new cycle. | ||
| - Alerts fire every hour, based on the gross usage calculated at that time, so an alert fires after a threshold is exceeded. | ||
|
|
||
| :::note Spend alerts don't cap usage | ||
| Reaching 100% of your spend alert doesn't restrict or cap your usage — spending continues to accumulate beyond the 100% threshold. | ||
| ::: | ||
|
|
||
| ## Set up a spend alert {#set-up-spend-alert} | ||
|
|
||
| <VerticalStepper headerLevel="h3"> | ||
|
|
||
| ### Open the spend alerts dialog {#open-spend-alerts-dialog} | ||
|
|
||
| 1. Navigate to **Organization > Billing** in the ClickHouse Cloud console. | ||
| 2. Click **Actions > Add spend alerts**. | ||
|
|
||
| <Image img={spend_alerts_actions} alt="Billing page with the Actions menu open and Add spend alerts highlighted" size="lg"/> | ||
|
|
||
| ### Configure and save the alert {#configure-and-save} | ||
|
|
||
| 1. Enter a spend alert amount in dollars or credits per billing period. | ||
| 2. Select your notification channels: **Email**, **UI**, and/or **Slack**. | ||
| 3. Click **Save**. | ||
|
|
||
| <Image img={spend_alerts_config} alt="Organization spend alerts dialog with spend limit, automatic threshold alerts, and notification channels" size="md"/> | ||
|
|
||
| </VerticalStepper> | ||
|
|
||
| ## Automatic threshold alerts {#threshold-alerts} | ||
|
|
||
| Three alerts are automatically created and triggered based on your configured spend alert amount: | ||
|
|
||
| | Threshold | Trigger | Example ($10 alert) | | ||
| |-----------|---------------------------------|---------------------| | ||
| | **50%** | Half of spend reached | $5 | | ||
| | **75%** | Three-quarters of spend reached | $7.50 | | ||
| | **100%** | Full spend reached | $10 | | ||
|
|
||
| ## Notification channels {#notification-channels} | ||
|
|
||
| | Channel | Description | | ||
| |-----------|--------------------------------------------------------------------------------------------| | ||
| | **Email** | Sends alerts to the configured email address. Click the edit icon to change the recipient. | | ||
| | **UI** | Displays alerts in the ClickHouse Cloud console. | | ||
| | **Slack** | Sends alerts to a Slack channel. Click the edit icon to configure. | | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.