-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Update monitor details with state definitions and environment management instructions #11896
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 3 commits
3f74cc2
418889b
a12fceb
6384eca
f3de28f
2be7ae2
00a0641
8428c4a
e03f554
5ea752a
3967744
61b4a49
6008292
4021582
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,110 @@ | ||||||||||||||||||||||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||||||||||||||||||||||
| title: Monitor Details | ||||||||||||||||||||||||||||||||||||||||||||||
| sidebar_order: 1 | ||||||||||||||||||||||||||||||||||||||||||||||
| description: "Learn how to navigate the Monitor Details page to help you understand your recurring job's overall health." | ||||||||||||||||||||||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| The **Monitor Details** page is where you'll find a daily historical bar chart showing successful, failed, and missed check-ins and a line chart of the runtime average for the job execution. | ||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| The table of recent check-ins lists previously run jobs and their statuses. | ||||||||||||||||||||||||||||||||||||||||||||||
lizokm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| <Arcade src="https://demo.arcade.software/7XmPfL0l2pp6KmBUXwMc?embed" /> | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| ## Check-in Status | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| Sentry's Cron Monitoring service can notify you and store a timeline of the following check-in events: | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| - **Missed check-in:** The job didn't execute in the predicted timeframe or frequency. This can happen for various reasons, such as: | ||||||||||||||||||||||||||||||||||||||||||||||
| - The job scheduler is misconfigured, skipped, or failed to initiate your job. | ||||||||||||||||||||||||||||||||||||||||||||||
| - A timeout failure event when a job sent an initial check-in but failed to send a final check-in. | ||||||||||||||||||||||||||||||||||||||||||||||
| - Network issues, such as an outbound firewall or an unstable connection. | ||||||||||||||||||||||||||||||||||||||||||||||
| - An invalid request format. | ||||||||||||||||||||||||||||||||||||||||||||||
| - **Failed check-in:** The job has reported its execution as unsuccessful. | ||||||||||||||||||||||||||||||||||||||||||||||
| - **Successful check-in:** The job has reported its execution as successful. | ||||||||||||||||||||||||||||||||||||||||||||||
| - **Unknown check-in:** In rare occasions, it is possible that Sentry is unable to identify a check-in status. This can happen during outages or maintenance periods. | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| To see information about your cron monitor, select "Crons" from the sidebar menu and click on your cron monitor's name. | ||||||||||||||||||||||||||||||||||||||||||||||
lizokm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| ## Monitor State | ||||||||||||||||||||||||||||||||||||||||||||||
lizokm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| A monitor can have three states: active, muted, and disabled. Only disabled monitors do not count towards your plan's monitor limit. | ||||||||||||||||||||||||||||||||||||||||||||||
lizokm marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| - **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. | ||||||||||||||||||||||||||||||||||||||||||||||
| - **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. | ||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||
| - **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. | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| <Alert level="info" title="Note"> | ||||||||||||||||||||||||||||||||||||||||||||||
| The monitor state supercedes the [environment state](#environment-state). If a | ||||||||||||||||||||||||||||||||||||||||||||||
| monitor is disabled or muted, so will all environments of it's environments, | ||||||||||||||||||||||||||||||||||||||||||||||
| regardless of their individual state. | ||||||||||||||||||||||||||||||||||||||||||||||
| </Alert> | ||||||||||||||||||||||||||||||||||||||||||||||
|
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
lizokm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| ### Muting Monitors | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| You can mute job monitoring in the header of your cron monitor: | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| ### Disabling Monitors | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| You can disable job monitoring in the header of your cron monitor: | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| ### Deleting Monitors | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| You can delete a monitor from the monitor details page. | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| <Alert level="danger" title="Caution"> | ||||||||||||||||||||||||||||||||||||||||||||||
| Deleting a monitor will remove all of its environments and check-in history. | ||||||||||||||||||||||||||||||||||||||||||||||
| This action is irreversible. | ||||||||||||||||||||||||||||||||||||||||||||||
| </Alert> | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| ## Multiple Environments | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
lizokm marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||||||||||||||||||||||||||||||||||||||
| ## Environment State | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| Indepent of the monitor state, each environment can have one of the following states: | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| - **Healthy:** The environment's latest check-in was successful. | ||||||||||||||||||||||||||||||||||||||||||||||
| - **Unhealthy:** The environment's latest check-in was a failure or a miss. | ||||||||||||||||||||||||||||||||||||||||||||||
| - **Waiting for check-in:** The environment has not had any check-ins. | ||||||||||||||||||||||||||||||||||||||||||||||
| - **Muted:** The environment is muted and will not create any Cron Monitor issues. | ||||||||||||||||||||||||||||||||||||||||||||||
| - **Broken:** The environment has multiple failed or missed check-ins in a row. | ||||||||||||||||||||||||||||||||||||||||||||||
lizokm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| ### Broken Environments | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| ### Muting Environments | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| To mute an environment, you can do so from the monitor list or the monitor details page. | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| 1. Hover the environment state. | ||||||||||||||||||||||||||||||||||||||||||||||
| 2. Select "Mute Environment". | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
lizokm marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||||||||||||||||||||||||||||||||||||||
| ### Deleting Environments | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| To delete an environment, you can do so from the monitor list or the monitor details page. | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| 1. Hover the environment state. | ||||||||||||||||||||||||||||||||||||||||||||||
| 2. Select "Delete Environment". | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||
| <Alert level="danger" title="Caution"> | ||||||||||||||||||||||||||||||||||||||||||||||
| Deleting an environment will remove all check-in history associated with that | ||||||||||||||||||||||||||||||||||||||||||||||
| environment. | ||||||||||||||||||||||||||||||||||||||||||||||
| </Alert> | ||||||||||||||||||||||||||||||||||||||||||||||
lizokm marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||||||||||||||||||||||||||||||||||||||
Uh oh!
There was an error while loading. Please reload this page.