splunk

Documentation

Index

• type Exporter
  • func New(option *Options) (*Exporter, error)
  • func (exporter *Exporter) Close() error
  • func (exporter *Exporter) Export(event *output.ResultEvent) error
• type Options

Types

type Exporter

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

Exporter type for splunk

func New

func New(option *Options) (*Exporter, error)

New creates and returns a new exporter for splunk

func (*Exporter) Close

func (exporter *Exporter) Close() error

Close closes the exporter after operation

func (*Exporter) Export

func (exporter *Exporter) Export(event *output.ResultEvent) error

Export exports a passed result event to Splunk

type Options

type Options struct {
	// Host is the hostname and port of the splunk instance
	Host string `yaml:"host" validate:"required"`
	Port int    `yaml:"port" validate:"gte=0,lte=65535"`
	// SSL (optional) enables ssl for splunk connection
	SSL bool `yaml:"ssl"`
	// SSLVerification (optional) disables SSL verification for splunk
	SSLVerification bool `yaml:"ssl-verification"`
	// Token for HEC instance
	Token     string `yaml:"token"  validate:"required"`
	IndexName string `yaml:"index-name"  validate:"required"`

	HttpClient *retryablehttp.Client `yaml:"-"`
}

Options contains necessary options required for splunk communication