...

Source file src/github.com/launchdarkly/go-server-sdk/v6/subsystems/diagnostic_description.go

Documentation: github.com/launchdarkly/go-server-sdk/v6/subsystems

     1  package subsystems
     2  
     3  import "github.com/launchdarkly/go-sdk-common/v3/ldvalue"
     4  
     5  // DiagnosticDescription is an optional interface for components to describe their own configuration.
     6  //
     7  // The SDK uses a simplified JSON representation of its configuration when recording diagnostics data.
     8  // Any component type that implements ComponentConfigurer may choose to contribute values to this
     9  // representation, although the SDK may or may not use them.
    10  type DiagnosticDescription interface {
    11  	// DescribeConfiguration should return a JSON value or ldvalue.Null().
    12  	//
    13  	// For custom components, this must be a string value that describes the basic nature of this component
    14  	// implementation (e.g. "Redis"). Built-in LaunchDarkly components may instead return a JSON object
    15  	// containing multiple properties specific to the LaunchDarkly diagnostic schema.
    16  	DescribeConfiguration(context ClientContext) ldvalue.Value
    17  }
    18  

View as plain text