Skip to content
Closed
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/product/crons/img/deleting-environment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/product/crons/img/deleting-monitor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/product/crons/img/disabling-monitor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/product/crons/img/muting-environment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/product/crons/img/muting-monitor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
55 changes: 0 additions & 55 deletions docs/product/crons/job-monitoring.mdx

This file was deleted.

110 changes: 110 additions & 0 deletions docs/product/crons/monitor-details.mdx
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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The timeline is here too right?

Also it's actually an Area chat for the durations


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.

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

## Monitor State

A monitor can have three states: active, muted, and disabled. Only disabled monitors do not count towards your plan's monitor limit.

- **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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

timeouts too, not sure if you want to include that

- **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>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
A monitor can have three states: active, muted, and disabled. Only disabled monitors do not count towards your plan's monitor limit.
- **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>
A monitor can have three states: active, muted, and disabled. Only disabled monitors do not count towards your plan's monitor limit.
- **Active:** The monitor is accepting and processing check-ins. If a check-in fails or is missed, new Cron Monitor issues will be created based on your monitor's configuration.
- **Muted:** The monitor and its environments accept check-ins, but won't create Cron Monitor issues for failed or missed check-ins. This is useful if you want to temporarily pause alerts without stopping check-ins.
- **Disabled:** The monitor and its environments no longer accept check-ins. Any check-ins sent to a disabled monitor will be ignored. Disabled monitors don't count towards your plan's monitor limit.
<Alert level="info" title="Note">
The monitor state supersedes the [environment state](#environment-state). If a monitor is disabled or muted, all of its environments will automatically inherit that state, regardless of their individual settings.
</Alert>


### Muting Monitors

You can mute job monitoring in the header of your cron monitor:

![Muting a Cron Monitor](./img/muting-monitor.png)

### Disabling Monitors

You can disable job monitoring in the header of your cron monitor:

![Disabling a Cron Monitor](./img/disabling-monitor.png)

### Deleting Monitors

You can delete a monitor from the monitor details page.

![Deleting a Cron Monitor](./img/deleting-monitor.png)

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

## 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.

### 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".

![Muting a Cron Monitor environment](./img/muting-environment.png)

### 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".

![Muting a Cron Monitor environment](./img/deleting-environment.png)

<Alert level="danger" title="Caution">
Deleting an environment will remove all check-in history associated with that
environment.
</Alert>
4 changes: 4 additions & 0 deletions src/middleware.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3351,6 +3351,10 @@ const USER_DOCS_REDIRECTS: Redirect[] = [
from: '/clients/cordova/',
to: '/platforms/javascript/guides/cordova/',
},
{
from: '/product/crons/job-monitoring/',
to: '/product/crons/monitor-details/',
},
];

const DEVELOPER_DOCS_REDIRECTS: Redirect[] = [
Expand Down
Loading