-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Uptime Monitoring Docs Updates #12501
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
Changes from all commits
bdda17f
3842cc4
171d3a0
68fa560
3aefcc5
5580a4d
efb5f42
4ea717f
4bb2e14
b7b60cc
2c7a0b3
cf442e0
49c1d5b
12cb9a6
8c551c8
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -76,15 +76,15 @@ Tracing is enabled by and will be billed for in spans. | |
|
||
#### Cron Monitors Pricing | ||
|
||
All Sentry plans include **one cron monitor**. To activate additional monitors, set up a **Pay-As-You-Go (PAYG) budget**. Additional monitors can't be purchased in advance; they are only available through your PAYG budget, which can be shared across all event types. | ||
All Sentry plans include **one cron monitor**. To activate additional cron monitors, set up a **Pay-As-You-Go (PAYG) budget**. Additional cron monitors can't be purchased in advance; they are only available through your PAYG budget, which can be shared across all event types. | ||
|
||
**Key Points:** | ||
|
||
- **Deactivating or Deleting Monitors**: | ||
- **Deactivating or Deleting Cron Monitors**: | ||
- Deactivated or deleted monitors will **count** towards your billing quota if they were previously active in the current billing period. Otherwise, they won't count towards your billing quota. | ||
- Their quota becomes **reusable** within the **same billing period**. | ||
- **Activating Monitors**: | ||
- Sentry first uses any **reusable quota** from monitors deactivated or deleted in the current billing period. | ||
- **Activating Cron Monitors**: | ||
- Sentry first uses any **reusable quota** from cron monitors deactivated or deleted in the current billing period. | ||
- If none is available, your **reserved quota** or **PAYG budget** is used. | ||
|
||
<Alert> | ||
|
@@ -93,23 +93,61 @@ All Sentry plans include **one cron monitor**. To activate additional monitors, | |
|
||
- **Quota Reuse Limitations**: | ||
- Only available **within the same billing period**. | ||
- Applies to monitors that were previously active and billed. | ||
- Applies to cron monitors that were previously active and billed. | ||
- **Reusable Quota Does Not Carry Over**: | ||
- Reusable quota **does not carry over** to new billing periods. | ||
|
||
</Alert> | ||
|
||
**Monitors Across Billing Periods:** | ||
**Cron Monitors Across Billing Periods:** | ||
|
||
- Monitors remain active across billing periods if you have sufficient **reserved quota** or **PAYG budget**. | ||
- Monitors may be automatically deactivated if there's insufficient budget. | ||
- Monitors that have been manually deactivated or deleted remain in that state. | ||
- Cron monitors remain active across billing periods if you have sufficient **reserved quota** or **PAYG budget**. | ||
- Cron monitors may be automatically deactivated if there's insufficient budget. | ||
- Cron monitors that have been manually deactivated or deleted remain in that state. | ||
|
||
|
||
| Team PAYG | Business PAYG | | ||
| ---------- | -------------- | | ||
| $0.7800000 | $0.7800000 | | ||
|
||
#### Uptime Monitors Pricing | ||
|
||
All Sentry plans include **one uptime monitor**. To activate additional uptime monitors, set up a **Pay-As-You-Go (PAYG) budget**. Additional uptime monitors can't be purchased in advance; they are only available through your PAYG budget, which can be shared across all event types. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I noticed 'PAYG' is defined above under 'Terminology', is it worth re-defining here? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I left it here to be consistent with whats in Crons. Lets leave it for now since its close in context here. |
||
|
||
**Key Points:** | ||
|
||
- **Deactivating or Deleting Uptime Monitors**: | ||
- Deactivated or deleted uptime monitors will **count** towards your billing quota only if they were previously active in the current billing period. | ||
- Their quota becomes **reusable** within the **same billing period**. | ||
- **Activating Uptime Monitors**: | ||
- Sentry first uses any **reusable quota** from uptime monitors deactivated or deleted in the current billing period. | ||
- If none is available, your **reserved quota** or **PAYG budget** is used. | ||
|
||
<Alert> | ||
|
||
**Important:** | ||
|
||
- **Quota Reuse Limitations**: | ||
- Only available **within the same billing period**. | ||
- Applies to uptime monitors that were previously active and billed. | ||
- **Reusable Quota Does Not Carry Over**: | ||
- Reusable quota **does not carry over** to new billing periods. | ||
|
||
</Alert> | ||
|
||
**Uptime Monitors Across Billing Periods:** | ||
|
||
- Uptime monitors remain active across billing periods if you have sufficient **reserved quota** or **PAYG budget**. | ||
- Uptime monitors may be automatically deactivated if there's insufficient budget. | ||
- Uptime monitors that have been manually deactivated or deleted remain in that state. | ||
|
||
|
||
| Team PAYG | Business PAYG | | ||
| ---------- | -------------- | | ||
| $1.00 | $1.00 | | ||
|
||
|
||
|
||
#### Attachments Pricing (per GB) | ||
|
||
| Attachment Size | Team Reserved | Team PAYG | Business Reserved | Business PAYG | | ||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -4,42 +4,53 @@ sidebar_order: 30 | |||||
description: "Learn more about the options for configuring an uptime alert." | ||||||
--- | ||||||
|
||||||
<Include name="feature-stage-beta-uptime.mdx" /> | ||||||
|
||||||
Sentry provides several configuration options for creating an uptime alert based on your organization's needs as explained below. | ||||||
|
||||||
## 1. Environment | ||||||
|
||||||
First, specify which <PlatformLink to="/configuration/environments/">environment</PlatformLink> this alert rule belongs to. Any [uptime issues](/product/issues/issue-details/uptime-issues/) that will be created from this alert rule will then be set to your specified environment. | ||||||
|
||||||
You'll notice that the “Environment” dropdown list you see here shows the same environments as the “Environment” dropdown in your project (not including hidden environments). | ||||||
The “Environment” dropdown lists the same environments available in your project, excluding hidden ones. | ||||||
|
||||||
## 2. Project | ||||||
|
||||||
Specify which project your alert rule belongs to so that any [uptime issues](/product/issues/issue-details/uptime-issues/) you create will show up for that specific project. | ||||||
Specify the project associated with your alert rule. Any [uptime issues](/product/issues/issue-details/uptime-issues/) created will appear under this project. | ||||||
|
||||||
## 3. Request Configuration | ||||||
|
||||||
Configure how Sentry should execute an HTTP uptime check, by specifying: | ||||||
 | ||||||
|
||||||
- **URL**: The URL for which Sentry should execute an uptime check request. | ||||||
- **Method**: The request method used to execute the uptime check. Available options are `GET`, `POST`, `HEAD`, `PUT`, `DELETE`, `PATCH`, and `OPTIONS`. | ||||||
- **Headers**: The request headers included in the uptime check request. | ||||||
- **Body**: The body message to include in the uptime check request. (This is only available when the method is set to `POST`, `PUT`, and `PATCH`.) | ||||||
- **Allow Sampling**: Enable "Allow Sampling" to let the Sentry SDK handle span sampling for requests. See the [distributed tracing with uptime](/product/alerts/uptime-monitoring/uptime-tracing/) docs for more detail. | ||||||
Configure how Sentry performs HTTP uptime checks by setting the following options: | ||||||
|
||||||
Make sure to include a `Content-Type` header in your headers configuration in case the specified URL requires it. For example, a JSON message body would have a `Content-Type` header of `application/json`. | ||||||
- **Interval**: The time between each uptime check. Options: `1 minute`, `5 minutes`, `10 minutes`, `20 minutes`, `30 minutes`, and `1 hour`. | ||||||
- **Timeout**: The maximum time Sentry waits for a response before considering the request a failure (up to 30 seconds). | ||||||
- **URL**: The target URL for the uptime check. | ||||||
- **Method**: The HTTP method used (`GET`, `POST`, `HEAD`, `PUT`, `DELETE`, `PATCH`, or `OPTIONS`). | ||||||
- **Headers**: Custom headers included in the request. | ||||||
- **Body**: The request payload, available for `POST`, `PUT`, and `PATCH` methods. | ||||||
- **Allow Sampling**: Enables span sampling for requests via the Sentry SDK. See [distributed tracing with uptime](/product/alerts/uptime-monitoring/uptime-tracing/) for details. | ||||||
|
||||||
<Alert level="warning"> | ||||||
|
||||||
If the specified URL is behind a firewall, make sure Sentry's Uptime Bot can execute requests to it. [Learn more](/product/alerts/uptime-monitoring/troubleshooting/#verify-firewall-configuration). | ||||||
When adding HTTP headers, be cautious of including sensitive data, such as API tokens or personal information, to prevent unintended exposure or storage. | ||||||
|
||||||
</Alert> | ||||||
|
||||||
 | ||||||
|
||||||
Below the request configuration, you'll find an example of the expected request that Sentry will send to the specified URL, including the method, headers, and body. Sentry automatically adds `User-Agent` and `Sentry-Trace` headers. | ||||||
|
||||||
Additional notes: | ||||||
|
||||||
- Include a `Content-Type` header if required by the target URL. For example, a JSON payload should have `Content-Type: application/json`. | ||||||
- The selected interval affects downtime detection speed. Sentry triggers an uptime issue after three consecutive failures. For instance, with a 5-minute interval, downtime is detected at least 15 minutes after the first failure. Learn more about the [uptime check criteria](/product/alerts/uptime-monitoring/#uptime-check-criteria). | ||||||
- In case the specified URL is behind a firewall, make sure Sentry's Uptime Bot can execute requests to it. Learn more about [firewall configuration with uptime monitoring](/product/alerts/uptime-monitoring/troubleshooting/#verify-firewall-configuration). | ||||||
- Sentry Uptime Tracing automatically appends a sentry-trace header to outgoing requests for distributed tracing. [Learn more](/product/alerts/uptime-monitoring/uptime-tracing/). | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
## 4. Alert Name | ||||||
|
||||||
Give your alert a descriptive name, for example, "Landing Page" or "Contact Page". | ||||||
|
||||||
## 5. Ownership | ||||||
|
||||||
Lastly, choose a team to associate with your alert so that members of that team are able to edit the alert if they want to. Note, that you can only add teams that you're a member of. If no team is assigned, anyone will be able to edit the alert. | ||||||
Assign a team or team member to manage the alert. If no team is assigned, any user can modify the alert. [Uptime issues](/product/issues/issue-details/uptime-issues/) created from this alert rule will be set to the specified team or team member. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should 'set to the specified team . . .' be 'sent'? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are there plans to add to this list soon? Having a list of one feels a little weird.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it emphasizes it well, so lets keep it