elasticsearch

Documentation

Overview

Package elasticsearch contains logic to record data to an elasticsearch index. The data is already sanitised by the data provider.

Index

• type Conf
  • func WithBackoff(backoff int) Conf
  • func WithEndpoint(endpoint string) Conf
  • func WithIndexName(indexName string) Conf
  • func WithLogger(log internal.FieldLogger) Conf
  • func WithName(name string) Conf
  • func WithTimeout(timeout time.Duration) Conf
  • func WithViper(v unmarshaller, name, key string) Conf
• type Config
  • func NewConfig(conf ...Conf) (*Config, error)
  • func (c *Config) Backoff() int
  • func (c *Config) Endpoint() string
  • func (c *Config) IndexName() string
  • func (c *Config) Logger() internal.FieldLogger
  • func (c *Config) Name() string
  • func (c *Config) NewInstance() (recorder.DataRecorder, error)
  • func (c *Config) Timeout() time.Duration
• type Recorder
  • func New(options ...func(recorder.Constructor) error) (*Recorder, error)
  • func (r *Recorder) Backoff() int
  • func (r *Recorder) Endpoint() string
  • func (r *Recorder) IndexName() string
  • func (r *Recorder) Name() string
  • func (r *Recorder) Ping() error
  • func (r *Recorder) Record(ctx context.Context, job *recorder.Job) error
  • func (r *Recorder) SetBackoff(backoff int)
  • func (r *Recorder) SetEndpoint(endpoint string)
  • func (r *Recorder) SetIndexName(indexName string)
  • func (r *Recorder) SetLogger(log internal.FieldLogger)
  • func (r *Recorder) SetName(name string)
  • func (r *Recorder) SetTimeout(timeout time.Duration)
  • func (r *Recorder) Timeout() time.Duration

Types

type Conf

type Conf func(*Config) error

Conf func is used for initializing a Config object.

func WithBackoff

func WithBackoff(backoff int) Conf

WithBackoff doesn't produce any errors.

func WithEndpoint

func WithEndpoint(endpoint string) Conf

WithEndpoint produces an error if endpoint is empty.

func WithIndexName

func WithIndexName(indexName string) Conf

WithIndexName produces an error if indexName is empty.

func WithLogger

func WithLogger(log internal.FieldLogger) Conf

WithLogger produces an error if the log is nil.

func WithName

func WithName(name string) Conf

WithName produces an error if name is empty.

func WithTimeout

func WithTimeout(timeout time.Duration) Conf

WithTimeout doesn't produce any errors.

func WithViper

func WithViper(v unmarshaller, name, key string) Conf

WithViper produces an error any of the inputs are empty.

type Config

type Config struct {
	ESEndpoint  string `mapstructure:"endpoint"`
	ESTimeout   string `mapstructure:"timeout"`
	ESBackoff   int    `mapstructure:"backoff"`
	ESIndexName string `mapstructure:"index_name"`
	// contains filtered or unexported fields
}

Config holds the necessary configuration for setting up an elasticsearch reader endpoint.

func NewConfig

func NewConfig(conf ...Conf) (*Config, error)

NewConfig returns any errors that any of conf function return.

func (*Config) Backoff

func (c *Config) Backoff() int

Backoff return the backoff

func (*Config) Endpoint

func (c *Config) Endpoint() string

Endpoint return the endpoint

func (*Config) IndexName

func (c *Config) IndexName() string

IndexName return the index name

func (*Config) Logger

func (c *Config) Logger() internal.FieldLogger

Logger return the logger

func (*Config) Name

func (c *Config) Name() string

Name return the name

func (*Config) NewInstance

func (c *Config) NewInstance() (recorder.DataRecorder, error)

NewInstance returns an instance of the elasticsearch recorder

func (*Config) Timeout

func (c *Config) Timeout() time.Duration

Timeout return the timeout

type Recorder

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

Recorder contains an elasticsearch client and an index name for recording data It implements DataRecorder interface

func New

func New(options ...func(recorder.Constructor) error) (*Recorder, error)

New returns an error if it can't create the index It returns and error on the following occasions:

Condition            |  Error
---------------------|-------------
Invalid endpoint     | ErrInvalidEndpoint
backoff < 5          | ErrLowBackoffValue
Empty name           | ErrEmptyName
Invalid IndexName    | ErrInvalidIndexName
Empty IndexName      | ErrEmptyIndexName

func (*Recorder) Backoff

func (r *Recorder) Backoff() int

Backoff returns the backoff

func (*Recorder) Endpoint

func (r *Recorder) Endpoint() string

Endpoint returns the endpoint

func (*Recorder) IndexName

func (r *Recorder) IndexName() string

IndexName shows the indexName the recorder should record as

func (*Recorder) Name

func (r *Recorder) Name() string

Name shows the name identifier for this recorder

func (*Recorder) Ping

func (r *Recorder) Ping() error

Ping should ping the endpoint and report if was successful. It returns and error on the following occasions:

Condition            |  Error
---------------------|-------------
Unavailable endpoint | ErrEndpointNotAvailable
Ping errors          | Timeout/Ping failed
Index creation       | elasticsearch's errors

func (*Recorder) Record

func (r *Recorder) Record(ctx context.Context, job *recorder.Job) error

Record returns an error if the endpoint responds in errors. It stops receiving jobs when the endpoint's absence has exceeded the backoff value. It returns an error if the ping is not called or the endpoint is not responding too many times.

func (*Recorder) SetBackoff

func (r *Recorder) SetBackoff(backoff int)

SetBackoff sets the backoff of the recorder

func (*Recorder) SetEndpoint

func (r *Recorder) SetEndpoint(endpoint string)

SetEndpoint sets the endpoint of the recorder

func (*Recorder) SetIndexName

func (r *Recorder) SetIndexName(indexName string)

SetIndexName sets the type name of the recorder

func (*Recorder) SetLogger

func (r *Recorder) SetLogger(log internal.FieldLogger)

SetLogger sets the log of the recorder

func (*Recorder) SetName

func (r *Recorder) SetName(name string)

SetName sets the name of the recorder

func (*Recorder) SetTimeout

func (r *Recorder) SetTimeout(timeout time.Duration)

SetTimeout sets the timeout of the recorder

func (*Recorder) Timeout

func (r *Recorder) Timeout() time.Duration

Timeout returns the time-out