fluent-plugin-elasticsearch 1.18.2 → 2.0.0.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: ef82d990d532395ac70cfaca633811ecfec6e9277f02544a2fc73402aea79bd9
-  data.tar.gz: 30beccac0549c496631ba4943c2aae0161db08bb55966f38c1554b8c493beb12
+SHA1:
+  metadata.gz: 4c847d28fe74087b06966351eb6fd5f9e88695e2
+  data.tar.gz: 989fcbfff8006eb3275522d2ed7c7e2cd92ef5e2
 SHA512:
-  metadata.gz: a7aaed653bb448e943265718258e9f92e2cb17fb778684483e58bac51c7a4175821aec96da2b6956ccf0f1b2e5c81775672f0c9ad34120e86b6e1e5f7b71aff2
-  data.tar.gz: 37a07ba5b227ce441396984abbedbafd6005d709df2b1489b39fcd5cdbb4e4aee820104b0cf99c944990133a227daa2ccde2b0a0d5f27a07929aa112e980d069
+  metadata.gz: 0a2e7f76258f14ca000658b453958ef118f33456fd3bff1fd15391a4710052e48672f8fdb67c271d28156aebd2e93b01f0388466c569d224f5e8f65d8e4c98e8
+  data.tar.gz: fe7283edc63facf368b6344f4686ce3d0e8957297d09b0d6c22cc701156586ac3254dfed45dbea5007dd0a6792f0b84059e0a7e37705ff948fe171b838bb3365

data/.gitignore

@@ -16,4 +16,3 @@ test/tmp
 test/version_tmp
 tmp
 .DS_Store
-vendor/

data/.travis.yml

@@ -7,7 +7,6 @@ rvm:
 
 gemfile:
  - Gemfile
- - Gemfile.v0.12
 
 script: bundle exec rake test
 sudo: false

data/History.md

@@ -1,99 +1,11 @@
 ## Changelog [[tags]](https://github.com/uken/fluent-plugin-elasticsearch/tags)
 
 ### [Unreleased]
+- Log ES response errors (#230)
+- Use latest elasticsearch-ruby (#240)
 
-### 1.18.2
-- Retry upsert on recoverable error. (porting to v0.12) #667 (#684)
-
-### 1.18.1
-- add new option to suppress doc wrapping (porting to v0.12) (#558)
-
-### 1.18.0
-- Avoid NoMethodError on unknown Elasticsearch error responses (#487)
-
-### 1.17.2
-- add simple sniffer for simple proxy/lb cases (#459)
-
-### 1.17.1
-- backport strictness-scheme (#447)
-
-### 1.17.0
-- Fix #434 bulk count (#437)
-
-### 1.16.2
-- add trace logging to send_bulk (#435)
-
-### 1.16.1
-- allow configure of retry_tag so messages can be routed through a different pipeline (#419)
-- fix #417. emit_error_event using an exception (#418)
-
-### 1.16.0
-- evaluate bulk request failures and reroute failed messages (#405)
-
-### 1.15.2
-- handle case where stats not processed in order; add testing (#410)
-
-### 1.15.1
-- successful operation if all duplicates (#406)
-
-### 1.15.0
-- revert dlq to use router.emit_error_event instead (#402)
-- Don't log full response on error (#399)
-
-### 1.14.0
-- introduce dead letter queue to handle issues unpacking file buffer chunks (#398)
-
-### 1.13.4
-- backport auth: Fix missing auth tokens after reloading connections (#397)
-
-### 1.13.3
-- backport removing outdated generating hash id support module (#374)
-
-### 1.13.2
-- backport preventing error when using template in elasticsearch_dynamic for elementally use case (#364)
-
-### 1.13.1
-- backport adding config parameter to enable elasticsearch-ruby's transporter logging (#343)
-
-### 1.13.0
-- Backport allowing to overwrite existing index template (#336)
-
-### 1.12.0
-- GA release 1.12.0.
-
-### 1.12.0.rc.1
-- Backport separating generate hash id module and bundled new plugin for generating unique hash id (#331)
-
-### 1.11.1
-- Raise ConfigError when specifying different @hash_config.hash_id_key and id_key configration (#326)
-- backport small typo fix in README.md (#328)
-
-### 1.11.0
-- backport adding bulk errors handling (#324)
-
-### 1.10.3
-- releasing generating hash id mechanism to avoid records duplication backport (#323)
-
-### 1.10.3.rc.1
-- backport Add generating hash id mechanism to avoid records duplication (#323)
-
-### 1.10.2
-- backport adding `include_timestamp` option (#311)
-
-### 1.10.1
-- backport escaping basic authentication user information placeholders (#309)
-- backport handling dynamic config misconfiguration (#308)
-
-### 1.10.0
-- backport adding `logstash_prefix_separator` parameter fix
-- backport making configuraable SSL/TLS version (#300)
-- bump up minimum required Fluentd version to v0.12.10 due to use enum parameter type
-
-### 1.9.7
-- fix license identifier in gemspec (#295)
-
-### 1.9.6
-- add pipeline parameter (#266)
+### 2.0.0.rc.1
+- Use v0.14 API to support nanosecond precision (#223)
 
 ### 1.9.5
 - sub-second time precision [(#249)](https://github.com/uken/fluent-plugin-elasticsearch/pull/249)
@@ -101,10 +13,6 @@
 ### 1.9.4
 - Include 'Content-Type' header in `transport_options`
 
-### 1.9.3
-- Use latest elasticsearch-ruby (#240)
-- Log ES response errors (#230)
-
 ### 1.9.2
 - Fix elasticsearch_dynamic for v0.14 (#224)
 

data/README.md

@@ -7,33 +7,30 @@
 [![Issue Stats](http://issuestats.com/github/uken/fluent-plugin-elasticsearch/badge/pr)](http://issuestats.com/github/uken/fluent-plugin-elasticsearch)
 [![Issue Stats](http://issuestats.com/github/uken/fluent-plugin-elasticsearch/badge/issue)](http://issuestats.com/github/uken/fluent-plugin-elasticsearch)
 
-Send your logs to Elasticsearch (and search them with Kibana maybe?)
+Send your logs to ElasticSearch (and search them with Kibana maybe?)
 
 Note: For Amazon Elasticsearch Service please consider using [fluent-plugin-aws-elasticsearch-service](https://github.com/atomita/fluent-plugin-aws-elasticsearch-service)
 
+Current maintainers: @cosmo0920
+
 * [Installation](#installation)
 * [Usage](#usage)
   + [Index templates](#index-templates)
 * [Configuration](#configuration)
-  + [emit_error_for_missing_id](#emit_error_for_missing_id)
   + [hosts](#hosts)
   + [user, password, path, scheme, ssl_verify](#user-password-path-scheme-ssl_verify)
   + [logstash_format](#logstash_format)
   + [logstash_prefix](#logstash_prefix)
-  + [logstash_prefix_separator](#logstash_prefix_separator)
   + [logstash_dateformat](#logstash_dateformat)
-  + [pipeline](#pipeline)
   + [time_key_format](#time_key_format)
   + [time_precision](#time_precision)
   + [time_key](#time_key)
   + [time_key_exclude_timestamp](#time_key_exclude_timestamp)
-  + [include_timestamp](#time_key_exclude_timestamp)
   + [utc_index](#utc_index)
   + [target_index_key](#target_index_key)
   + [target_type_key](#target_type_key)
   + [template_name](#template_name)
   + [template_file](#template_file)
-  + [template_overwrite](#template_overwrite)
   + [templates](#templates)
   + [request_timeout](#request_timeout)
   + [reload_connections](#reload_connections)
@@ -46,21 +43,15 @@ Note: For Amazon Elasticsearch Service please consider using [fluent-plugin-aws-
   + [remove_keys](#remove_keys)
   + [remove_keys_on_update](#remove_keys_on_update)
   + [remove_keys_on_update_key](#remove_keys_on_update_key)
-  + [retry_tag](#retry_tag)
   + [write_operation](#write_operation)
   + [time_parse_error_tag](#time_parse_error_tag)
   + [reconnect_on_error](#reconnect_on_error)
-  + [with_transporter_log](#with_transporter_log)
   + [Client/host certificate options](#clienthost-certificate-options)
   + [Proxy Support](#proxy-support)
   + [Buffered output options](#buffered-output-options)
   + [Hash flattening](#hash-flattening)
-  + [Generate Hash ID](#generate-hash-id)
-  + [sniffer_class_name](#sniffer_class_name)
-  + [reload_after](#reload_after)
   + [Not seeing a config you need?](#not-seeing-a-config-you-need)
   + [Dynamic configuration](#dynamic-configuration)
-  + [suppress_doc_wrap](#suppress_doc_wrap)
 * [Contact](#contact)
 * [Contributing](#contributing)
 * [Running tests](#running-tests)
@@ -87,30 +78,21 @@ In your Fluentd configuration, use `@type elasticsearch`. Additional configurati
 
 ### Index templates
 
-This plugin creates Elasticsearch indices by merely writing to them. Consider using [Index Templates](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html) to gain control of what get indexed and how. See [this example](https://github.com/uken/fluent-plugin-elasticsearch/issues/33#issuecomment-38693282) for a good starting point.
+This plugin creates ElasticSearch indices by merely writing to them. Consider using [Index Templates](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html) to gain control of what get indexed and how. See [this example](https://github.com/uken/fluent-plugin-elasticsearch/issues/33#issuecomment-38693282) for a good starting point.
 
 ## Configuration
 
-### emit_error_for_missing_id
-
-```
-emit_error_for_missing_id true
-```
-When  `write_operation` is configured to anything other then `index`, setting this value to `true` will
-cause the plugin to `emit_error_event` of any records which do not include an `_id` field.  The default (`false`)
-behavior is to silently drop the records.
-
 ### hosts
 
 ```
 hosts host1:port1,host2:port2,host3:port3
+# or
+hosts https://customhost.com:443/path,https://username:password@host-failover.com:443
 ```
 
-You can specify multiple Elasticsearch hosts with separator ",".
-
-If you specify multiple hosts, this plugin will load balance updates to Elasticsearch. This is an [elasticsearch-ruby](https://github.com/elasticsearch/elasticsearch-ruby) feature, the default strategy is round-robin.
+You can specify multiple ElasticSearch hosts with separator ",".
 
-**Note:** Up until v1.13.3, it was allowed to embed the username/password in the URL. However, this syntax is deprecated as of v1.13.4 because it was found to cause serious connection problems (See #394). Please migrate your settings to use the `user` and `password` field (described below) instead.
+If you specify multiple hosts, this plugin will load balance updates to ElasticSearch. This is an [elasticsearch-ruby](https://github.com/elasticsearch/elasticsearch-ruby) feature, the default strategy is round-robin.
 
 ### user, password, path, scheme, ssl_verify
 
@@ -123,14 +105,7 @@ path /elastic_search/
 scheme https
 ```
 
-You can specify user and password for HTTP Basic authentication.
-
-And this plugin will escape required URL encoded characters within `%{}` placeholders.
-
-```
-user %{demo+}
-password %{@secret}
-```
+You can specify user and password for HTTP basic auth. If used in conjunction with a hosts list, then these options will be used by default i.e. if you do not provide any of these options within the hosts listed.
 
 Specify `ssl_verify false` to skip ssl verification (defaults to true)
 
@@ -140,15 +115,7 @@ Specify `ssl_verify false` to skip ssl verification (defaults to true)
 logstash_format true # defaults to false
 ```
 
-This is meant to make writing data into Elasticsearch indices compatible to what [Logstash](https://www.elastic.co/products/logstash) calls them. By doing this, one could take advantage of [Kibana](https://www.elastic.co/products/kibana). See logstash_prefix and logstash_dateformat to customize this index name pattern. The index name will be `#{logstash_prefix}-#{formated_date}`
-
-### include_timestamp
-
-```
-include_timestamp true # defaults to false
-```
-
-Adds a `@timestamp` field to the log, following all settings `logstash_format` does, except without the restrictions on `index_name`. This allows one to log to an alias in Elasticsearch and utilize the rollover API.
+This is meant to make writing data into ElasticSearch indices compatible to what [Logstash](https://www.elastic.co/products/logstash) calls them. By doing this, one could take advantage of [Kibana](https://www.elastic.co/products/kibana). See logstash_prefix and logstash_dateformat to customize this index name pattern. The index name will be `#{logstash_prefix}-#{formated_date}`
 
 ### logstash_prefix
 
@@ -156,12 +123,6 @@ Adds a `@timestamp` field to the log, following all settings `logstash_format` d
 logstash_prefix mylogs # defaults to "logstash"
 ```
 
-### logstash_prefix_separator
-
-```
-logstash_prefix_separator _ # defaults to "-"
-```
-
 ### logstash_dateformat
 
 The strftime format to generate index target index name when `logstash_format` is set to true. By default, the records are inserted into index `logstash-YYYY.MM.DD`. This option, alongwith `logstash_prefix` lets us insert into specified index like `mylogs-YYYYMM` for a monthly index.
@@ -170,16 +131,6 @@ The strftime format to generate index target index name when `logstash_format` i
 logstash_dateformat %Y.%m. # defaults to "%Y.%m.%d"
 ```
 
-### pipeline
-
-Only in ES >= 5.x is available to use this parameter.
-This param is to set a pipeline id of your elasticsearch to be added into the request, you can configure ingest node.
-For more information: [![Ingest node](https://www.elastic.co/guide/en/elasticsearch/reference/master/ingest.html)]
-
-```
-pipeline pipeline_id
-```
-
 ### time_key_format
 
 The format of the time stamp field (`@timestamp` or what you specify with [time_key](#time_key)). This parameter only has an effect when [logstash_format](#logstash_format) is true as it only affects the name of the index we write to. Please see [Time#strftime](http://ruby-doc.org/core-1.9.3/Time.html#method-i-strftime) for information about the value of this format.
@@ -289,7 +240,7 @@ Similar to `target_index_key` config, find the type name to write to in the reco
 
 ### template_name
 
-The name of the template to define. If a template by the name given is already present, it will be left unchanged, unless [template_overwrite](#template_overwrite) is set, in which case the template will be updated.
+The name of the template to define. If a template by the name given is already present, it will be left unchanged.
 
 This parameter along with template_file allow the plugin to behave similarly to Logstash (it installs a template at creation time) so that raw records are available. See [https://github.com/uken/fluent-plugin-elasticsearch/issues/33](https://github.com/uken/fluent-plugin-elasticsearch/issues/33).
 
@@ -311,21 +262,11 @@ templates { "templane_name_1": "path_to_template_1_file", "templane_name_2": "pa
 
 If `template_file` and `template_name` are set, then this parameter will be ignored.
 
-### template_overwrite
-
-Always update the template, even if it already exists.
-
-```
-template_overwrite true # defaults to false
-```
-
-One of [template_file](#template_file) or [templates](#templates) must also be specified if this is set.
-
 ### request_timeout
 
 You can specify HTTP request timeout.
 
-This is useful when Elasticsearch cannot return response for bulk request within the default of 5 seconds.
+This is useful when ElasticSearch cannot return response for bulk request within the default of 5 seconds.
 
 ```
 request_timeout 15s # defaults to 5s
@@ -333,7 +274,7 @@ request_timeout 15s # defaults to 5s
 
 ### reload_connections
 
-You can tune how the elasticsearch-transport host reloading feature works. By default it will reload the host list from the server every 10,000th request to spread the load. This can be an issue if your Elasticsearch cluster is behind a Reverse Proxy, as Fluentd process may not have direct network access to the Elasticsearch nodes.
+You can tune how the elasticsearch-transport host reloading feature works. By default it will reload the host list from the server every 10,000th request to spread the load. This can be an issue if your ElasticSearch cluster is behind a Reverse Proxy, as Fluentd process may not have direct network access to the ElasticSearch nodes.
 
 ```
 reload_connections false # defaults to true
@@ -353,7 +294,7 @@ reload_on_failure true # defaults to false
 You can set in the elasticsearch-transport how often dead connections from the elasticsearch-transport's pool will be resurrected.
 
 ```
-resurrect_after 5s # defaults to 60s
+resurrect_after 5 # defaults to 60s
 ```
 
 ### include_tag_key, tag_key
@@ -373,7 +314,7 @@ This will add the Fluentd tag in the JSON record. For instance, if you have a co
 </match>
 ```
 
-The record inserted into Elasticsearch would be
+The record inserted into ElasticSearch would be
 
 ```
 {"_key":"my.logs", "name":"Johnny Doeie"}
@@ -385,9 +326,9 @@ The record inserted into Elasticsearch would be
 id_key request_id # use "request_id" field as a record id in ES
 ```
 
-By default, all records inserted into Elasticsearch get a random _id. This option allows to use a field in the record as an identifier.
+By default, all records inserted into ElasticSearch get a random _id. This option allows to use a field in the record as an identifier.
 
-This following record `{"name":"Johnny","request_id":"87d89af7daffad6"}` will trigger the following Elasticsearch command
+This following record `{"name":"Johnny","request_id":"87d89af7daffad6"}` will trigger the following ElasticSearch command
 
 ```
 { "index" : { "_index" : "logstash-2013.01.01, "_type" : "fluentd", "_id" : "87d89af7daffad6" } }
@@ -405,7 +346,7 @@ If your input is
 { "name": "Johnny", "a_parent": "my_parent" }
 ```
 
-Elasticsearch command would be
+ElasticSearch command would be
 
 ```
 { "index" : { "_index" : "****", "_type" : "****", "_id" : "****", "_parent" : "my_parent" } }
@@ -449,21 +390,6 @@ present in the record then the keys in record are used, if the `remove_keys_on_u
 remove_keys_on_update_key keys_to_skip
 ```
 
-### retry_tag
-
-This setting allows custom routing of messages in response to bulk request failures.  The default behavior is to emit
-failed records using the same tag that was provided.  When set to a value other then `nil`, failed messages are emitted
-with the specified tag:
-
-```
-retry_tag 'retry_es'
-```
-**NOTE:** `retry_tag` is optional. If you would rather use labels to reroute retries, add a label (e.g '@label @SOMELABEL') to your fluent
-elasticsearch plugin configuration. Retry records are, by default, submitted for retry to the ROOT label, which means
-records will flow through your fluentd pipeline from the beginning.  This may nor may not be a problem if the pipeline
-is idempotent - that is - you can process a record again with no changes.  Use tagging or labeling to ensure your retry
-records are not processed again by your fluentd processing pipeline.
-
 ### write_operation
 
 The write_operation can be any of:
@@ -492,36 +418,20 @@ We recommended to set this true in the presence of elasticsearch shield.
 reconnect_on_error true # defaults to false
 ```
 
-### with_transporter_log
-
-This is debugging purpose option to enable to obtain transporter layer log.
-Default value is `false` for backward compatibility.
-
-We recommend to set this true if you start to debug this plugin.
-
-```
-with_transporter_log true
-```
-
 ### Client/host certificate options
 
-Need to verify Elasticsearch's certificate?  You can use the following parameter to specify a CA instead of using an environment variable.
+Need to verify ElasticSearch's certificate?  You can use the following parameter to specify a CA instead of using an environment variable.
 ```
 ca_file /path/to/your/ca/cert
 ```
 
-Does your Elasticsearch cluster want to verify client connections?  You can specify the following parameters to use your client certificate, key, and key password for your connection.
+Does your ElasticSearch cluster want to verify client connections?  You can specify the following parameters to use your client certificate, key, and key password for your connection.
 ```
 client_cert /path/to/your/client/cert
 client_key /path/to/your/private/key
 client_key_pass password
 ```
 
-If you want to configure SSL/TLS version, you can specify ssl\_version parameter.
-```
-ssl_version TLSv1_2 # or [SSLv23, TLSv1, TLSv1_1]
-```
-
 ### Proxy Support
 
 Starting with version 0.8.0, this gem uses excon, which supports proxy with environment variables - https://github.com/excon/excon#proxy-support
@@ -532,7 +442,7 @@ Starting with version 0.8.0, this gem uses excon, which supports proxy with envi
 
 ```
 buffer_type memory
-flush_interval 60s
+flush_interval 60
 retry_limit 17
 retry_wait 1.0
 num_threads 1
@@ -559,54 +469,11 @@ This will produce elasticsearch output that looks like this:
 
 Note that the flattener does not deal with arrays at this time.
 
-### Generate Hash ID
-
-By default, the fluentd elasticsearch plugin does not emit records with a _id field, leaving it to Elasticsearch to generate a unique _id as the record is indexed. When an Elasticsearch cluster is congested and begins to take longer to respond than the configured request_timeout, the fluentd elasticsearch plugin will re-send the same bulk request. Since Elasticsearch can't tell its actually the same request, all documents in the request are indexed again resulting in duplicate data. In certain scenarios, this can result in essentially and infinite loop generating multiple copies of the same data.
-
-The bundled elasticsearch_genid filter can generate a unique _hash key for each record, this key may be passed to the id_key parameter in the elasticsearch plugin to communicate to Elasticsearch the uniqueness of the requests so that duplicates will be rejected or simply replace the existing records.
-Here is a sample config:
-
-```
-<filter **>
-  @type elasticsearch_genid
-  hash_id_key _hash    # storing generated hash id key (default is _hash)
-</filter>
-<match **>
-  @type elasticsearch
-  id_key _hash # specify same key name which is specified in hash_id_key
-  remove_keys _hash # Elasticsearch doesn't like keys that start with _
-  # other settings are ommitted.
-</match>
-```
-
-### Sniffer Class Name
-
-The default Sniffer used by the `Elasticsearch::Transport` class works well when Fluentd has a direct connection
-to all of the Elasticsearch servers and can make effective use of the `_nodes` API.  This doesn't work well
-when Fluentd must connect through a load balancer or proxy.  The parameter `sniffer_class_name` gives you the
-ability to provide your own Sniffer class to implement whatever connection reload logic you require.  In addition,
-there is a new `Fluent::ElasticsearchSimpleSniffer` class which reuses the hosts given in the configuration, which
-is typically the hostname of the load balancer or proxy.  For example, a configuration like this would cause
-connections to `logging-es` to reload every 100 operations:
-
-```
-host logging-es
-port 9200
-reload_connections true
-sniffer_class_name Fluent::ElasticsearchSimpleSniffer
-reload_after 100
-```
-
-### Reload After
-
-When `reload_connections true`, this is the integer number of operations after which the plugin will
-reload the connections.  The default value is 10000.
-
 ### Not seeing a config you need?
 
 We try to keep the scope of this plugin small and not add too many configuration options. If you think an option would be useful to others, feel free to open an issue or contribute a Pull Request.
 
-Alternatively, consider using [fluent-plugin-forest](https://github.com/tagomoris/fluent-plugin-forest). For example, to configure multiple tags to be sent to different Elasticsearch indices:
+Alternatively, consider using [fluent-plugin-forest](https://github.com/tagomoris/fluent-plugin-forest). For example, to configure multiple tags to be sent to different ElasticSearch indices:
 
 ```
 <match my.logs.*>
@@ -624,7 +491,7 @@ And yet another option is described in Dynamic Configuration section.
 
 ### Dynamic configuration
 
-If you want configurations to depend on information in messages, you can use `elasticsearch_dynamic`. This is an experimental variation of the Elasticsearch plugin allows configuration values to be specified in ways such as the below:
+If you want configurations to depend on information in messages, you can use `elasticsearch_dynamic`. This is an experimental variation of the ElasticSearch plugin allows configuration values to be specified in ways such as the below:
 
 ```
 <match my.logs.*>
@@ -639,12 +506,6 @@ If you want configurations to depend on information in messages, you can use `el
 
 **Please note, this uses Ruby's `eval` for every message, so there are performance and security implications.**
 
-### suppress_doc_wrap
-
-By default, record body is wrapped by 'doc'. This behavior can not handle update script requests. You can set this to suppress doc wrapping and allow record body to be untouched.
-
-Default value is `false`.
-
 ## Contact
 
 If you have a question, [open an Issue](https://github.com/uken/fluent-plugin-elasticsearch/issues).