Package growthbook.sdk.java.plugin.tracking

Class GrowthBookTrackingPlugin

java.lang.Object

growthbook.sdk.java.plugin.tracking.GrowthBookTrackingPlugin

All Implemented Interfaces:

GrowthBookPlugin

public final class GrowthBookTrackingPlugin
extends Object
implements GrowthBookPlugin

Batches experiment/feature evaluation events and POSTs them to the GrowthBook ingest endpoint. Wire contract mirrors the JS and Go SDKs: POST {ingestorHost}/track?client_key={clientKey} with a JSON array of events as the body.

Resources (HTTP client, scheduler, flush executor) are created in init(), not the constructor, so an unregistered plugin never leaks threads. A flush is triggered when either the buffer reaches TrackingPluginConfig.resolvedBatchSize() or a timer fires after TrackingPluginConfig.resolvedBatchTimeout(). close() performs a final synchronous flush.

Delivery is best-effort: the owned flush executor uses a bounded queue and drops the newest batch (with a warning) under sustained backpressure, and failed POSTs are logged but not retried. If the configured clientKey is blank the plugin is disabled: no resources are created, event methods are no-ops, and close() still completes cleanly.

Create one instance per SDK client. A plugin instance owns a single buffer, scheduler, executor, and lifecycle flag, so sharing one instance across multiple GrowthBook/GrowthBookClient instances means the first close()/shutdown() disables tracking for all of them. Evaluations still running while the owning instance is shutting down may lose their telemetry event; stop evaluating before shutdown for complete delivery.

Method Summary

Modifier and Type	Method	Description
void	close()	Invoked when the owning GrowthBook instance is closed.
void	init()	Called once when the plugin is registered with a GrowthBook instance.
static GrowthBookTrackingPlugin	of(TrackingPluginConfig config)
<V> void	onExperimentViewed(Experiment<V> experiment, ExperimentResult<V> result)	Invoked after a user is bucketed into an experiment (once per unique hashAttribute/hashValue/experiment.key/variation combination).
<V> void	onExperimentViewed(Experiment<V> experiment, ExperimentResult<V> result, com.google.gson.JsonObject userAttributes)	Invoked after a user is bucketed into an experiment, with the user's attributes at evaluation time.
<V> void	onFeatureEvaluated(String featureKey, FeatureResult<V> result)	Invoked every time a feature is evaluated.
<V> void	onFeatureEvaluated(String featureKey, FeatureResult<V> result, com.google.gson.JsonObject userAttributes)	Invoked on every feature evaluation, with the user's attributes at evaluation time.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

of

public static GrowthBookTrackingPlugin of(TrackingPluginConfig config)

init

public void init()

Description copied from interface: GrowthBookPlugin

Called once when the plugin is registered with a GrowthBook instance. If this throws, the plugin is treated as failed and receives no further events (see PluginRegistry).

Specified by:

init in interface GrowthBookPlugin

onExperimentViewed

public <V> void onExperimentViewed(Experiment<V> experiment,
 ExperimentResult<V> result)

Description copied from interface: GrowthBookPlugin

Invoked after a user is bucketed into an experiment (once per unique hashAttribute/hashValue/experiment.key/variation combination).

Specified by:

onExperimentViewed in interface GrowthBookPlugin

onExperimentViewed

public <V> void onExperimentViewed(Experiment<V> experiment,
 ExperimentResult<V> result,
 @Nullable
 com.google.gson.JsonObject userAttributes)

Description copied from interface: GrowthBookPlugin

Invoked after a user is bucketed into an experiment, with the user's attributes at evaluation time. The default delegates to GrowthBookPlugin.onExperimentViewed(Experiment, ExperimentResult) so existing plugins keep working; override this overload to receive the attributes.

Specified by:

onExperimentViewed in interface GrowthBookPlugin

userAttributes - the evaluated user's attributes, or null when unavailable

onFeatureEvaluated

public <V> void onFeatureEvaluated(String featureKey,
 FeatureResult<V> result)

Description copied from interface: GrowthBookPlugin

Invoked every time a feature is evaluated.

Specified by:

onFeatureEvaluated in interface GrowthBookPlugin

onFeatureEvaluated

public <V> void onFeatureEvaluated(String featureKey,
 FeatureResult<V> result,
 @Nullable
 com.google.gson.JsonObject userAttributes)

Description copied from interface: GrowthBookPlugin

Invoked on every feature evaluation, with the user's attributes at evaluation time. The default delegates to GrowthBookPlugin.onFeatureEvaluated(String, FeatureResult) so existing plugins keep working; override this overload to receive the attributes.

Specified by:

onFeatureEvaluated in interface GrowthBookPlugin

userAttributes - the evaluated user's attributes, or null when unavailable

close

public void close()

Description copied from interface: GrowthBookPlugin

Invoked when the owning GrowthBook instance is closed. Implementations should flush any buffered work synchronously. MUST be safe to call multiple times and even if GrowthBookPlugin.init() failed.

Specified by:

close in interface GrowthBookPlugin