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.

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

Add Uptime Monitoring Documentation #10810

Merged
merged 17 commits into from
Aug 13, 2024
Merged

Add Uptime Monitoring Documentation #10810

merged 17 commits into from
Aug 13, 2024

Conversation

gaprl
Copy link
Member

@gaprl gaprl commented Jul 23, 2024

DESCRIBE YOUR PR

Adds new pages describing our new uptime monitoring feature, and updates various other relevant pages to reference uptime alerts.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.): EA planned for July 31st, 2024
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

Copy link

vercel bot commented Jul 23, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
changelog ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 7, 2024 7:18pm
develop-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 7, 2024 7:18pm
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 7, 2024 7:18pm

Copy link

codecov bot commented Jul 23, 2024

Bundle Report

Changes will decrease total bundle size by 3 bytes ⬇️

Bundle name Size Change
sentry-docs-edge-server 253.05kB 3 bytes ⬇️

Copy link
Contributor

@lizokm lizokm left a comment

Choose a reason for hiding this comment

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

Wow! You've done such an amazingly thorough job with these docs. They look great. Thank you so much!

docs/product/alerts/uptime-monitoring/index.mdx Outdated Show resolved Hide resolved
docs/product/alerts/uptime-monitoring/index.mdx Outdated Show resolved Hide resolved
docs/product/alerts/uptime-monitoring/index.mdx Outdated Show resolved Hide resolved
docs/product/alerts/uptime-monitoring/index.mdx Outdated Show resolved Hide resolved
docs/product/alerts/index.mdx Outdated Show resolved Hide resolved
docs/product/alerts/uptime-monitoring/troubleshooting.mdx Outdated Show resolved Hide resolved
docs/product/alerts/uptime-monitoring/troubleshooting.mdx Outdated Show resolved Hide resolved
docs/product/alerts/uptime-monitoring/troubleshooting.mdx Outdated Show resolved Hide resolved
docs/product/issues/issue-details/uptime-issues/index.mdx Outdated Show resolved Hide resolved
docs/product/issues/issue-details/uptime-issues/index.mdx Outdated Show resolved Hide resolved
Co-authored-by: Liza Mock <liza.mock@sentry.io>
1. **Successful Response (2xx Status Codes):**
The URL must return an HTTP status code in the 200–299 range, indicating a successful request.
2. **Automatic Handling of Redirects (3xx Status Codes):** URLs returning an HTTP status code in the 300–399, indicating a redirect, will trigger Sentry to automatically follow the redirect and verify that the final destination URL returns a successful response. This ensures that redirects won't falsely trigger downtime alerts.
3. **Timeout Setting:** Each request has a timeout threshold of 10 seconds.
Copy link
Member

Choose a reason for hiding this comment

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

It's actually 5 seconds right now isn't it @wedamija ?

Copy link
Member

Choose a reason for hiding this comment

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

It's 10 seconds right now

gaprl added a commit to getsentry/sentry that referenced this pull request Aug 6, 2024
Updates the uptime checker `User-Agent` to match what we have described
in our [documentation
PR.](getsentry/sentry-docs#10810)
Comment on lines +26 to +31
Alternatively, the hostname's `robots.txt` can be updated to disallow Sentry:

```txt{tabTitle: Example}{filename: robots.txt}
User-agent: SentryUptimeBot
Disallow: *
```
Copy link
Member

Choose a reason for hiding this comment

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

Note that this will just disable detection at the moment, it won't disable an ongoing checker (even in onboarding mode)

1. **Successful Response (2xx Status Codes):**
The URL must return an HTTP status code in the 200–299 range, indicating a successful request.
2. **Automatic Handling of Redirects (3xx Status Codes):** URLs returning an HTTP status code in the 300–399, indicating a redirect, will trigger Sentry to automatically follow the redirect and verify that the final destination URL returns a successful response. This ensures that redirects won't falsely trigger downtime alerts.
3. **Timeout Setting:** Each request has a timeout threshold of 10 seconds.
Copy link
Member

Choose a reason for hiding this comment

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

It's 10 seconds right now

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants