fluent-plugin-elasticsearch-patch 1.3.0.p1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee375db282e26e2170754cbb4ee07099ca7047be
+  data.tar.gz: 2359d123bfa86bc22e7e367e0b7f911855a295ab
+SHA512:
+  metadata.gz: 4d742a701d31cb78176d0a5cf567748fa474493aa3994b588149efa7872a6689c7dd4d8c478b6de85fac8c66e9bd6536e42d2792b2b871650c2d11e832aa50a3
+  data.tar.gz: 41d73c71e7a2203e8478058f0785c53bea389bdd35fa405e0bf5ece8275c160cd45ad323a5b62f97405764f6d656d84826443083dd1af260936e815c4550e505

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-ci
+

data/.editorconfig

@@ -0,0 +1,9 @@
+# EditorConfig: http://EditorConfig.org
+
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+
+script: bundle exec rake test
+sudo: false

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-elasticsearch.gemspec
+gemspec
+
+gem 'simplecov', require: false
+gem 'coveralls', require: false

data/History.md

@@ -0,0 +1,74 @@
+## Changelog
+
+### 1.3.0
+- add `write_operation`
+
+### 1.2.1
+- fix `resurrect_after` in out_elasticsearch_dynamic
+
+### 1.2.0
+- out_elasticsearch_dynamic get memory improvement and fix for race condition (#133)
+- Add `resurrect_after` option (#136)
+
+### 1.1.0
+- Support SSL client verification and custom CA file (#123)
+- Release experimental `type elasticsearch_dynamic` (#127)
+
+### 1.0.0
+- password config param is now marked as secret and won't be displayed in logs.
+
+### 0.9.0
+- Add `ssl_verify` option (#108)
+
+### 0.8.0
+- Replace Patron with Excon HTTP client (#93)
+
+### 0.7.0
+- Add new option `time_key` (#85)
+
+### 0.6.1
+- 0.10.43 is minimum version required of fluentd (#79)
+
+### 0.6.0
+- added `reload_on_failure` and `reload_connections` flags (#78)
+
+### 0.5.1
+- fix legacy hosts option, port should be optional (#75)
+
+### 0.5.0
+- add full connection URI support (#65)
+- use `@timestamp` for index (#41)
+- add support for elasticsearch gem version 1 (#71)
+- fix connection reset & retry when connection is lost (#67)
+
+### 0.4.0
+- add `request_timeout` config (#59)
+- fix lockup when non-hash values are sent (#52)
+
+### 0.3.1
+- force using patron (#46)
+- do not generate @timestamp if already part of message (#35)
+
+### 0.3.0
+- add `parent_key` option (#28)
+- have travis-ci build on multiple rubies (#30)
+- add `utc_index` and `hosts` options, switch to using `elasticsearch` gem (#26, #29)
+
+### 0.2.0
+- fix encoding issues with JSON conversion and again when sending to elasticsearch (#19, #21)
+- add logstash_dateformat option (#20)
+
+### 0.1.4
+- add logstash_prefix option
+
+### 0.1.3
+- raising an exception on non-success response from elasticsearch
+
+### 0.1.2
+- add id_key option
+
+### 0.1.1
+- fix timezone in logstash key
+
+### 0.1.0
+ - Initial gem release.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Uken Games
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,324 @@
+# Fluent::Plugin::Elasticsearch, a plugin for [Fluentd](http://fluentd.org)
+
+[![Gem Version](https://badge.fury.io/rb/fluent-plugin-elasticsearch.png)](http://badge.fury.io/rb/fluent-plugin-elasticsearch)
+[![Build Status](https://travis-ci.org/uken/fluent-plugin-elasticsearch.png?branch=master)](https://travis-ci.org/uken/fluent-plugin-elasticsearch)
+[![Coverage Status](https://coveralls.io/repos/uken/fluent-plugin-elasticsearch/badge.png)](https://coveralls.io/r/uken/fluent-plugin-elasticsearch)
+[![Code Climate](https://codeclimate.com/github/uken/fluent-plugin-elasticsearch.png)](https://codeclimate.com/github/uken/fluent-plugin-elasticsearch)
+[![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?)
+
+Note: For Amazon Elasticsearch Service please consider using [fluent-plugin-aws-elasticsearch-service](https://github.com/atomita/fluent-plugin-aws-elasticsearch-service)
+
+* [Installation](#installation)
+* [Usage](#usage)
+  + [Index templates](#index-templates)
+* [Configuration](#configuration)
+  + [hosts](#hosts)
+  + [user, password, path, scheme, ssl_verify](#user-password-path-scheme-ssl_verify)
+  + [logstash_format](#logstash_format)
+  + [logstash_prefix](#logstash_prefix)
+  + [logstash_dateformat](#logstash_dateformat)
+  + [time_key](#time_key)
+  + [utc_index](#utc_index)
+  + [request_timeout](#request_timeout)
+  + [reload_connections](#reload_connections)
+  + [reload_on_failure](#reload_on_failure)
+  + [resurrect_after](#resurrect_after)
+  + [include_tag_key, tag_key](#include_tag_key-tag_key)
+  + [id_key](#id_key)
+  + [write_operation](#write_operation)
+  + [Client/host certificate options](#clienthost-certificate-options)
+  + [Buffered output options](#buffered-output-options)
+  + [Not seeing a config you need?](#not-seeing-a-config-you-need)
+  + [Dynamic configuration](#dynamic-configuration)
+* [Contact](#contact)
+* [Contributing](#contributing)
+* [Running tests](#running-tests)
+
+## Installation
+
+```sh
+$ gem install fluent-plugin-elasticsearch
+```
+
+## Usage
+
+In your Fluentd configuration, use `type elasticsearch`. Additional configuration is optional, default values would look like this:
+
+```
+<match my.logs>
+  type elasticsearch
+  host localhost
+  port 9200
+  index_name fluentd
+  type_name fluentd
+</match>
+```
+
+### 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.
+
+## Configuration
+
+### 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.
+
+### user, password, path, scheme, ssl_verify
+
+If you specify this option, host and port options are ignored.
+
+```
+user demo
+password secret
+path /elastic_search/
+scheme https
+```
+
+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)
+
+### logstash_format
+
+```
+logstash_format true # defaults to false
+```
+
+This is meant to make writing data into ElasticSearch compatible to what [Logstash](https://www.elastic.co/products/logstash) writes. By doing this, one could take advantage of [Kibana](https://www.elastic.co/products/kibana).
+
+### logstash_prefix
+
+```
+logstash_prefix mylogs # defaults to "logstash"
+```
+
+### logstash_dateformat
+
+By default, the records inserted into index `logstash-YYMMDD`. This option allows to insert into specified index like `mylogs-YYYYMM` for a monthly index.
+
+```
+logstash_dateformat %Y.%m. # defaults to "%Y.%m.%d"
+```
+
+### time_key
+
+By default, when inserting records in [Logstash](https://www.elastic.co/products/logstash) format, `@timestamp` is dynamically created with the time at log ingestion. If you'd like to use a custom time, include an `@timestamp` with your record.
+
+```
+{"@timestamp":"2014-04-07T000:00:00-00:00"}
+```
+
+You can specify an option `time_key` (like the option described in [tail Input Plugin](http://docs.fluentd.org/articles/in_tail)) to replace `@timestamp` key.
+
+Suppose you have settings
+
+```
+logstash_format true
+time_key vtm
+```
+
+Your input is:
+```
+{
+  "title": "developer",
+  "vtm": "2014-12-19T08:01:03Z"
+}
+```
+
+The output will be
+```
+{
+  "title": "developer",
+  "@timstamp": "2014-12-19T08:01:03Z",
+  "vtm": "2014-12-19T08:01:03Z"
+}
+```
+
+### utc_index
+
+```
+utc_index true
+```
+
+By default, the records inserted into index `logstash-YYMMDD` with UTC (Coordinated Universal Time). This option allows to use local time if you describe utc_index to false.
+
+### 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.
+
+```
+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.
+
+```
+reload_connections false # defaults to true
+```
+
+### reload_on_failure
+
+Indicates that the elasticsearch-transport will try to reload the nodes addresses if there is a failure while making the
+request, this can be useful to quickly remove a dead node from the list of addresses.
+
+```
+reload_on_failure true # defaults to false
+```
+
+### resurrect_after
+
+You can set in the elasticsearch-transport how often dead connections from the elasticsearch-transport's pool will be resurrected.
+
+```
+resurrect_after 5 # defaults to 60s
+```
+
+### include_tag_key, tag_key
+
+```
+include_tag_key true # defaults to false
+tag_key tag # defaults to tag
+```
+
+This will add the Fluentd tag in the JSON record. For instance, if you have a config like this:
+
+```
+<match my.logs>
+  type elasticsearch
+  include_tag_key true
+  tag_key _key
+</match>
+```
+
+The record inserted into ElasticSearch would be
+
+```
+{"_key":"my.logs", "name":"Johnny Doeie"}
+```
+
+### id_key
+
+```
+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.
+
+This following record `{"name":"Johnny","request_id":"87d89af7daffad6"}` will trigger the following ElasticSearch command
+
+```
+{ "index" : { "_index" : "logstash-2013.01.01, "_type" : "fluentd", "_id" : "87d89af7daffad6" } }
+{ "name": "Johnny", "request_id": "87d89af7daffad6" }
+```
+
+### write_operation
+
+The write_operation can be any of: 
+
+| Operation | Description          |
+| ------------- | ----------- |
+| index (default)      | new data is added while existing data (based on its id) is replaced (reindexed).|
+| create      | adds new data - if the data already exists (based on its id), the op is skipped.|
+| update      | updates existing data (based on its id). If no data is found, the op is skipped.|
+| upsert      | known as merge or insert if the data does not exist, updates if the data exists (based on its id).|
+
+**Please note, id is required in create, update, and upsert scenario. Without id, the message will be dropped.**
+
+### 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.
+```
+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.
+```
+client_cert /path/to/your/client/cert
+client_key /path/to/your/private/key
+client_key_pass password
+```
+
+### Buffered output options
+
+`fluentd-plugin-elasticsearch` extends [Fluentd's builtin Buffered Output plugin](http://docs.fluentd.org/articles/buffer-plugin-overview). It adds the following options:
+
+```
+buffer_type memory
+flush_interval 60
+retry_limit 17
+retry_wait 1.0
+num_threads 1
+```
+
+The value for option `buffer_chunk_limit` should not exceed value `http.max_content_length` in your Elasticsearch setup (by default it is 104857600 bytes).
+
+### 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:
+
+```
+<match my.logs.*>
+  type forest
+  subtype elasticsearch
+  remove_prefix my.logs
+  <template>
+    logstash_prefix ${tag}
+    # ...
+  </template>
+</match>
+```
+
+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:
+
+```
+<match my.logs.*>
+  type elasticsearch_dynamic
+  hosts ${record['host1']}:9200,${record['host2']}:9200
+  index_name my_index.${Time.at(time).getutc.strftime(@logstash_dateformat)}
+  logstash_prefix ${tag_parts[3]}
+  port ${9200+rand(4)}
+  index_name ${tag_parts[2]}-${Time.at(time).getutc.strftime(@logstash_dateformat)}
+</match>
+```
+
+**Please note, this uses Ruby's `eval` for every message, so there are performance and security implications.**
+
+## Contact
+
+If you have a question, [open an Issue](https://github.com/uken/fluent-plugin-elasticsearch/issues).
+
+## Contributing
+
+Pull Requests are welcomed.
+
+## Running tests
+
+Install dev dependencies:
+
+```sh
+$ gem install bundler
+$ bundle install
+$ bundle exec rake test
+```