public interface DiagnosticDescription
The SDK uses a simplified JSON representation of its configuration when recording diagnostics data.
Any class that implements DataStoreFactory
,
DataSourceFactory
, EventProcessorFactory
,
or PersistentDataStoreFactory
may choose to contribute
values to this representation, although the SDK may or may not use them. For components that do not
implement this interface, the SDK may instead describe them using getClass().getSimpleName()
.
The describeConfiguration(BasicConfiguration)
method should return either null or a JSON value. For
custom components, the value must be a string that describes the basic nature of this component
implementation (e.g. "Redis"). Built-in LaunchDarkly components may instead return a JSON object
containing multiple properties specific to the LaunchDarkly diagnostic schema.
Modifier and Type | Method and Description |
---|---|
LDValue |
describeConfiguration(BasicConfiguration basicConfiguration)
Used internally by the SDK to inspect the configuration.
|
LDValue describeConfiguration(BasicConfiguration basicConfiguration)
basicConfiguration
- general SDK configuration properties that are not specific to this componentLDValue
or null