integration

Documentation

Index

• type Metadata
• type OptionFunc
  • func WithHTTPSink(sinkConfig config.HTTPSink) OptionFunc
  • func WithLogger(logger *log.Logger) OptionFunc
  • func WithMetadata(metadata Metadata) OptionFunc
• type Wrapper
  • func NewWrapper(opts ...OptionFunc) (*Wrapper, error)
  • func (iw *Wrapper) Integration() (*sdk.Integration, error)

Types

type Metadata

type Metadata struct {
	Name    string
	Version string
}

Metadata contains the integration name and version that is passed down to the integration SDK.

type OptionFunc

type OptionFunc func(i *Wrapper) error

OptionFunc is an option func for the Wrapper.

func WithHTTPSink

func WithHTTPSink(sinkConfig config.HTTPSink) OptionFunc

WithHTTPSink configures the wrapper to use an HTTP Sink for metrics. If this option is not specified, Wrapper will configure the integration.Integration to sink metrics to stdout.

func WithLogger

func WithLogger(logger *log.Logger) OptionFunc

func WithMetadata

func WithMetadata(metadata Metadata) OptionFunc

WithMetadata allows to configure the integration name and version that is passed down to the integration SDK.

type Wrapper

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

Wrapper is a wrapper on top of the SDK integration.

func NewWrapper

func NewWrapper(opts ...OptionFunc) (*Wrapper, error)

NewWrapper creates a new SDK integration wrapper using the specified options.

func (*Wrapper) Integration

func (iw *Wrapper) Integration() (*sdk.Integration, error)

Integration returns a sdk.Integration, configured to output data to the specified agent. Integration will block and wait until the specified server is ready, up to a maximum timeout.