Skip to content

docs(powershell): Add Crons check-in guide - #19893

Open
sansynx wants to merge 4 commits into
getsentry:masterfrom
sansynx:docs/powershell-crons
Open

sansynx wants to merge 4 commits into
getsentry:masterfrom
sansynx:docs/powershell-crons

Conversation

@sansynx

@sansynx sansynx commented Oct 11, 2026

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Fixes #9696

Add a PowerShell Crons guide using the .NET check-in API included in the PowerShell SDK. The example sends paired start and completion check-ins, reports failures without swallowing them, and closes the SDK before the script exits.

Also link the guide from the supported SDK list and explain how to handle native command exit codes.

Tested the documented example with Sentry PowerShell 0.5.0 using an in-memory transport: success, terminating errors, non-terminating errors, and native command failures. Each case produced matching check-in IDs and the expected status. Both MDX files compile and pass formatting and internal-link checks locally. The Vercel preview has not been verified.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace YYYY-MM-DD with the due date. You can update this information later by editing the PR description.

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've supplied a deadline.

Thanks in advance for your help!

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

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

@vercel

vercel Bot commented Oct 11, 2026

Copy link
Copy Markdown

@sansynx is attempting to deploy a commit to the Sentry Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Oct 11, 2026
@codeowner-assignment
codeowner-assignment Bot requested a review from a team October 11, 2026 05:17
@sansynx
sansynx marked this pull request as ready for review October 11, 2026 05:18
Copilot AI balanced review requested due to automatic review settings October 11, 2026 05:18

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@codeowner-assignment
codeowner-assignment Bot requested a review from a team October 11, 2026 05:18
@cursor

cursor Bot commented Oct 11, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks whether the new Crons guide loads. It also watches PowerShell page errors, Crons setup errors, and not-found volume. An issue escalates when the new page stays unused or those errors and not-found counts rise.

Services: sentry-docs.

Mention @change-monitor in a comment to update the plan.

Plan

What changed

Requests to /platforms/powershell/crons/ now serve a PowerShell Crons check-in guide. The Crons setup page now links to that guide. sentry-docs must deploy before this change is live.

Risk

A broken new page 404s or throws in the browser. A broken sidebar can fail other PowerShell docs pages. A broken setup link can fail the Crons setup page. Readers then cannot follow a PowerShell check-in example.

Intended effect

Successful pageload or navigation spans on the new guide show the change worked. Absent means those spans stay at 0 while other PowerShell pages still load. Traces sample at 30 percent. A quiet page can stay at 0 after a good deploy. Treat a lasting 0 as unknown if sibling PowerShell traffic is also near 0.

Signal Baseline Rule Source
Pageload and navigation spans for url.path:"/platforms/powershell/crons/". Query span.op:[pageload,navigation] url.path:"/platforms/powershell/crons/" environment:production in project docs. Missing PowerShell Crons page. 0 spans from 2026-10-04T05:19:15Z to 2026-10-11T05:19:15Z Rise above 0. The missing-page symptom must stay gone. Sentry traces, org sentry, project docs. Fixes issues/9696

Regression watch

This diff can break the new page, the PowerShell sidebar, and the Crons setup list. Watch errors and not-found counts on those paths first. Error events do not always carry the page URL, so also watch production error volume.

Signal Baseline Rule Source
Production error events per hour. Query environment:production in project docs. 0-32 events per hour, 198 total, from 2026-10-10T05:19:15Z to 2026-10-11T05:19:15Z Hold 0-32 events per hour Sentry errors, org sentry, project docs
PowerShell page errors. Query environment:production http.url:*powershell* 27 events from 2026-10-04T05:19:15Z to 2026-10-11T05:19:15Z Hold at or below 27 events per matching 7d window Sentry errors, org sentry, project docs
Crons setup page errors. Query environment:production http.url:*/product/monitors-and-alerts/monitors/crons/getting-started* 2 events from 2026-10-04T05:19:15Z to 2026-10-11T05:19:15Z Hold 0-2 events per matching 7d window Sentry errors, org sentry, project docs
Not-found rate docs.page.not_found versus docs.page.load, environment:production 56 not-found and 7393 page loads from 2026-10-10T05:19:15Z to 2026-10-11T05:19:15Z, 0.76% Hold near 0.76%. Escalate if not-found rises while page loads hold. Sentry metrics, org sentry, project docs

Sibling PowerShell traffic in the same 7d window was 120 pageload and navigation spans. Use that volume when you judge whether a 0 on the new URL is absent or unsampled.

Not observable

The docs site does not show whether a reader ran the check-in example. A path filter on docs.page.not_found for platforms/powershell returned no value.

@sansynx

sansynx commented Oct 13, 2026

Copy link
Copy Markdown
Contributor Author

the branch is up to date. could you approve the pending workflows and authorize the Vercel preview when you review this?

@vercel

vercel Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
develop-docs Ready Ready Preview Oct 27, 2026 6:00pm UTC
sentry-docs Ready Ready Preview Oct 27, 2026 6:00pm UTC

Request Review

This branch was successfully deployed

2 active (outdated) deployments
Preview – sentry-docs — 792b6069 Deployed Oct 27, 2026 by vercel[bot]
Preview – develop-docs — 792b6069 Deployed Oct 27, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Normal Docs review has no urgent deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Crons docs for PowerShell

2 participants