fluent-plugin-embedded-elasticsearch 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 621bf06d745ee49ec9386b74e99f4abe0c4e6e6e
+  data.tar.gz: 781dec304a1450ab366830e606079e09da79236c
+SHA512:
+  metadata.gz: 635ad865b7396ea94397b13bbf04c63d641f7cd332c6253593642f97deb9935b8368df56ba510a17f13e9472aafd2758e5c88682a6485d14b31bd9f224315854
+  data.tar.gz: 3548ff220e086e0cdb397108d10522290975a813a44c2b6612523a582eb7d9f973c3d1f87e5eaaffc7fb53b2cfc68c065f6306e5f08a88449ccda8ed24726800

data/README.md

@@ -0,0 +1,46 @@
+#Embedded ElasticSearch for Fluentd 
+
+This plugin launches a local ElasticSearch process inside Fluentd.
+ElasticSearch's version is 0.90-RC2.
+
+## Installation
+
+Use RubyGems:
+
+    gem install fluent-plugin-embedded-elasticsearch
+
+## Configuration
+
+    <source>
+      type embedded_elasticsearch
+    </source>
+
+Also, please see "conf/example.conf" for an example configuration with
+[fluent-plugin-kibana-server](http://github.com/choplin/fluent-plugin-kibana-server) and
+[fluent-plugin-elasticsearch](http://github.com/uken/fluent-plugin-elasticsearch).
+
+## TODO
+
+Figure out what ElasticSearch options are useful. Right now, `elasticsearch -f
+-Des.index.store=memory` is hard-coded, but all the ES options should be
+configurable (either via -Des.config or inlining). **Pull requests are
+welcomed!**
+
+## Notes
+
+* Thanks to folks over at Logstash for the "embedding" idea.
+* Thanks to @frsyuki for [ServerEngine](https://github.com/frsyuki/serverengine)
+
+## Copyright
+
+<table>
+  <tr>
+    <td>Author</td><td>Kiyoto Tamura<me@ktamura.com></td>
+  </tr>
+  <tr>
+    <td>Copyright</td><td>Copyright (c) 2013- Kiyoto Tamura</td>
+  </tr>
+  <tr>
+    <td>License</td><td>Apache 2.0 License</td>
+  </tr>
+</table>

data/conf/example.conf

@@ -0,0 +1,32 @@
+
+<source>
+  type embedded_elasticsearch
+</source>
+
+<source>
+  type kibana_server
+  bind 0.0.0.0
+  port 24300
+  mount /kibana/
+  access_log_path /var/log/kibana/access.log
+  elasticsearch_url http://localhost:9200
+</source>
+
+<source>
+  type http
+  port 8888
+</source>
+
+<match es.**>
+  type copy
+  <store>
+      type elasticsearch
+      logstash_format true
+      index_name fluentd
+      type_name fluentd
+      flush_interval 3
+  </store>
+  <store>
+    type stdout
+  </store>
+</match>

data/lib/fluent/plugin/in_embedded_elasticsearch.rb

@@ -0,0 +1,52 @@
+require 'shellwords'
+require 'serverengine'
+
+module Fluent
+  class EmbeddedElasticSearchInput < Input
+    Plugin.register_input('embedded_elasticsearch', self)
+
+    DIR_PATH = File.dirname(__FILE__)
+
+    config_param :graceful_kill_interval, :time, :default => 2
+    config_param :graceful_kill_interval_increment, :time, :default => 3
+    config_param :graceful_kill_timeout, :time, :default => 60
+    config_param :bind, :string, :default => "localhost"
+    config_param :port, :string, :default => 9200
+    config_param :elasticsearch_dir, :string, :default => File.expand_path("#{DIR_PATH}/../../../vendor/elasticsearch/")
+
+    def configure(conf)
+      super
+    end
+
+    def start
+      @pm = ServerEngine::ProcessManager.new(
+        :auto_tick => true,
+        :auto_tick_interval => 1,
+        :graceful_kill_interval => @graceful_kill_interval,
+        :graceful_kill_interval_increment => @graceful_kill_interval_increment,
+        :graceful_kill_timeout => @graceful_kill_timeout,
+        :graceful_kill_signal => 'TERM',
+        :immediate_kill_timeout => 0,  # disabled
+      )
+
+      $log.info "Launching ElasticSearch #{@bind}:#{@port} with #{@elasticsearch_dir}"
+      @process_monitor = @pm.spawn(elasticsearch_command)
+    end
+
+    def shutdown
+      $log.info "Shutting down ElasticSearch"
+
+      if @process_monitor
+        @process_monitor.start_graceful_stop!
+        @process_monitor.join
+      end
+    end
+
+    def elasticsearch_command 
+      elasticsearch_binary = "#{@elasticsearch_dir}/bin/elasticsearch"
+      options = ["-f", "-Des.index.store=memory"] # -f ensures it runs in the (ServerEngine) foreground
+      "#{elasticsearch_binary} #{options.join(" ")}"
+    end
+
+  end
+end

data/vendor/elasticsearch/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/vendor/elasticsearch/NOTICE.txt

@@ -0,0 +1,5 @@
+ElasticSearch
+Copyright 2009-2011 ElasticSearch and Shay Banon
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

data/vendor/elasticsearch/README.textile

@@ -0,0 +1,227 @@
+h1. ElasticSearch
+
+h2. A Distributed RESTful Search Engine
+
+h3. "http://www.elasticsearch.org":http://www.elasticsearch.org
+
+ElasticSearch is a distributed RESTful search engine built for the cloud. Features include:
+
+* Distributed and Highly Available Search Engine.
+** Each index is fully sharded with a configurable number of shards.
+** Each shard can have one or more replicas.
+** Read / Search operations performed on either one of the replica shard.
+* Multi Tenant with Multi Types.
+** Support for more than one index.
+** Support for more than one type per index.
+** Index level configuration (number of shards, index storage, ...).
+* Various set of APIs
+** HTTP RESTful API
+** Native Java API.
+** All APIs perform automatic node operation rerouting.
+* Document oriented
+** No need for upfront schema definition.
+** Schema can be defined per type for customization of the indexing process.
+* Reliable, Asynchronous Write Behind for long term persistency.
+* (Near) Real Time Search.
+* Built on top of Lucene
+** Each shard is a fully functional Lucene index
+** All the power of Lucene easily exposed through simple configuration / plugins.
+* Per operation consistency
+** Single document level operations are atomic, consistent, isolated and durable.
+* Open Source under Apache 2 License.
+
+h2. Getting Started
+
+First of all, DON'T PANIC. It will take 5 minutes to get the gist of what ElasticSearch is all about.
+
+h3. Installation
+
+* "Download":http://www.elasticsearch.org/download and unzip the ElasticSearch official distribution.
+* Run @bin/elasticsearch -f@ on unix, or @bin/elasticsearch.bat@ on windows.
+* Run @curl -X GET http://localhost:9200/@.
+* Start more servers ...
+
+h3. Indexing
+
+Lets try and index some twitter like information. First, lets create a twitter user, and add some tweets (the @twitter@ index will be created automatically):
+
+<pre>
+curl -XPUT 'http://localhost:9200/twitter/user/kimchy' -d '{ "name" : "Shay Banon" }'
+
+curl -XPUT 'http://localhost:9200/twitter/tweet/1' -d '
+{ 
+    "user": "kimchy", 
+    "postDate": "2009-11-15T13:12:00", 
+    "message": "Trying out Elastic Search, so far so good?" 
+}'
+
+curl -XPUT 'http://localhost:9200/twitter/tweet/2' -d '
+{ 
+    "user": "kimchy", 
+    "postDate": "2009-11-15T14:12:12", 
+    "message": "Another tweet, will it be indexed?" 
+}'
+</pre>
+
+Now, lets see if the information was added by GETting it:
+
+<pre>
+curl -XGET 'http://localhost:9200/twitter/user/kimchy?pretty=true'
+curl -XGET 'http://localhost:9200/twitter/tweet/1?pretty=true'
+curl -XGET 'http://localhost:9200/twitter/tweet/2?pretty=true'
+</pre>
+
+h3. Searching
+
+Mmm search..., shouldn't it be elastic? 
+Lets find all the tweets that @kimchy@ posted:
+
+<pre>
+curl -XGET 'http://localhost:9200/twitter/tweet/_search?q=user:kimchy&pretty=true'
+</pre>
+
+We can also use the JSON query language ElasticSearch provides instead of a query string:
+
+<pre>
+curl -XGET 'http://localhost:9200/twitter/tweet/_search?pretty=true' -d '
+{ 
+    "query" : { 
+        "text" : { "user": "kimchy" }
+    } 
+}'
+</pre>
+
+Just for kicks, lets get all the documents stored (we should see the user as well):
+
+<pre>
+curl -XGET 'http://localhost:9200/twitter/_search?pretty=true' -d '
+{ 
+    "query" : { 
+        "matchAll" : {} 
+    } 
+}'
+</pre>
+
+We can also do range search (the @postDate@ was automatically identified as date)
+
+<pre>
+curl -XGET 'http://localhost:9200/twitter/_search?pretty=true' -d '
+{ 
+    "query" : { 
+        "range" : { 
+            "postDate" : { "from" : "2009-11-15T13:00:00", "to" : "2009-11-15T14:00:00" } 
+        } 
+    } 
+}'
+</pre>
+
+There are many more options to perform search, after all, its a search product no? All the familiar Lucene queries are available through the JSON query language, or through the query parser.
+
+h3. Multi Tenant - Indices and Types
+
+Maan, that twitter index might get big (in this case, index size == valuation). Lets see if we can structure our twitter system a bit differently in order to support such large amount of data.
+
+ElasticSearch support multiple indices, as well as multiple types per index. In the previous example we used an index called @twitter@, with two types, @user@ and @tweet@.
+
+Another way to define our simple twitter system is to have a different index per user (though note that an index has an overhead). Here is the indexing curl's in this case:
+
+<pre>
+curl -XPUT 'http://localhost:9200/kimchy/info/1' -d '{ "name" : "Shay Banon" }'
+
+curl -XPUT 'http://localhost:9200/kimchy/tweet/1' -d '
+{ 
+    "user": "kimchy", 
+    "postDate": "2009-11-15T13:12:00", 
+    "message": "Trying out Elastic Search, so far so good?" 
+}'
+
+curl -XPUT 'http://localhost:9200/kimchy/tweet/2' -d '
+{ 
+    "user": "kimchy", 
+    "postDate": "2009-11-15T14:12:12", 
+    "message": "Another tweet, will it be indexed?" 
+}'
+</pre>
+
+The above index information into the @kimchy@ index, with two types, @info@ and @tweet@. Each user will get his own special index.
+
+Complete control on the index level is allowed. As an example, in the above case, we would want to change from the default 5 shards with 1 replica per index, to only 1 shard with 1 replica per index (== per twitter user). Here is how this can be done (the configuration can be in yaml as well):
+
+<pre>
+curl -XPUT http://localhost:9200/another_user/ -d '
+{ 
+    "index" : { 
+        "numberOfShards" : 1, 
+        "numberOfReplicas" : 1 
+    } 
+}'
+</pre>
+
+Search (and similar operations) are multi index aware. This means that we can easily search on more than one
+index (twitter user), for example:
+
+<pre>
+curl -XGET 'http://localhost:9200/kimchy,another_user/_search?pretty=true' -d '
+{ 
+    "query" : { 
+        "matchAll" : {} 
+    } 
+}'
+</pre>
+
+Or on all the indices:
+
+<pre>
+curl -XGET 'http://localhost:9200/_search?pretty=true' -d '
+{ 
+    "query" : { 
+        "matchAll" : {} 
+    } 
+}'
+</pre>
+
+{One liner teaser}: And the cool part about that? You can easily search on multiple twitter users (indices), with different boost levels per user (index), making social search so much simpler (results from my friends rank higher than results from my friends friends).
+
+h3. Distributed, Highly Available
+
+Lets face it, things will fail....
+
+ElasticSearch is a highly available and distributed search engine. Each index is broken down into shards, and each shard can have one or more replica. By default, an index is created with 5 shards and 1 replica per shard (5/1). There are many topologies that can be used, including 1/10 (improve search performance), or 20/1 (improve indexing performance, with search executed in a map reduce fashion across shards).
+
+In order to play with Elastic Search distributed nature, simply bring more nodes up and shut down nodes. The system will continue to serve requests (make sure you use the correct http port) with the latest data indexed.
+
+h3. Where to go from here?
+
+We have just covered a very small portion of what ElasticSearch is all about. For more information, please refer to: .
+
+h3. Building from Source
+
+ElasticSearch uses "Maven":http://maven.apache.org for its build system.
+
+In order to create a distribution, simply run the @mvn clean package
+-DskipTests@ command in the cloned directory.
+
+The distribution will be created under @target/releases@.
+
+See the "TESTING":TESTING.asciidoc file for more information about
+running the Elasticsearch test suite.
+
+h1. License
+
+<pre>
+This software is licensed under the Apache 2 license, quoted below.
+
+Copyright 2009-2013 Shay Banon and ElasticSearch <http://www.elasticsearch.org>
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not
+use this file except in compliance with the License. You may obtain a copy of
+the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+License for the specific language governing permissions and limitations under
+the License.
+</pre>