elasticsearch-xpack 5.5.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07db460f6169c230788a8065924cf9bfabf75ded
-  data.tar.gz: 99035150cc2c228c4456e23273dbf5a55b5c24ba
+  metadata.gz: 6d48434e595d29f97917ce830f882a8ed59adae3
+  data.tar.gz: e0ccd6d9d03a15b5903c4f29ee2c1c65b68abd39
 SHA512:
-  metadata.gz: 2b352de12499a84034a704a66a78ca5022a604bc231eb5c5a1b113d41ec9accc1234c0b492722e428628955d6a34b3a89e487b010cee6cd1c44f9eeeb116a6a9
-  data.tar.gz: 976c0a21635d66387285944afca22dfd3f062e1cfc835ed3fdc78e6be2aee46138fc1771d84bea99c8d30a2a8c13ab01b782dabe917ecf4a92fda3a04b0410ab
+  metadata.gz: 7e500cb2dc4facffc1861535c6a036d6959511519df85da4b3d833f9ee227ae857785f378ccd9c43794deefc1ab167cdc96b0dc74ed43fbd646c19da681b5a05
+  data.tar.gz: 6d463b5c155cb048b0d4528114b21d0c5fa703c7591a8a71a91245d000fa10f076be40bde5f50a12c5e3fbfe30cd05cd665976bb4b615b88ad58849d0f1cfff7

data/README.md

@@ -1,18 +1,17 @@
 # Elasticsearch::XPack
 
-A Ruby integration for the [X-Pack extensions](https://www.elastic.co/v5)
-for Elasticsearch.
+A Ruby integration for the [X-Pack extension](https://www.elastic.co/guide/en/x-pack/current/xpack-introduction.html) for Elasticsearch.
 
 
 ## Installation
 
 Install the package from [Rubygems](https://rubygems.org):
 
-    gem install elasticsearch-xpack --pre
+    gem install elasticsearch-xpack
 
 To use an unreleased version, either add it to your `Gemfile` for [Bundler](http://gembundler.com):
 
-    gem 'elasticsearch-xpack', git: 'git://github.com/elastic/elasticsearch-xpack-ruby.git'
+    gem 'elasticsearch-xpack', git: 'https://github.com/elastic/elasticsearch-x-pack-ruby.git'
 
 or install it from a source code checkout:
 
@@ -43,6 +42,10 @@ official [X-Pack for the Elastic Stack](https://www.elastic.co/guide/en/x-pack/c
 
 For examples, look into the [`examples`](examples) folder in this repository.
 
+You can use the provided `test:server` Rake task to launch
+a [Docker-based](https://www.elastic.co/guide/en/elasticsearch/reference/6.1/docker.html#_image_types)
+Elasticsearch node with the full X-Pack license preinstalled.
+
 ## License
 
 This software is licensed under the Apache 2 license, quoted below.

data/Rakefile

@@ -9,8 +9,8 @@ end
 Rake::TestTask.new('test:unit') do |test|
   test.libs << 'test'
   test.test_files = FileList['test/unit/**/*_test.rb']
-  # test.verbose = true
-  # test.warning = true
+  test.verbose = false
+  test.warning = false
 end
 
 namespace :test do
@@ -19,12 +19,7 @@ namespace :test do
     require 'ansi'
 
     suites = %w[
-      x-plugins/elasticsearch/x-pack/src/test/resources/rest-api-spec/test
-      x-plugins/elasticsearch/x-pack/graph/src/test/resources/rest-api-spec/test
-      x-plugins/elasticsearch/x-pack/monitoring/src/test/resources/rest-api-spec/test/monitoring
-      x-plugins/elasticsearch/x-pack/security/src/test/resources/rest-api-spec/test
-      x-plugins/elasticsearch/x-pack/watcher/src/test/resources/rest-api-spec/test/xpack/watcher
-      x-plugins/elasticsearch/x-pack/license-plugin/src/test/resources/rest-api-spec/test
+      plugin/src/test/resources/rest-api-spec/test/
     ]
 
     # TEMPORARY
@@ -59,7 +54,7 @@ namespace :test do
     suites.each do |suite|
       begin
         sh <<-COMMAND
-          TEST_REST_API_SPEC=../#{suite} bundle exec ruby -I lib:test test/integration/yaml_test_runner.rb
+          TEST_REST_API_SPEC=../x-pack-elasticsearch/#{suite} bundle exec ruby -I lib:test test/integration/yaml_test_runner.rb
         COMMAND
         executed_suites << { suite => 0 }
       rescue RuntimeError
@@ -69,27 +64,18 @@ namespace :test do
       puts '', '-'*80, ''
     end
   end
-end
-
-namespace :elasticsearch do
-  desc "Start Elasticsearch node for tests"
-  task :start do
-    require 'elasticsearch/extensions/test/cluster'
-    Elasticsearch::Extensions::Test::Cluster.start(port: ENV.fetch('TEST_CLUSTER_PORT', 9260), nodes: 1, path_logs: '/tmp')
-  end
 
-  desc "Stop Elasticsearch node for tests"
-  task :stop do
-    require 'elasticsearch/extensions/test/cluster'
-    Elasticsearch::Extensions::Test::Cluster.stop(port: ENV.fetch('TEST_CLUSTER_PORT', 9260), nodes: 1)
-  end
-
-  task :status do
-    require 'elasticsearch/extensions/test/cluster'
-    begin
-      Elasticsearch::Extensions::Test::Cluster.__print_cluster_info(ENV.fetch('TEST_CLUSTER_PORT', 9260))
-    rescue Errno::ECONNREFUSED
-      puts "\e[31m[!] Test cluster not running\e[0m"; exit(1)
+  desc "Run Elasticsearch with X-Pack installed (Docker)"
+    task :server do
+      sh <<-COMMAND.gsub(/^\s*/, '').gsub(/\s{1,}/, ' ')
+        docker run \
+          --name elasticsearch-xpack \
+          --env ELASTIC_PASSWORD=changeme \
+          --env cluster.name=elasticsearch-xpack-test \
+          --publish 9260:9200 \
+          --memory 4g \
+          --rm \
+          docker.elastic.co/elasticsearch/elasticsearch-platinum:6.1.1
+      COMMAND
     end
-  end
 end

data/elasticsearch-xpack.gemspec

@@ -21,15 +21,14 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 11.1"
 
-  spec.add_dependency "elasticsearch-api"
+  spec.add_dependency "elasticsearch-api", '~> 6'
 
-  spec.add_development_dependency "elasticsearch", '~> 5'
-  spec.add_development_dependency "elasticsearch-transport", '~> 5'
+  spec.add_development_dependency "elasticsearch", '~> 6'
+  spec.add_development_dependency "elasticsearch-transport", '~> 6'
   spec.add_development_dependency "elasticsearch-extensions"
 
   spec.add_development_dependency "activesupport"
   spec.add_development_dependency "ansi"
-  spec.add_development_dependency "turn"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "minitest-reporters"
   spec.add_development_dependency "shoulda-context"

data/examples/watcher/error_500.rb

@@ -2,21 +2,24 @@
 #
 # Execute this file from the root of the repository:
 #
-#     bundle exec ruby -I lib ./examples/watcher/error_500.rb
+#     ALERT_EMAIL=email@example.com bundle exec ruby -I lib ./examples/watcher/error_500.rb
 #
 # The watch searches for `500` errors in a specific index on a periodic basis, and performs three
 # actions when at least 3 errors have been received in the last 5 minutes:
 #
 # 1. indexes the error documents and aggregations returned from search,
 # 2. sends a notification via e-mail, and
-# 3. sends the data to a HTTP API.
+# 3. sends the data to a webhook.
 #
 # If you want to test sending the e-mail, you have to configure Watcher:
 # <https://www.elastic.co/guide/en/x-pack/current/actions-email.html#configuring-email>
 #
-# You can run a simple Sinatra based web server to test the webhook action with this script:
+# NOTE: If you want to use Gmail and you have 2-factor authentication enabled,
+#       generate an "App password", and use it in the `password` field.
 #
-#     $ ruby -r sinatra -r json -e 'post("/") { json = JSON.parse(request.body.read); puts %Q~Received #{json["watch_id"]} with payload: #{json["payload"]}~ }'
+# You can run a simple Sinatra application to test the webhook action with this script:
+#
+#     $ ruby -r sinatra -r json -e 'post("/") { json = JSON.parse(request.body.read); puts %Q~Received [#{json["watch_id"]}] with payload: #{json["payload"]}~ }'
 #
 
 require 'elasticsearch'
@@ -25,16 +28,18 @@ require 'elasticsearch/xpack'
 client = Elasticsearch::Client.new url: 'http://elastic:changeme@localhost:9260', log: true
 client.transport.logger.formatter = proc do |severity, datetime, progname, msg| "\e[2m#{msg}\e[0m\n" end
 
+# Print information about the Watcher plugin
+#
+cluster_info = client.info
+xpack_info = client.xpack.info
+puts "Elasticsearch #{cluster_info['version']['number']} | X-Pack build [#{xpack_info['build']['hash']}]"
+
 # Delete the Watcher and test indices
 #
 ['test_errors', 'alerts', '.watcher-history-*'].each do |index|
   client.indices.delete index: index, ignore: 404
 end
 
-# Print information about the Watcher plugin
-#
-puts "X-Pack #{client.xpack.info['build']['hash']}"
-
 # Register a new watch
 #
 client.xpack.watcher.put_watch id: 'error_500', body: {
@@ -86,11 +91,10 @@ client.xpack.watcher.put_watch id: 'error_500', body: {
         # Transform the data for the template
         #
         script: {
-          lang: 'painless',
-          inline: "[ 'total': ctx.payload.hits.total, 'hosts': ctx.payload.aggregations.hosts.buckets.collect(bucket -> [ 'host': bucket.key, 'errors': bucket.doc_count ]), 'errors': ctx.payload.hits.hits.collect(d -> d._source) ]"
+          source: "[ 'total': ctx.payload.hits.total, 'hosts': ctx.payload.aggregations.hosts.buckets.collect(bucket -> [ 'host': bucket.key, 'errors': bucket.doc_count ]), 'errors': ctx.payload.hits.hits.collect(d -> d._source) ]"
         }
       },
-      email: { to:        'alerts@example.com',
+      email: { to:        ENV.fetch('ALERT_EMAIL', 'alert@example.com'),
                subject:   '[ALERT] {{ctx.watch_id}}',
                body:      <<-BODY.gsub(/^ {28}/, ''),
                             Received {{ctx.payload.total}} errors in the last 5 minutes.
@@ -111,7 +115,7 @@ client.xpack.watcher.put_watch id: 'error_500', body: {
       transform: {
         script: {
           lang: 'painless',
-          inline: "[ 'watch_id': ctx.watch_id, 'payload': ctx.payload ]"
+          source: "[ 'watch_id': ctx.watch_id, 'payload': ctx.payload ]"
         }
       },
       index: { index: 'alerts', doc_type: 'alert' }
@@ -155,9 +159,14 @@ end; puts "\n"
 # Display information about watch execution
 #
 client.search(index: '.watcher-history-*', q: 'watch_id:error_500', sort: 'trigger_event.triggered_time:asc')['hits']['hits'].each do |r|
-  puts "#{r['_source']['watch_id']} #{r['_source']['state'].upcase} at #{r['_source']['result']['execution_time']}"
+  print "[#{r['_source']['watch_id']}] #{r['_source']['state'].upcase} at #{r['_source']['result']['execution_time']}"
+  if r['_source']['state'] == 'executed'
+    print " > Actions: "
+    print r['_source']['result']['actions'].map { |a| "[#{a['id']}] #{a['status']}#{a['error'] ? ': '+a['error']['type'] : ''}" }.join(', ')
+  end
+  print "\n"
 end
 
 # Delete the watch
 #
-client.xpack.watcher.delete_watch id: 'error_500', master_timeout: '30s', force: true
+client.xpack.watcher.delete_watch id: 'error_500', master_timeout: '30s'

data/lib/elasticsearch/xpack/api/actions/license/delete.rb

@@ -6,7 +6,7 @@ module Elasticsearch
 
           # Delete a license
           #
-          # @see https://www.elastic.co/guide/en/shield/current/license-management.html
+          # @see https://www.elastic.co/guide/en/x-pack/current/license-management.html
           #
           def delete(arguments={})
             method = Elasticsearch::API::HTTP_DELETE

data/lib/elasticsearch/xpack/api/actions/license/get.rb

@@ -8,7 +8,7 @@ module Elasticsearch
           #
           # @option arguments [Boolean] :local Return local information (default: false)
           #
-          # @see https://www.elastic.co/guide/en/shield/current/license-management.html
+          # @see https://www.elastic.co/guide/en/x-pack/current/license-management.html
           #
           def get(arguments={})
             valid_params = [ :local ]

data/lib/elasticsearch/xpack/api/actions/license/post.rb

@@ -10,7 +10,7 @@ module Elasticsearch
           # @option arguments [Boolean] :acknowledge Whether the user has acknowledged acknowledge messages
           #                                          (default: false)
           #
-          # @see https://www.elastic.co/guide/en/shield/current/license-management.html
+          # @see https://www.elastic.co/guide/en/x-pack/current/license-management.html
           #
           def post(arguments={})
             valid_params = [ :acknowledge ]

data/lib/elasticsearch/xpack/api/actions/machine_learning/close_job.rb

@@ -7,14 +7,16 @@ module Elasticsearch
           # TODO: Description
           #
           # @option arguments [String] :job_id The name of the job to close (*Required*)
+          # @option arguments [Boolean] :allow_no_jobs Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
           # @option arguments [Boolean] :force True if the job should be forcefully closed
           # @option arguments [Time] :timeout Controls the time to wait until a job has closed. Default to 30 minutes
           #
-          # @see http://www.elastic.co/guide/en/x-pack/current/ml-close-job.html
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html
           #
           def close_job(arguments={})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
             valid_params = [
+              :allow_no_jobs,
               :force,
               :timeout ]
             method = Elasticsearch::API::HTTP_POST

data/lib/elasticsearch/xpack/api/actions/machine_learning/delete_datafeed.rb

@@ -9,7 +9,7 @@ module Elasticsearch
           # @option arguments [String] :datafeed_id The ID of the datafeed to delete (*Required*)
           # @option arguments [Boolean] :force True if the datafeed should be forcefully deleted
           #
-          # @see http://www.elastic.co/guide/en/x-pack/current/ml-delete-datafeed.html
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-datafeed.html
           #
           def delete_datafeed(arguments={})
             raise ArgumentError, "Required argument 'datafeed_id' missing" unless arguments[:datafeed_id]

data/lib/elasticsearch/xpack/api/actions/machine_learning/delete_expired_data.rb

@@ -4,11 +4,6 @@ module Elasticsearch
       module MachineLearning
         module Actions
 
-          # TODO: Description
-          #
-          #
-          # @see [TODO]
-          #
           def delete_expired_data(arguments={})
             method = Elasticsearch::API::HTTP_DELETE
             path   = "_xpack/ml/_delete_expired_data"

data/lib/elasticsearch/xpack/api/actions/machine_learning/delete_filter.rb

@@ -4,12 +4,8 @@ module Elasticsearch
       module MachineLearning
         module Actions
 
-          # TODO: Description
-          #
           # @option arguments [String] :filter_id The ID of the filter to delete (*Required*)
           #
-          # @see [TODO]
-          #
           def delete_filter(arguments={})
             raise ArgumentError, "Required argument 'filter_id' missing" unless arguments[:filter_id]
             method = Elasticsearch::API::HTTP_DELETE

data/lib/elasticsearch/xpack/api/actions/machine_learning/delete_job.rb

@@ -4,12 +4,12 @@ module Elasticsearch
       module MachineLearning
         module Actions
 
-          # TODO: Description
+          # Delete an existing anomaly detection job
           #
           # @option arguments [String] :job_id The ID of the job to delete (*Required*)
           # @option arguments [Boolean] :force True if the job should be forcefully deleted
           #
-          # @see http://www.elastic.co/guide/en/x-pack/current/ml-delete-job.html
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html
           #
           def delete_job(arguments={})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]

data/lib/elasticsearch/xpack/api/actions/machine_learning/delete_model_snapshot.rb

@@ -4,12 +4,12 @@ module Elasticsearch
       module MachineLearning
         module Actions
 
-          # TODO: Description
+          # Delete an existing model snapshot
           #
           # @option arguments [String] :job_id The ID of the job to fetch (*Required*)
           # @option arguments [String] :snapshot_id The ID of the snapshot to delete (*Required*)
           #
-          # @see http://www.elastic.co/guide/en/x-pack/current/ml-delete-snapshot.html
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html
           #
           def delete_model_snapshot(arguments={})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]

data/lib/elasticsearch/xpack/api/actions/machine_learning/flush_job.rb

@@ -4,7 +4,7 @@ module Elasticsearch
       module MachineLearning
         module Actions
 
-          # TODO: Description
+          # Force any buffered data to be processed by the job
           #
           # @option arguments [String] :job_id The name of the job to flush (*Required*)
           # @option arguments [Hash] :body Flush parameters
@@ -12,8 +12,10 @@ module Elasticsearch
           # @option arguments [String] :start When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results
           # @option arguments [String] :end When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results
           # @option arguments [String] :advance_time Setting this tells the Engine API that no data prior to advance_time is expected
+          # @option arguments [String] :skip_time Skips time to the given value without generating results or updating the model for the skipped interval
           #
-          # @see http://www.elastic.co/guide/en/x-pack/current/ml-flush-job.html
+          #
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html
           #
           def flush_job(arguments={})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
@@ -21,7 +23,8 @@ module Elasticsearch
               :calc_interim,
               :start,
               :end,
-              :advance_time ]
+              :advance_time,
+              :skip_time ]
             method = Elasticsearch::API::HTTP_POST
             path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/_flush"
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params

data/lib/elasticsearch/xpack/api/actions/machine_learning/forecast.rb

@@ -0,0 +1,31 @@
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+
+          # Predict the future behavior of a time series
+          #
+          # @option arguments [String] :job_id The ID of the job to forecast for (*Required*)
+          # @option arguments [Time] :duration The duration of the forecast
+          # @option arguments [Time] :expires_in The time interval after which the forecast expires. Expired forecasts will be deleted at the first opportunity.
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-forecast.html
+          #
+          def forecast(arguments={})
+            raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+            valid_params = [
+              :duration,
+              :expires_in ]
+            method = Elasticsearch::API::HTTP_POST
+            path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/_forecast"
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+            body   = nil
+
+            perform_request(method, path, params, body).body
+          end
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/xpack/api/actions/machine_learning/get_buckets.rb

@@ -4,7 +4,7 @@ module Elasticsearch
       module MachineLearning
         module Actions
 
-          # TODO: Description
+          # Retrieve job results for one or more buckets
           #
           # @option arguments [String] :job_id ID of the job to get bucket results from (*Required*)
           # @option arguments [String] :timestamp The timestamp of the desired single bucket result
@@ -19,7 +19,7 @@ module Elasticsearch
           # @option arguments [String] :sort Sort buckets by a particular field
           # @option arguments [Boolean] :desc Set the sort direction
           #
-          # @see http://www.elastic.co/guide/en/x-pack/current/ml-get-bucket.html
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html
           #
           def get_buckets(arguments={})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]

data/lib/elasticsearch/xpack/api/actions/machine_learning/get_categories.rb

@@ -4,7 +4,7 @@ module Elasticsearch
       module MachineLearning
         module Actions
 
-          # TODO: Description
+          # Retrieve job results for one or more categories
           #
           # @option arguments [String] :job_id The name of the job (*Required*)
           # @option arguments [Long] :category_id The identifier of the category definition of interest
@@ -12,7 +12,7 @@ module Elasticsearch
           # @option arguments [Int] :from skips a number of categories
           # @option arguments [Int] :size specifies a max number of categories to get
           #
-          # @see http://www.elastic.co/guide/en/x-pack/current/ml-get-category.html
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html
           #
           def get_categories(arguments={})
             raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]

data/lib/elasticsearch/xpack/api/actions/machine_learning/get_datafeed_stats.rb

@@ -4,13 +4,17 @@ module Elasticsearch
       module MachineLearning
         module Actions
 
-          # TODO: Description
+          # Retrieve usage information for datafeeds
           #
           # @option arguments [String] :datafeed_id The ID of the datafeeds stats to fetch
+          # @option arguments [Boolean] :allow_no_datafeeds Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)
           #
-          # @see http://www.elastic.co/guide/en/x-pack/current/ml-get-datafeed-stats.html
+          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html
           #
           def get_datafeed_stats(arguments={})
+            valid_params = [
+              :allow_no_datafeeds ]
+
             method = Elasticsearch::API::HTTP_GET
             path   = Elasticsearch::API::Utils.__pathify "_xpack/ml/datafeeds", arguments[:datafeed_id], "/_stats"
             params = {}