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

Docs for Java SDK Check-ins #7963

Merged
merged 5 commits into from
Sep 28, 2023
Merged

Docs for Java SDK Check-ins #7963

merged 5 commits into from
Sep 28, 2023

Conversation

adinauer
Copy link
Member

@adinauer adinauer commented Sep 27, 2023

Docs for getsentry/sentry-java#2875

We support

  • manual check-ins through Sentry.captureCheckIn
  • Quartz by registering a SentryJobListener (happens automatically for Spring Boot) and having users provide a monitor slug trough the job data map
  • Spring @Scheduled by having advice config for a new @SentryCheckIn annotation which allows users to specify methods to send check-ins for and what monitor slug to use.

Pre-merge checklist

If you work at Sentry, you're able to merge your own PR without review, but please don't unless there's a good reason.

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

Description of changes

Describe your changes here. If your PR relates to or resolves an issue, add a link to that too.

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

@adinauer adinauer requested a review from a team as a code owner September 27, 2023 05:35
@vercel
Copy link

vercel bot commented Sep 27, 2023

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

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 28, 2023 5:01am

@adinauer adinauer removed the request for review from a team September 27, 2023 05:35

## Check-Ins (Recommended)

Check-in monitoring allows you to track a job's progress by completing two check-ins: one at the start of your job and another at the end of your job. This two-step process allows Sentry to notify you if your job didn't start when expected (missed) or if it exceeded its maximum runtime (failed).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe add something like about the @SentryCheckin Annotation. Not sure if it is clear to the reader by it just being referred to in the code sample.

Copy link
Contributor

@shanamatthews shanamatthews left a comment

Choose a reason for hiding this comment

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

Looked good, just a few small suggestions

Copy link
Contributor

Choose a reason for hiding this comment

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

This content doesn't show up in the preview. I think you need to edit src/platforms/common/crons/troubleshooting.mdx to add Java to the first PlatformSection

adinauer and others added 2 commits September 28, 2023 06:46
Co-authored-by: Shana Matthews <shana.l.matthews@gmail.com>
@adinauer adinauer self-assigned this Sep 28, 2023
@adinauer adinauer merged commit a650509 into master Sep 28, 2023
@adinauer adinauer deleted the feat/java-crons branch September 28, 2023 09:02
@github-actions github-actions bot locked and limited conversation to collaborators Oct 14, 2023
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.

3 participants