elasticsearch

package
v0.0.0-...-691b052 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 7, 2018 License: Apache-2.0, Apache-2.0 Imports: 9 Imported by: 0

README

ELASTICSEARCH

Synopsys

SETTING TYPE REQUIRED DEFAULT VALUE
document_type string false "%{type}"
flush_count int false 1000
flush_size int false 5242880
host string false "localhost"
idle_flush_time int false 1
index string false "logstash-%Y.%m.%d"
password string false ""
path string false "/"
port int false 9200
user string false ""
ssl bool false false
version int false 6

Details

document_type
  • Value type is string
  • Default value is "%{type}"

The document type to write events to. There is no default value for this setting.

Generally you should try to write only similar events to the same type. String expansion %{foo} works here. Unless you set document_type, the event type will be used if it exists otherwise the document type will be assigned the value of logs

flush_count
  • Value type is int
  • Default value is 1000

The number of requests that can be enqueued before flushing them. Default value is 1000

flush_size
  • Value type is int
  • Default value is 5242880

The number of bytes that the bulk requests can take up before the bulk processor decides to flush. Default value is 5242880 (5MB).

host
  • Value type is string
  • Default value is "localhost"

Host of the remote instance. Default value is "localhost"

idle_flush_time
  • Value type is int
  • Default value is 1

The amount of seconds since last flush before a flush is forced. Default value is 1

This setting helps ensure slow event rates don’t get stuck. For example, if your flush_size is 100, and you have received 10 events, and it has been more than idle_flush_time seconds since the last flush, those 10 events will be flushed automatically. This helps keep both fast and slow log streams moving along in near-real-time.

index
  • Value type is string
  • Default value is "logstash-%Y.%m.%d"

The index to write events to. Default value is "logstash-%Y.%m.%d"

This can be dynamic using the %{foo} syntax and strftime syntax (see http://strftime.org/). The default value will partition your indices by day.

password
  • Value type is string
  • Default value is ""

Password to authenticate to a secure Elasticsearch cluster. There is no default value for this setting.

path
  • Value type is string
  • Default value is "/"

HTTP Path at which the Elasticsearch server lives. Default value is "/"

Use this if you must run Elasticsearch behind a proxy that remaps the root path for the Elasticsearch HTTP API lives.

port
  • Value type is int
  • Default value is 9200

ElasticSearch port to connect on. Default value is 9200

user
  • Value type is string
  • Default value is ""

Username to authenticate to a secure Elasticsearch cluster. There is no default value for this setting.

ssl
  • Value type is bool
  • Default value is false

Enable SSL/TLS secured communication to Elasticsearch cluster. Default value is false

version
  • Value type is int
  • Default value is 6

ElasticSearch server version (6 or 5)

Configuration blueprint

elasticsearch{
	document_type => "%{type}"
	flush_count => 1000
	flush_size => 5242880
	host => "localhost"
	idle_flush_time => 1
	index => "logstash-%Y.%m.%d"
	password => ""
	path => "/"
	port => 9200
	user => ""
	ssl => false
	version => 6
}

Documentation

Overview

Code generated by "bitfanDoc "; DO NOT EDIT

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func New

func New() processors.Processor

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL