Skip to content

Commit 0ebeffe

Browse files
feat(crons): Add product docs for environments (#6679)
Co-authored-by: Liza Mock <[email protected]>
1 parent 37e82ff commit 0ebeffe

File tree

3 files changed

+29
-2
lines changed

3 files changed

+29
-2
lines changed

src/docs/product/crons/getting-started/cli.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,3 +54,9 @@ sentry-cli monitors run my-monitor-slug -- python path/to/file.py
5454
```bash {tabTitle: Node.JS}
5555
sentry-cli monitors run my-monitor-slug -- node path/to/file.js
5656
```
57+
58+
### Specifying Monitor Environments (Optional)
59+
60+
<Alert level="info">
61+
The `sentry-cli` doesn't currently support the ability to specify monitor environment for check-ins.
62+
</Alert>

src/docs/product/crons/job-monitoring.mdx

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,27 @@ This is where you'll find a daily historical bar chart showing successful, faile
2121

2222
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.
2323

24-
The table of recent check-ins lists previously scheduled jobs and their status.
24+
The table of recent check-ins lists previously scheduled jobs and their statuses.
25+
26+
## Multiple Environments
27+
28+
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.
29+
30+
### Alerting on Specific Environments
31+
32+
To only receive failing or missed monitor alerts for a specific environment or set of environments, [configure the
33+
environment](/product/alerts/create-alerts/issue-alert-config/#environment) for
34+
your monitor alert.
35+
36+
### Existing Limitations:
37+
38+
- It's not currently possible to pause an individual monitor environment.
39+
40+
- It's not currently possible to see an aggregate view of a monitors' status
41+
across all environments. Each environment will appear as its own row in the
42+
monitor list.
43+
44+
- Currently, only entire monitors can be removed. Individual monitor environments can't be deleted.
2545

2646
## Pausing Your Cron Monitor
2747

src/docs/product/security-policy-reporting.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,8 @@ In addition to the `sentry_key` parameter, you may also pass the following withi
6262

6363
`sentry_environment`
6464

65-
: The environment name (e.g. production). The environment name can't contain newlines, spaces, or forward slashes, can't be the string "None", or exceed 64 characters. Also, environments are case sensitive.
65+
: The environment name (for example, production).
66+
The environment name is case sensitive, can't contain new lines, spaces, or forward slashes. It can't be the string "None" or exceed 64 characters.
6667

6768
`sentry_release`
6869

0 commit comments

Comments
 (0)