es

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 elasticsearch

func New

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

New creates and returns a new exporter for elasticsearch

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 elasticsearch

type Options

type Options struct {
	// Host is the hostname of the elasticsearch instance
	Host string `yaml:"host" validate:"required_without=IP"`
	// IP for elasticsearch instance
	IP string `yaml:"ip" validate:"required,ip"`
	// Port is the port of elasticsearch instance
	Port int `yaml:"port" validate:"gte=0,lte=65535"`
	// SSL (optional) enables ssl for elasticsearch connection
	SSL bool `yaml:"ssl"`
	// SSLVerification (optional) disables SSL verification for elasticsearch
	SSLVerification bool `yaml:"ssl-verification"`
	// Username for the elasticsearch instance
	Username string `yaml:"username"  validate:"required"`
	// Password is the password for elasticsearch instance
	Password string `yaml:"password"  validate:"required"`
	// IndexName is the name of the elasticsearch index
	IndexName string `yaml:"index-name"  validate:"required"`

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

Options contains necessary options required for elasticsearch communication