Skip to content

Commit a12fceb

Browse files
committed
update monitor details with state definitions and environment management instructions
1 parent 418889b commit a12fceb

File tree

6 files changed

+71
-17
lines changed

6 files changed

+71
-17
lines changed
75.1 KB
Loading
42.8 KB
Loading
42.8 KB
Loading
75 KB
Loading
42.8 KB
Loading

docs/product/crons/monitor-details.mdx

Lines changed: 71 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ The **Monitor Details** page is where you'll find a daily historical bar chart s
88

99
The "Issues" section shows the issues created from this Cron Monitor. Issues are created when a cron monitor job execution is missed or failed. If you have configured the Sentry SDK for your job, any errors thrown during the job runtime will be shown here as well.
1010

11-
The table of recent check-ins lists previously scheduled jobs and their statuses.
11+
The table of recent check-ins lists previously run jobs and their statuses.
1212

1313
<Arcade src="https://demo.arcade.software/7XmPfL0l2pp6KmBUXwMc?embed" />
1414

15-
## Check-in Statuses
15+
## Check-in Status
1616

1717
Sentry's Cron Monitoring service can notify you and store a timeline of the following check-in events:
1818

@@ -27,30 +27,84 @@ Sentry's Cron Monitoring service can notify you and store a timeline of the foll
2727

2828
To see information about your cron monitor, select "Crons" from the sidebar menu and click on your cron monitor's name.
2929

30+
## Monitor State
31+
32+
A monitor can have three states: active, muted, and disabled. Only disabled monitors do not count towards your plan's monitor limit.
33+
34+
- **Active:** The monitor is currently accepting and processing check-ins. New Cron Monitor issues will be created for failed or missed check-ins according to your monitor configuration.
35+
- **Muted:** The monitor and it's environments are accepting check-ins but will not create any Cron Monitor issues for failed or missed check-ins. This is useful when you want to temporarily disable alerting for a monitor.
36+
- **Disabled:** The monitor and it's environments are not accepting check-ins, with any check-ins sent to a disabled monitor will be dropped. Disabled monitors do not count towards your plan's monitor limit.
37+
38+
<Alert level="info" title="Note">
39+
The monitor state supercedes the [environment state](#environment-state). If a
40+
monitor is disabled or muted, so will all environments of it's environments,
41+
regardless of their individual state.
42+
</Alert>
43+
44+
### Muting Monitors
45+
46+
You can mute job monitoring in the header of your cron monitor:
47+
48+
![Muting a Cron Monitor](./img/muting-monitor.png)
49+
50+
### Disabling Monitors
51+
52+
You can disable job monitoring in the header of your cron monitor:
53+
54+
![Disabling a Cron Monitor](./img/disabling-monitor.png)
55+
56+
### Deleting Monitors
57+
58+
You can delete a monitor from the monitor details page.
59+
60+
![Deleting a Cron Monitor](./img/deleting-monitor.png)
61+
62+
<Alert level="danger" title="Caution">
63+
Deleting a monitor will remove all of its environments and check-in history.
64+
This action is irreversible.
65+
</Alert>
66+
3067
## Multiple Environments
3168

32-
To monitor the same job in different environments, use a shared schedule to send check-ins for multiple environments to one monitor. Each environment will have its own status and set of check-ins.
69+
A monitor can be configured with multiple environments, with all environments running with the same schedule. Only environments with at least one check-in will be displayed and made available for alerting and filtering.
70+
71+
Although the schedule of check-ins of all environments are the same, the environment state and check-ins are independent of each other. This means that a missed or failed check-in in one environment will not affect the state of other environments.
72+
73+
If you're using one of Crons' [supported SDKs](/product/crons/getting-started/), the check-in environment will be automatically set to the environment configured in the SDK. If you're using the API, you can set the environment in the check-in payload.
74+
75+
## Environment State
76+
77+
Indepent of the monitor state, each environment can have one of the following states:
78+
79+
- **Healthy:** The environment's latest check-in was successful.
80+
- **Unhealthy:** The environment's latest check-in was a failure or a miss.
81+
- **Waiting for check-in:** The environment has not had any check-ins.
82+
- **Muted:** The environment is muted and will not create any Cron Monitor issues.
83+
- **Broken:** The environment has multiple failed or missed check-ins in a row.
84+
85+
### Broken Environments
3386

34-
### Alerting on Specific Environments
87+
Monitor environments that have been consistenly unhealthy for 14 days will be marked as broken. If no action is taken, Sentry will automatically mute the environment after 30 days of being broken. To recover a broken environment, a new healthy check-in must be sent.
3588

36-
To only receive failing or missed monitor alerts for a specific environment or set of environments, [configure the
37-
environment](/product/alerts/create-alerts/issue-alert-config/#environment) for
38-
your monitor alert.
89+
### Muting Environments
3990

40-
### Existing Limitations:
91+
To mute an environment, you can do so from the monitor list or the monitor details page.
4192

42-
- It's not currently possible to pause an individual monitor environment.
93+
1. Hover the environment state.
94+
2. Select "Mute Environment".
4395

44-
- It's not currently possible to see an aggregate view of a monitors' status
45-
across all environments. Each environment will appear as its own row in the
46-
monitor list.
96+
![Muting a Cron Monitor environment](./img/muting-environment.png)
4797

48-
## Ownership
98+
### Deleting Environments
4999

50-
Cron monitors can be assigned an owner as either a Team or specific Organization Member. When an owner is assigned to a monitor, new issues produced by failures of that monitor will be assigned to that owner.
100+
To delete an environment, you can do so from the monitor list or the monitor details page.
51101

52-
## Pausing Your Cron Monitor
102+
1. Hover the environment state.
103+
2. Select "Delete Environment".
53104

54-
You can pause job monitoring in the header of your cron monitor. When you pause, your monitor will stop recording check-ins and will no longer notify you of any failed or missed check-ins.
105+
![Muting a Cron Monitor environment](./img/deleting-environment.png)
55106

56-
Note: Pausing your cron monitor won't pause the execution of your job or change the configuration of your job scheduler.
107+
<Alert level="danger" title="Caution">
108+
Deleting an environment will remove all check-in history associated with that
109+
environment.
110+
</Alert>

0 commit comments

Comments
 (0)