Skip to content

Add missing StatsigOptions documentation for Java Core SDK #3699

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.

Sign up for GitHub

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

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Add missing StatsigOptions documentation for Java Core SDK #3699

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e2b3c2e
Update snippets/server-core/java/statsigOptions.mdx
mintlify[bot] Oct 30, 2025
c6ec6ab
Update snippets/server-core/java/statsigOptions.mdx
mintlify[bot] Oct 30, 2025
7093d8d
Update snippets/server-core/java/statsigOptions.mdx
mintlify[bot] Oct 30, 2025
9bdbf90
Update snippets/server-core/java/statsigOptions.mdx
mintlify[bot] Oct 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 48 additions & 2 deletions snippets/server-core/java/statsigOptions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,38 @@ If true, the SDK will not collect any logging within the session, including cust
Required to be `true` when using segments with more than 1000 IDs.
</ResponseField>

<ResponseField name="disableUserAgentParsing" type="boolean" default="false">
If true, the SDK will not parse User-Agent strings into `browserName`, `browserVersion`, `systemName`, `systemVersion`, and `appVersion` when needed for evaluation.
<ResponseField name="idListsUrl" type="string">
Custom URL for fetching ID lists.
</ResponseField>

<ResponseField name="idListsSyncIntervalMs" type="long">
How often the SDK updates ID lists from Statsig servers (in milliseconds).
</ResponseField>

<ResponseField name="initTimeoutMs" type="long" default="3000">
The amount of time to wait for an `initialize()` response from the server (in milliseconds). The SDK will still fetch gates/configs in the background if this time is exceeded.
</ResponseField>

<ResponseField name="waitForUserAgentInit" type="boolean" default="false">
If true, the SDK will wait for User-Agent parsing initialization to complete before returning from `initialize()`.
</ResponseField>

<ResponseField name="waitForCountryLookupInit" type="boolean" default="false">
If true, the SDK will wait for country lookup initialization to complete before returning from `initialize()`.
</ResponseField>

<ResponseField name="disableUserCountryLookup" type="boolean" default="false">
If true, the SDK will not parse IP addresses (from `user.ip`) into country codes when needed for evaluation.
</ResponseField>

<ResponseField name="useThirdPartyUAParser" type="boolean" default="false">
If true, the SDK will use a third-party User-Agent parser instead of the built-in parser.
</ResponseField>

<ResponseField name="disableNetwork" type="boolean" default="false">
If true, the SDK will not make any network requests. Useful for testing or when using a custom data store.
Copy link
Contributor

@weihao-statsig weihao-statsig Oct 30, 2025

Choose a reason for hiding this comment

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

just for testing maybe

</ResponseField>

<ResponseField name="eventLoggingFlushIntervalMs" type="long">
How often events are flushed to Statsig servers (in milliseconds).
</ResponseField>
Expand All @@ -44,6 +68,14 @@ How often events are flushed to Statsig servers (in milliseconds).
Maximum number of events to queue before forcing a flush.
</ResponseField>

<ResponseField name="eventLoggingMaxPendingBatchQueueSize" type="long">
Maximum number of pending batches to queue before dropping events.
</ResponseField>

<ResponseField name="serviceName" type="string">
Name of the service using the SDK. Used for observability and debugging.
Copy link
Contributor

@weihao-statsig weihao-statsig Oct 30, 2025

Choose a reason for hiding this comment

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

remove this option

</ResponseField>

<ResponseField name="dataStore" type="DataStore">
An adapter with custom storage behavior for config specs. Can also continuously fetch updates in place of the Statsig network.
</ResponseField>
Expand All @@ -56,6 +88,14 @@ Interface to use persistent storage within the SDK.
Set the logging level for the SDK. Options: `NONE`, `ERROR`, `WARN`, `INFO`, `DEBUG`.
</ResponseField>

<ResponseField name="outputLoggerProvider" type="OutputLoggerProvider">
Custom logger provider for SDK logging output.
</ResponseField>

<ResponseField name="proxyConfig" type="ProxyConfig">
Configuration for using a proxy server for network requests.
</ResponseField>

<ResponseField name="observabilityClient" type="ObservabilityClient">
Interface to integrate observability metrics exposed by the SDK.
</ResponseField>
Expand All @@ -69,6 +109,9 @@ StatsigOptions options = new StatsigOptions.Builder()
.setEnvironment("staging")
.setSpecsSyncIntervalMs(10000)
.setEventLoggingFlushIntervalMs(5000)
.setInitTimeoutMs(5000)
.setServiceName("my-service")
.setEnableIDLists(true)
.setOutputLoggerLevel(OutputLogger.LogLevel.INFO)
.build();

Expand All @@ -82,6 +125,9 @@ val options = StatsigOptions.Builder()
.setEnvironment("staging")
.setSpecsSyncIntervalMs(10000)
.setEventLoggingFlushIntervalMs(5000)
.setInitTimeoutMs(5000)
.setServiceName("my-service")
.setEnableIDLists(true)
.setOutputLoggerLevel(OutputLogger.LogLevel.INFO)
.build()

Expand Down