elasticsearch-watcher 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 997c4ba2c5e12dbd058aa6ce597770019f7f6fbd
+  data.tar.gz: 4b9088c48307f47f57b56426abb7030f7b8c2cfa
+SHA512:
+  metadata.gz: 5852020cbae6eb416ebdf4ed1ca99d0d4271d3dcd6324772a182575bb22fe8a6d388d96a706b12d6c2ca5b1aee0dfc3a507cb993b3b37428079050e34f749ea3
+  data.tar.gz: 2d1327265ba961cda13400847caa802b37bdaf78029994db88fe6c1cd61b402d6b9b97a20273fc91e2bb1b5de90e66f66d98864fd54d165ae53453e3fb7d9bce

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in elasticsearch-watcher.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright (c) 2015 Elasticsearch
+
+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/README.md

@@ -0,0 +1,166 @@
+# Elasticsearch::Watcher
+
+This library provides Ruby API for the [_Watcher_](https://www.elastic.co/products/watcher) plugin.
+
+Please refer to the [_Watcher_ documentation](http://www.elastic.co/guide/en/watcher/current/index.html)
+for information about the plugin.
+
+## Installation
+
+Install the package from [Rubygems](https://rubygems.org):
+
+    gem install elasticsearch-watcher
+
+To use an unreleased version, either add it to your `Gemfile` for [Bundler](http://gembundler.com):
+
+    gem 'elasticsearch-watcher', git: 'git://github.com/elasticsearch/elasticsearch-ruby.git'
+
+or install it from a source code checkout:
+
+    git clone https://github.com/elasticsearch/elasticsearch-ruby.git
+    cd elasticsearch-ruby/elasticsearch-watcher
+    bundle install
+    rake install
+
+## Usage
+
+The documentation for the Ruby API methods is available at <http://www.rubydoc.info/gems/elasticsearch-watcher>.
+
+A comprehensive example of registering a watch, triggering the actions, and getting information
+about the watch execution is quoted below.
+
+```ruby
+require 'elasticsearch'
+require 'elasticsearch/watcher'
+
+client = Elasticsearch::Client.new url: 'http://localhost:9200', log: true
+client.transport.logger.formatter = proc do |severity, datetime, progname, msg| "\e[2m#{msg}\e[0m\n" end
+
+# Delete the Watcher and test indices
+#
+client.indices.delete index: ['alerts', 'test', '.watches', '.watch_history*'], ignore: 404
+
+# Print information about the Watcher plugin
+#
+puts "Watcher #{client.watcher.info['version']['number']}"
+
+# Register a new watch
+#
+client.watcher.put_watch id: 'error_500', body: {
+  # Label the watch
+  #
+  metadata: { tags: ['errors'] },
+
+  # Run the watch every 10 seconds
+  #
+  trigger: { schedule: { interval: '10s' } },
+
+  # Search for at least 3 documents matching the condition
+  #
+  condition: {  script: { inline: 'ctx.payload.hits.total > 3' } },
+
+  # Throttle the watch execution for 30 seconds
+  #
+  throttle_period: '30s',
+
+  # The search request to execute
+  #
+  input:   { search: {
+               request: {
+                 indices: ['test'],
+                 body: {
+                   query: {
+                     filtered: {
+                       query: { match: { status: 500 } },
+                       filter: { range: { timestamp: { from: '{{ctx.trigger.scheduled_time}}||-5m', to: '{{ctx.trigger.triggered_time}}' } } }
+                     }
+                   },
+                   # Return statistics about different hosts
+                   #
+                   aggregations: {
+                    hosts: { terms: { field: 'host' } }
+                   }
+                 }}}},
+
+  # The actions to perform
+  #
+  actions: {
+    send_email:    {
+      transform: {
+        # Transform the data for the template
+        #
+        script: 'return [ total: ctx.payload.hits.total, hosts: ctx.payload.aggregations.hosts.buckets.collect { [ host: it.key, errors: it.doc_count ] }, errors: ctx.payload.hits.hits.collect { it._source } ];'
+      },
+      email: { to:        'alerts@example.com',
+               subject:   '[ALERT] {{ctx.watch_id}}',
+               body:      "Received {{ctx.payload.total}} error documents in the last 5 minutes.\n\nHosts:\n\n{{#ctx.payload.hosts}}* {{host}} ({{errors}})\n{{/ctx.payload.hosts}}",
+               attach_data: true }
+    },
+    index_payload: {
+      # Transform the data to be stored
+      #
+      transform: { script: 'return [ watch_id: ctx.watch_id, payload: ctx.payload ]' },
+      index: { index: 'alerts', doc_type: 'alert' }
+    },
+    ping_webhook: {
+      webhook: {
+        method: 'POST',
+        host:   'localhost',
+        port:   4567,
+        path:   '/',
+        body:   %q|{"watch_id" : "{{ctx.watch_id}}", "payload" : "{{ctx.payload}}"}| }
+    }
+  }
+}
+
+# Index documents to trigger the watch
+#
+5.times do
+  client.index index: 'test', type: 'd',
+               body: { timestamp: Time.now.utc.iso8601, status: 500, host: "10.0.0.#{rand(1..3)}" }
+end
+
+# Wait a bit...
+#
+print "Waiting 30 seconds..."
+$i=0; while $i < 30 do
+  sleep(1); print('.'); $i+=1
+end; puts "\n"
+
+# Display information about watch execution
+#
+puts '='*80, ""
+client.search(index: '.watch_history*', q: 'watch_id:error_500', sort: 'timestamp:asc')['hits']['hits'].each do |r|
+  puts "#{r['_id']} : #{r['_source']['state']}"
+end
+
+# Delete the watch
+#
+puts "Deleting the watch..."
+client.watcher.delete_watch id: 'error_500', master_timeout: '30s', force: true
+```
+
+You can run a simple [Sinatra](https://github.com/sinatra/sinatra/) server
+to test the `webhook` action with the following Ruby code:
+
+```bash
+ruby -r sinatra -r json -e 'post("/") { json = JSON.parse(request.body.read); puts %Q~Received #{json["watch_id"]} with payload: #{json["payload"]}~ }'
+```
+
+## License
+
+This software is licensed under the Apache 2 license, quoted below.
+
+    Copyright (c) 2015 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.

data/Rakefile

@@ -0,0 +1,99 @@
+require 'pathname'
+require 'bundler/gem_tasks'
+
+__current__ = Pathname( File.expand_path('..', __FILE__) )
+
+task(:default) { system "rake --tasks" }
+task  :test    => 'test:unit'
+
+# ----- Test tasks ------------------------------------------------------------
+
+require 'rake/testtask'
+namespace :test do
+  Rake::TestTask.new(:unit) do |test|
+    test.libs << 'lib' << 'test'
+    test.test_files = FileList["test/unit/**/*_test.rb"]
+    # test.verbose = true
+    # test.warning = true
+  end
+
+  desc "Run integration tests"
+  task :integration do
+    unless ENV['TEST_REST_API_SPEC']
+      puts "[!] Please export the TEST_REST_API_SPEC variable with a path to the Watcher YAML tests"
+      exit(1)
+    end
+
+    # Define the task
+    t = Rake::TestTask.new(:integration) do |test|
+      test.libs << 'lib' << 'test'
+      test.test_files = FileList["../elasticsearch-api/test/integration/yaml_test_runner.rb", "test/integration/**/*_test.rb"]
+    end
+
+    # Run the task
+    args = [t.ruby_opts_string, t.run_code, t.file_list_string, t.option_list].join(' ')
+
+    ruby args do |ok, status|
+      if !ok && status.respond_to?(:signaled?) && status.signaled?
+        raise SignalException.new(status.termsig)
+      elsif !ok
+        fail "Command failed with status (#{status.exitstatus}): " + "[ruby #{args}]"
+      end
+    end
+  end
+
+  desc "Run unit and integration tests"
+  task :all do
+    Rake::Task['test:ci_reporter'].invoke if ENV['CI']
+    Rake::Task['test:unit'].invoke
+    Rake::Task['test:integration'].invoke
+  end
+
+  desc "Initialize or update the repository with integration tests"
+  task :update do
+    sh "git --git-dir=#{__current__.join('tmp/elasticsearch-watcher/.git')} --work-tree=#{__current__.join('tmp/elasticsearch-watcher')} fetch origin --verbose"
+    begin
+      puts %x[git --git-dir=#{__current__.join('tmp/elasticsearch-watcher/.git')} --work-tree=#{__current__.join('tmp/elasticsearch-watcher')} pull --verbose]
+    rescue Exception => @exception
+      @failed = true
+    end
+
+    if @failed || !$?.success?
+      STDERR.puts "", "[!] Error while pulling -- #{@exception}"
+    end
+
+    puts "\n", "CHANGES:", '-'*80
+    sh "git --git-dir=#{__current__.join('tmp/elasticsearch-watcher/.git')} --work-tree=#{__current__.join('tmp/elasticsearch-watcher')} log --oneline ORIG_HEAD..HEAD | cat", :verbose => false
+  end
+
+  namespace :cluster do
+    desc "Start Elasticsearch nodes for tests"
+    task :start do
+      $LOAD_PATH << File.expand_path('../../elasticsearch-transport/lib', __FILE__) << File.expand_path('../test', __FILE__)
+      require 'elasticsearch/extensions/test/cluster'
+      Elasticsearch::Extensions::Test::Cluster.start
+    end
+
+    desc "Stop Elasticsearch nodes for tests"
+    task :stop do
+      $LOAD_PATH << File.expand_path('../../elasticsearch-transport/lib', __FILE__) << File.expand_path('../test', __FILE__)
+      require 'elasticsearch/extensions/test/cluster'
+      Elasticsearch::Extensions::Test::Cluster.stop
+    end
+  end
+end
+
+# ----- Documentation tasks ---------------------------------------------------
+
+require 'yard'
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.options = %w| --embed-mixins --markup=markdown |
+end
+
+# ----- Code analysis tasks ---------------------------------------------------
+
+require 'cane/rake_task'
+Cane::RakeTask.new(:quality) do |cane|
+  cane.abc_max = 15
+  cane.no_style = true
+end

data/elasticsearch-watcher.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'elasticsearch/watcher/version'
+
+Gem::Specification.new do |s|
+  s.name          = "elasticsearch-watcher"
+  s.version       = Elasticsearch::Watcher::VERSION
+  s.authors       = ["Karel Minarik"]
+  s.email         = ["karel.minarik@elasticsearch.org"]
+  s.description   = %q{Ruby Integrations for Elasticsearch Watcher plugin (WIP)}
+  s.summary       = s.description
+  s.homepage      = ""
+  s.license       = "Apache 2"
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_dependency "elasticsearch-api"
+
+  s.add_development_dependency "bundler", "~> 1.3"
+  s.add_development_dependency "rake"
+
+  s.add_development_dependency "elasticsearch"
+  s.add_development_dependency "elasticsearch-extensions"
+
+  s.add_development_dependency 'shoulda-context'
+  s.add_development_dependency 'activesupport'
+  s.add_development_dependency 'turn'
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'minitest', '~> 4.0'
+  s.add_development_dependency 'minitest-reporters'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'simplecov-rcov'
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'cane'
+  s.add_development_dependency 'pry'
+end

data/lib/elasticsearch-watcher.rb

@@ -0,0 +1 @@
+require 'elasticsearch/watcher'

data/lib/elasticsearch/watcher.rb

@@ -0,0 +1,37 @@
+require "elasticsearch/watcher/version"
+
+Dir[ File.expand_path('../watcher/api/actions/**/*.rb', __FILE__) ].each   { |f| require f }
+
+module Elasticsearch
+  module Watcher
+    def self.included(base)
+      base.__send__ :include, Elasticsearch::API::Watcher
+    end
+  end
+end
+
+module Elasticsearch
+  module API
+    module Watcher
+      module Actions; end
+
+        # Client for the "watcher" namespace (includes the {Watcher::Actions} methods)
+        #
+        class WatcherClient
+          include Elasticsearch::API::Common::Client,
+                  Elasticsearch::API::Common::Client::Base,
+                  Elasticsearch::API::Watcher::Actions
+        end
+
+        # Proxy method for {WatcherClient}, available in the receiving object
+        #
+        def watcher
+          @watcher ||= WatcherClient.new(self)
+        end
+    end
+  end
+end
+
+Elasticsearch::API.__send__ :include, Elasticsearch::API::Watcher
+
+Elasticsearch::Transport::Client.__send__ :include, Elasticsearch::API::Watcher if defined?(Elasticsearch::Transport::Client)

data/lib/elasticsearch/watcher/api/actions/ack_watch.rb

@@ -0,0 +1,27 @@
+module Elasticsearch
+  module API
+    module Watcher
+      module Actions
+
+        # Throttle the execution of the watch by acknowledging it
+        #
+        # @option arguments [String] :id Watch ID (*Required*)
+        #
+        # @see http://www.elastic.co/guide/en/watcher/current/appendix-api-ack-watch.html
+        #
+        def ack_watch(arguments={})
+          raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+          valid_params = [
+            :master_timeout
+          ]
+          method = 'PUT'
+          path   = "_watcher/watch/#{arguments[:id]}/_ack"
+          params = {}
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/watcher/api/actions/delete_watch.rb

@@ -0,0 +1,29 @@
+module Elasticsearch
+  module API
+    module Watcher
+      module Actions
+
+        # Delete a specific watch
+        #
+        # @option arguments [String] :id Watch ID (*Required*)
+        # @option arguments [Boolean] :force Ignore any locks on the watch and force the execution
+        #
+        # @see http://www.elastic.co/guide/en/watcher/current/appendix-api-delete-watch.html
+        #
+        def delete_watch(arguments={})
+          raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+          valid_params = [
+            :master_timeout,
+            :force
+          ]
+          method = 'DELETE'
+          path   = "_watcher/watch/#{arguments[:id]}"
+          params = {}
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end