Interface IDiagnosticDescription
Optional interface for components to describe their own configuration.
Namespace: LaunchDarkly.Sdk.Client.Subsystems
Assembly: LaunchDarkly.ClientSdk.dll
Syntax
public interface IDiagnosticDescriptionRemarks
The SDK uses a simplified JSON representation of its configuration when recording diagnostics data. Any class that implements IComponentConfigurer<T> may choose to contribute values to this representation, although the SDK may or may not use them.
The DescribeConfiguration(LdClientContext) method should return either Nullor 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.
Methods
| Edit this page View SourceDescribeConfiguration(LdClientContext)
Called internally by the SDK to inspect the configuration. Applications do not need to call this method.
Declaration
LdValue DescribeConfiguration(LdClientContext context)Parameters
| Type | Name | Description |
|---|---|---|
| LdClientContext | context | the context object that may provide relevant configuration details |
Returns
| Type | Description |
|---|---|
| LdValue | a JSON value |