Skip to content

Conversation

sfanahata
Copy link
Contributor

@sfanahata sfanahata commented Oct 14, 2025

DESCRIBE YOUR PR

Adding more details to Java options since moving everything to SDKoption formatting

Preview: https://sentry-docs-git-java-options-updates.sentry.dev/platforms/java/configuration/options/

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.):
  • Other deadline:
  • None: 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 added an urgent due date to it.
    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

Copy link

vercel bot commented Oct 14, 2025

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

Project Deployment Preview Comments Updated (UTC)
sentry-docs Ready Ready Preview Comment Oct 14, 2025 10:20pm
1 Skipped Deployment
Project Deployment Preview Comments Updated (UTC)
develop-docs Ignored Ignored Oct 14, 2025 10:20pm

@codeowner-assignment codeowner-assignment bot requested a review from a team October 14, 2025 21:51
Copy link

codecov bot commented Oct 14, 2025

Bundle Report

Changes will decrease total bundle size by 15 bytes (-0.0%) ⬇️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-client-array-push 10.16MB -6 bytes (-0.0%) ⬇️
sentry-docs-server-cjs 12.98MB -9 bytes (-0.0%) ⬇️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.78MB -0.0%
../instrumentation.js -3 bytes 1.1MB -0.0%
9523.js -3 bytes 1.08MB -0.0%
view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 882.71kB -0.0%
static/chunks/8321-*.js -3 bytes 425.87kB -0.0%
server/middleware-*.js 6.46kB 7.46kB 645.5% ⚠️
server/middleware-*.js -6.46kB 1.0kB -86.59%
static/1sZLcSgA7lU9Zcpl3HZFI/_buildManifest.js (New) 684 bytes 684 bytes 100.0% 🚀
static/1sZLcSgA7lU9Zcpl3HZFI/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/yut_gdq4lY52bSTpqiwzW/_buildManifest.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️
static/yut_gdq4lY52bSTpqiwzW/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️

</SdkOption>

<SdkOption name="maxRequestBodySize" type="enum">
<SdkOption name="maxRequestBodySize" type="enum" defaultValue="never">
Copy link
Member

Choose a reason for hiding this comment

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

Technically it's RequestSize.NONE in the code.
Not sure if we want to reflect that or we would rather keep a perhaps more nicer to read never, up to you.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I would go with lower case still, but is none the proper customer-facing value that should be used?

Copy link
Member

Choose a reason for hiding this comment

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

Yeah, the value should be none, not never in this case.
Same reasoning as for the other comment applies to the casing.

</SdkOption>

<SdkOption name="diagnosticLevel" type="enum">
<SdkOption name="diagnosticLevel" type="enum" defaultValue="debug">
Copy link
Member

Choose a reason for hiding this comment

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

Same as above, technically in the code it's SentryLevel.DEBUG.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think we can leave the casing alone, unless you think it would break without explicitly suggesting all caps.

Copy link
Member

@lcian lcian Oct 16, 2025

Choose a reason for hiding this comment

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

Yeah, my doubt was more about, do we want this to reflect the code exactly or should this be more of an indication of what to pass.
If you wanted this to be strict you would have to make it SentryLevel.DEBUG or something, but I think just debug is fine and indicates what to pass even if it's not always strictly correct.

If you're configuring this through code you will clearly see in your editor that you need to pass SentryLevel.DEBUG.
If you use other configuration methods we have in java (Spring's application.properties) then it's fine to specify it as sentry.diagnostic-level=debug as we convert the value to upper case when reading it 👍

@lcian
Copy link
Member

lcian commented Oct 16, 2025

On a side note @sfanahata we might want to figure out how to deal with the options in the Spring/Spring Boot cases as well.
They are the same options but in those cases you can also configure them through application.properties, which is the preferred configuration method in Spring/Spring Boot.
For example dsn is specified as sentry.dsn=<something> in application.properties.
This is not super clear from the docs on https://docs.sentry.io/platforms/java/configuration/options/ and I suspect it might not be super obvious that you can configure that way as well.
I wonder if we should come up with a better way to surface this, maybe extend the options component to handle this case as well? Obviously doesn't need to be done here but we can consider it as a future step.
It is only specific to Spring and Spring Boot though, so maybe we enable it there and automatically derive the property name (e.g. diagnosticLevel -> sentry.diagnostic-level)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants