elasticsearch

Documentation

Overview

Package elasticsearch provides a client for the Elasticsearch. Features: - Message's content by default is JSON-formatted. - Provides multiple ways to set the index name: static, or dynamic - which is evaluated at index time.

NOTE: It's the caller's responsibility to create the index, define its mapping, and settings.

Index

• type Config
• type DynamicIndexFunc
• type ElasticSearch
  • func New(indexName string, esConfig Config) *ElasticSearch
  • func NewWithDynamicIndex(dynamicIndexFunc DynamicIndexFunc, esConfig Config) *ElasticSearch
  • func (es *ElasticSearch) Write(data []byte) (int, error)

Types

type Config

type Config = elasticsearch.Config

Config is the ElasticSearch configuration.

type DynamicIndexFunc

type DynamicIndexFunc func() string

DynamicIndexFunc is a function which defines the name of the index, and evaluated at the index time.

type ElasticSearch

type ElasticSearch struct {
	// Client is the ElasticSearch client.
	Client *elasticsearch.Client

	// Config is the ElasticSearch configuration.
	Config Config

	// DynamicIndex is a function which defines the name of the index, and
	// evaluated at the index time.
	DynamicIndex DynamicIndexFunc
}

ElasticSearch `Output` definition.

func New

func New(
	indexName string,
	esConfig Config,
) *ElasticSearch

New returns a new `ElasticSearch` client.

func NewWithDynamicIndex

func NewWithDynamicIndex(
	dynamicIndexFunc DynamicIndexFunc,
	esConfig Config,
) *ElasticSearch

NewWithDynamicIndex returns a new `ElasticSearch` client. It allows to define is a function which defines the name of the index, and evaluated at the index time.

func (*ElasticSearch) Write

func (es *ElasticSearch) Write(data []byte) (int, error)

Write conforms to the `io.Writer` interface.