Skip to content
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.

Sign up for GitHub

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

fix: 404 redirection on docs [sc-00] #943

Merged
merged 3 commits into from
Nov 23, 2023
Merged

fix: 404 redirection on docs [sc-00] #943

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3fb65e5
fix: 404 redirection on docs [sc-00]
pilimartinez Nov 22, 2023
fbfbd0c
Merge branch 'main' into fix-404-on-docs
pilimartinez Nov 23, 2023
53057ad
Merge branch 'main' into fix-404-on-docs
pilimartinez Nov 23, 2023
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
4 changes: 2 additions & 2 deletions site/content/docs/cli/constructs-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ These Check types share properties derived from the abstract class `Check`.
| `tags` | An array of tags to help you organize your Checks, i.e. `['product', 'api']`. | `API`, `Browser`, `Heartbeat` |
| `runtimeId` | The ID of which [runtime](https://www.checklyhq.com/docs/runtimes/specs/) to use for this Check. | `API`, `Browser` |
| `testOnly` | A boolean determining if the Check is available only when `test` runs and not included when `deploy` is executed. | `API`, `Browser` |
| `retryStrategy` | A [RetryStrategy](#retrystrategy) object configuring [retries](/docs/retries-and-alerting/) for failed check runs. | `API`, `Browser` |
| `retryStrategy` | A [RetryStrategy](#retrystrategy) object configuring [retries](/docs/alerting-and-retries/) for failed check runs. | `API`, `Browser` |
| `doubleCheck` | (deprecated) A boolean value if Checkly should double check on failure. This option is deprecated in favor of `retryStrategy`. | `API`, `Browser` |

> Note that most properties have sane default values and do not need to be specified.
Expand Down Expand Up @@ -358,7 +358,7 @@ new ApiCheck('check-group-api-check-1', {
- `environmentVariables`: An array of objects defining variables in the group scope, i.e. `[{ key: 'DEBUG', value: 'true' }]`
- `localSetupScript`: Any JS/TS code as a string to run before each API Check in this group.
- `localTearDownScript`: Any JS/TS code as a string to run after each API Check in this group.
- `retryStrategy`: A [RetryStrategy](#retrystrategy) object configuring [retries](/docs/retries-and-alerting/) for failed check runs.
- `retryStrategy`: A [RetryStrategy](#retrystrategy) object configuring [retries](/docs/alerting-and-retries/) for failed check runs.
- `apiCheckDefaults`: A set of defaults for API Checks. This should not be needed. Just compose shared defaults using JS/TS.
- `browserChecks`: A set of defaults for Browser Checks. This should not be needed. Just compose shared defaults using JS/TS.

Expand Down
6 changes: 3 additions & 3 deletions site/content/docs/heartbeat-checks/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Note the use of the retry option. We recommend always using retries when availab

To create a new heartbeat check, click the `+` icon on the sidebar & select **heartbeat check**.

Creating a heartbeat check is quick and easy; the check requires a name and the period and grace settings defined. These can all be changed later on. Optionally, you can customize tags or [alert settings](/docs/retries-and-alerting/alert-settings/).
Creating a heartbeat check is quick and easy; the check requires a name and the period and grace settings defined. These can all be changed later on. Optionally, you can customize tags or [alert settings](/docs/alerting-and-retries/alert-settings/).

Once you have created your check, the service or host you want to monitor needs to be configured to send a request to the ping URL. When creating or editing the check you can find code examples for how to send requests using JavaScript, Python or in Bash in the quickstart section.

Expand Down Expand Up @@ -86,9 +86,9 @@ Ping now is also available in the quick menu in the heartbeat overview page.
> Please note that this list might change in the future.

### Alerting
By default Checkly uses your account default alert settings and channels. You can configure any of the provided [alert channels](/docs/retries-and-alerting/alert-channels/#managing-alert-channels) for a heartbeat check. If we don’t provide your preferred alert method, use [webhooks](/docs/retries-and-alerting/webhooks/) to configure your alert flow. When configuring a check, you can choose if it should use the account default channels or a selection specific to the check.
By default Checkly uses your account default alert settings and channels. You can configure any of the provided [alert channels](/docs/alerting-and-retries/alert-channels/#managing-alert-channels) for a heartbeat check. If we don’t provide your preferred alert method, use [webhooks](/docs/alerting-and-retries/webhooks/) to configure your alert flow. When configuring a check, you can choose if it should use the account default channels or a selection specific to the check.

> Note that some alerting channels, like [SMS](/docs/retries-and-alerting/sms-delivery/) and [Phone call](/docs/retries-and-alerting/phone-calls/) are only available on our [Team and Enterprise plans](https://www.checklyhq.com/pricing#features)
> Note that some alerting channels, like [SMS](/docs/alerting-and-retries/sms-delivery/) and [Phone call](/docs/alerting-and-retries/phone-calls/) are only available on our [Team and Enterprise plans](https://www.checklyhq.com/pricing#features)


## Reporting
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/integrations/prometheus-v2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ The following metrics are available to monitor checks:
| `checkly_browser_check_duration_seconds` | Histogram | The total check duration. This includes all pages visited and any waits. |
| `checkly_browser_check_errors` | Histogram | The errors encountered during a full browser session. |
| `checkly_api_check_timing_seconds` | Histogram | The response time for the API request, as well as the duration of the different phases. |
| `checkly_time_to_ssl_expiry_seconds` | Gauge | The amount of time remaining before the SSL certificate of the monitored domain expires. See the [SSL certificate expiration docs](/docs/retries-and-alerting/ssl-expiration/) for more information on monitoring SSL certificates with checks. |
| `checkly_time_to_ssl_expiry_seconds` | Gauge | The amount of time remaining before the SSL certificate of the monitored domain expires. See the [SSL certificate expiration docs](/docs/alerting-and-retries/ssl-expiration/) for more information on monitoring SSL certificates with checks. |

The `checkly_check_status` and `checkly_check_result_total` metrics contain a `status` label with values `passing`, `failing`, and `degraded`.
The `checkly_check_status` gauge is `1` when the check has the status indicated by the `status` label and is `0` otherwise.
Expand Down
Loading