testconnection

Documentation

Index

• func ConvertDestinationToConfigurer(destination model.DestinationInput) (config.ExporterConfigurer, error)
• func NewOTLPHTTPTester() *otlphttpExporterConnectionTester
• func NewOTLPTester() *otlpExporterConnectionTester
• type DestinationConfigurer
  • func (dc *DestinationConfigurer) GetConfig() map[string]string
  • func (dc *DestinationConfigurer) GetID() string
  • func (dc *DestinationConfigurer) GetSignals() []common.ObservabilitySignal
  • func (dc *DestinationConfigurer) GetType() common.DestinationType
• type ExporterConnectionTester
• type TestConnectionErrorReason
• type TestConnectionResult
  • func TestConnection(ctx context.Context, dest config.ExporterConfigurer) TestConnectionResult

Functions

func ConvertDestinationToConfigurer

func ConvertDestinationToConfigurer(destination model.DestinationInput) (config.ExporterConfigurer, error)

func NewOTLPHTTPTester

func NewOTLPHTTPTester() *otlphttpExporterConnectionTester

func NewOTLPTester

func NewOTLPTester() *otlpExporterConnectionTester

Types

type DestinationConfigurer

type DestinationConfigurer struct {
	// contains filtered or unexported fields
}

Implement the ExporterConfigurer interface

func (*DestinationConfigurer) GetConfig

func (dc *DestinationConfigurer) GetConfig() map[string]string

func (*DestinationConfigurer) GetID

func (dc *DestinationConfigurer) GetID() string

func (*DestinationConfigurer) GetSignals

func (dc *DestinationConfigurer) GetSignals() []common.ObservabilitySignal

func (*DestinationConfigurer) GetType

func (dc *DestinationConfigurer) GetType() common.DestinationType

type ExporterConnectionTester

type ExporterConnectionTester interface {
	// Factory returns the exporter factory for the exporter type.
	// This is used to create the exporter instance for testing the connection.
	Factory() exporter.Factory
	// ModifyConfigForConnectionTest modifies the exporter configuration for testing the connection.
	// Since the default configuration may have batching, retries, etc. which may not be suitable for testing the connection.
	ModifyConfigForConnectionTest(component.Config) component.Config
}

type TestConnectionErrorReason

type TestConnectionErrorReason string

const (
	UnKnownDestination      TestConnectionErrorReason = "unknown destination"
	InvalidConfig           TestConnectionErrorReason = "invalid config"
	UnsupportedExporterType TestConnectionErrorReason = "unsupported exporter type"
	FailedToConnect         TestConnectionErrorReason = "failed to connect"
)

type TestConnectionResult

type TestConnectionResult struct {
	Succeeded       bool
	Message         string
	Reason          TestConnectionErrorReason
	StatusCode      int
	DestinationType common.DestinationType
}

func TestConnection

func TestConnection(ctx context.Context, dest config.ExporterConfigurer) TestConnectionResult