Skip to content

docs(java): Document Quartz monitor config upsert - #19777

Open
wedamija wants to merge 7 commits into
masterfrom
danf/quartz-cron-config-docs
Open

wedamija wants to merge 7 commits into
masterfrom
danf/quartz-cron-config-docs

Conversation

@wedamija

@wedamija wedamija commented Oct 2, 2026 •

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

Adds a "Monitor Config" section to the Quartz integration page. SentryJobListener sends a monitor config derived from the job's trigger by default, so Sentry creates the monitor from code. The section covers which triggers convert, the upgrade effect on existing monitors, and how to turn it off (SentryJobListener.SENTRY_UPSERT_MONITOR_CONFIG_KEY set to "false").

SDK PR: getsentry/sentry-java#6216

Merge after the SDK release, and replace "the next Sentry Java SDK release (after 8.59.0)" with the released version.

IS YOUR CHANGE URGENT?

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

PRE-MERGE CHECKLIST

  • 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

@vercel

vercel Bot commented Oct 2, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
sentry-docs Ready Ready Preview Oct 6, 2026 12:51am UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Oct 6, 2026 12:51am UTC

Request Review

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
A JDBC job store with useProperties only accepts String values.

Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
@cursor

cursor Bot commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks Java page errors, Java not-found events, and code tab errors. An issue escalates when Java page errors or not-found events rise. The new heading has no telemetry signal.

Services: sentry-docs.

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

Plan

What changed

The Quartz integration pages now show a Monitor Config section. The section states that SentryJobListener sends trigger-derived monitor config by default. It lists which triggers convert and how to turn upsert off.

This change is live after sentry-docs deploys. The file lives under Java common content. Each Java guide Quartz URL serves the same section.

Risk

A bad static page can 404 the Quartz URLs. Java guides inherit this file, so those URLs change together. The new code sample can throw in the code tab UI.

Intended effect

This change is a docs edit. No metric shows the new heading text. Mark intended_effect unknown. Do not treat Quartz page-load counts as proof. Those counts were zero before deploy.

Regression watch

The blast radius is the Java Quartz pages and the shared code tab UI. Watch Java URL errors and Java not-found events. Watch code tab errors because this diff adds a Java sample.

Signal Baseline Window Rule Source
Error events on /platforms/java/ URLs 0-1 events 2026-10-04T23:38:51Z to 2026-10-05T23:38:51Z Hold this band. Escalate above 1 event. Sentry org sentry, project docs, environment production. Query: environment:production AND (url:*/platforms/java/* OR transaction:*/platforms/java/*) with count().
docs.page.not_found with requested_path:platforms/java 2 events 2026-10-04T23:38:51Z to 2026-10-05T23:38:51Z Hold 0-2 events. Escalate above 2. Pair with Java page loads. Sibling /platforms/java/guides/spring-boot/ loaded 42 times in this window. Sentry org sentry, project docs. Query: metric.name:docs.page.load AND metric.type:counter AND environment:production AND path:/platforms/java/* and metric.name:docs.page.not_found AND environment:production AND requested_path:platforms/java.
Code tab error events 0 events 2026-10-04T23:38:51Z to 2026-10-05T23:38:51Z Hold at zero. Escalate if any event appears. Sentry org sentry, project docs, environment production. Query: environment:production AND (title:*code tabs* OR title:*CodeTabs*) with count().

If Java URL errors rise, inspect client errors on code tabs and on Quartz paths. Common inherited URLs include /platforms/java/integrations/quartz/ and /platforms/java/guides/*/integrations/quartz/.

Not observable

The live HTML for the Monitor Config heading is not in Sentry. Quartz docs.page.load was null in this window. Pageload traces for those URLs were also zero at 30 percent sample. The documented SDK upsert behavior is not in this docs deploy.


## Monitor Config

From the next Sentry Java SDK release (after `8.59.0`), `SentryJobListener` sends a monitor config derived from the job's trigger with each check-in, so Sentry creates the monitor (or updates its schedule) from your code. This is on by default for every job that has a monitor slug.

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.

Bug: The documentation contains a placeholder version string that was not replaced with the actual version number, leaving users unsure which SDK version is required.
Severity: LOW

Suggested Fix

Replace the placeholder text "the next Sentry Java SDK release (after 8.59.0)" with the correct, released version number of the Sentry Java SDK.

Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.

Location: docs/platforms/java/common/integrations/quartz.mdx#L85

Potential issue: The documentation at
`docs/platforms/java/common/integrations/quartz.mdx:85` contains a placeholder version
string: "the next Sentry Java SDK release (after `8.59.0`)". This was intended to be
replaced with a specific version number before publication. Because this pre-merge step
was missed, users are unable to determine the exact SDK version required for the
described feature.

Did we get this right? 👍 / 👎 to inform future reviews.

Comment thread docs/platforms/java/common/integrations/quartz.mdx Outdated
Co-Authored-By: Claude <noreply@anthropic.com>

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — 972655b5 Deployed Oct 6, 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.

1 participant