wavefront-sdk 3.7.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8a2c03d2fff24c9d9c986c89203a60dd5535d93c5df5018fc7fdb9fcd4a50a8
-  data.tar.gz: 2957c881c681837d8e90f0c83b635a62e59d5806091f74f9861a4561f8422a83
+  metadata.gz: 578159c0ff0dac09b94caa4dac4e37f03436cb3e2b4cdda54886ce91b9ce4c9b
+  data.tar.gz: 93eac0630e97d53e3b26d222fd09df61f8cd7966c62e39520dbf27525982cb1b
 SHA512:
-  metadata.gz: 80ffca53940c2d25cdaf6c5248fa0a5eddcbeeed7fc390d1f79405a2bf55fc9b1981624082891aa994e5e243238a37046ddb470829c5eb1140f37fef4dc6a520
-  data.tar.gz: 4b68cae0043168eba7232296c15916a5d7e872cec758a217e8824e78a6a4945569d7d8d8e030a999b2cfb83aab2636617eb94fda12352c6985ce532a7206b416
+  metadata.gz: e3f09ae6d818b0acc7e81e2e4da585c10a59efba18a4ab373679783d62b5a5ccc300e14435b7cbe8a0f2d64adec361e080c55f089732ffbb6c171f619524440e
+  data.tar.gz: d558a6d0eafe0d09120317113758ee70807cae035a7e9677a22cf643e537103ff66d671e7e6a031151cd03572f6b62a78e9aa92a86a2fb052f0cb31ba92c4f17

data/.rubocop.yml

@@ -4,4 +4,4 @@ AllCops:
   TargetRubyVersion: 2.3
 
 Metrics/ClassLength:
-  Max: 124
+  Max: 150

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.3.8
   - 2.4.9
   - 2.5.7
   - 2.6.5

data/HISTORY.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 4.0.0 (2020-02-17)
+* Drop support for Ruby 2.3. (Breaking change.)
+* Add `Wavefront::MonitoredCluster` class.
+* Add `Wavefront::Unstable::Spy` class to speak to (undocumented) spy
+  interface.
+* Add `Wavefront::Unstable::Chart` class to speak to (undocumented) chart
+  interface.
+
 ## 3.7.1 (2020-02-09)
 * `Response` object returned by `Wavefront::Write#write` includes a valid HTTP
   code, rather than `nil`.

data/README.md

@@ -24,7 +24,7 @@ or to build locally,
 $ gem build wavefront-sdk.gemspec
 ```
 
-`wavefront-sdk` requires Ruby >= 2.3. All its dependencies are pure
+`wavefront-sdk` requires Ruby >= 2.4. All its dependencies are pure
 Ruby, right the way down, so a compiler should never be required to
 install it.
 

data/lib/wavefront-sdk/core/api_caller.rb

@@ -6,6 +6,7 @@ require 'addressable'
 require_relative 'response'
 require_relative '../defs/version'
 require_relative '../support/mixins'
+require_relative '../stdlib/time'
 
 module Wavefront
   #
@@ -78,14 +79,47 @@ module Wavefront
     # was cleaner to add this method. Parameters are same as #get.
     #
     def get_flat_params(path, query = {})
-      conn = mk_conn(path,
-                     {},
-                     request: {
-                       params_encoder: Faraday::FlatParamsEncoder
-                     },
-                     params: query)
+      make_call(flat_param_conn(path, query), :get)
+    end
+
+    # This is used by the Wavefront::Unstable::Spy methods to stream data.
+    # It prints to standard out.
+    # @param path [String] path to be appended to the net[:api_base] path.
+    # @param query [Hash] optional key-value pairs with will be made into a
+    #   query string
+    # @param opts [Hash] keys:
+    #   timestamp_chunks -- prints a timestamp before each chunk of streamed
+    #     data
+    #   timeout -- after approximately this many seconds, return. It will be
+    #     the first chunk *after* the given time
+    # @return
+    #
+    def get_stream(path, query = {}, opts = {})
+      conn = flat_param_conn(path, query)
+      verbosity(conn, :get, query)
+      stream_connection(conn, query, opts)
+    rescue Faraday::TimeoutError
+      raise Wavefront::Exception::NetworkTimeout
+    rescue StopIteration
+      nil
+    end
+
+    def stream_connection(conn, query, opts)
+      t_end = end_time(opts)
+
+      conn.get do |req|
+        req.params = query
+        req.options.on_data = proc do |chunk, _size|
+          raise StopIteration if t_end && Time.right_now >= t_end
 
-      make_call(conn, :get)
+          puts Time.now if opts[:timestamp_chunks]
+          puts chunk
+        end
+      end
+    end
+
+    def end_time(opts)
+      Time.right_now + opts[:timeout] if opts[:timeout]&.positive?
     end
 
     # Make a POST call to the Wavefront API and return the result as
@@ -240,5 +274,14 @@ module Wavefront
         end
       end
     end
+
+    def flat_param_conn(path, query)
+      mk_conn(path,
+              {},
+              request: {
+                params_encoder: Faraday::FlatParamsEncoder
+              },
+              params: query)
+    end
   end
 end

data/lib/wavefront-sdk/core/exception.rb

@@ -28,6 +28,7 @@ module Wavefront
     class InvalidIntegrationId < RuntimeError; end
     class InvalidLinkTemplate < RuntimeError; end
     class InvalidMaintenanceWindowId < RuntimeError; end
+    class InvalidMonitoredClusterId < RuntimeError; end
     class InvalidMessageId < RuntimeError; end
     class InvalidMetricName < RuntimeError; end
     class InvalidMetricValue < RuntimeError; end
@@ -38,6 +39,7 @@ module Wavefront
     class InvalidPrefixLength < RuntimeError; end
     class InvalidProxyId < RuntimeError; end
     class InvalidRelativeTime < RuntimeError; end
+    class InvalidSamplingValue < RuntimeError; end
     class InvalidSavedSearchEntity < RuntimeError; end
     class InvalidSavedSearchId < RuntimeError; end
     class InvalidServiceAccountId < RuntimeError; end
@@ -51,6 +53,7 @@ module Wavefront
     class InvalidUserGroupId < RuntimeError; end
     class InvalidVersion < RuntimeError; end
     class InvalidWebhookId < RuntimeError; end
+    class NetworkTimeout < RuntimeError; end
     class NotImplemented < RuntimeError; end
     class SocketError < RuntimeError; end
     class UnparseableResponse < RuntimeError; end

data/lib/wavefront-sdk/defs/version.rb

@@ -1,6 +1,4 @@
 # frozen_string_literal: true
 
-require 'pathname'
-
-WF_SDK_VERSION = '3.7.1'
+WF_SDK_VERSION = '4.0.0'
 WF_SDK_LOCATION = Pathname.new(__dir__).parent.parent.parent

data/lib/wavefront-sdk/monitoredcluster.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require_relative 'core/api'
+require_relative 'api_mixins/tag'
+
+module Wavefront
+  #
+  # Manage and query Wavefront monitored clusters
+  #
+  class MonitoredCluster < CoreApi
+    include Wavefront::Mixin::Tag
+
+    def update_keys
+      %i[id]
+    end
+
+    # GET /api/v2/monitoredcluster
+    # Get all monitored clusters
+    # @param offset [Integer] cluster at which the list begins
+    # @param limit [Integer] the number of clusters to return
+    # @return [Wavefront::Response]
+    #
+    def list(offset = 0, limit = 100)
+      api.get('', offset: offset, limit: limit)
+    end
+
+    # POST /api/v2/monitoredcluster
+    # Create a specific cluster
+    # @param body [Hash] a hash of parameters describing the cluster.
+    #   Please refer to the Wavefront Swagger docs for key:value
+    #   information
+    # @return [Wavefront::Response]
+    #
+    def create(body)
+      raise ArgumentError unless body.is_a?(Hash)
+
+      api.post('', body, 'application/json')
+    end
+
+    # DELETE /api/v2/monitoredcluster/{id}
+    # Delete a specific cluster
+    # @param id [String, Integer] ID of the maintenance cluster
+    # @return [Wavefront::Response]
+    #
+    def delete(id)
+      wf_monitoredcluster_id?(id)
+      api.delete(id)
+    end
+
+    # GET /api/v2/monitoredcluster/{id}
+    # Get a specific cluster
+    # @param id [String, Integer] ID of the cluster
+    # @return [Wavefront::Response]
+    #
+    def describe(id)
+      wf_monitoredcluster_id?(id)
+      api.get(id)
+    end
+
+    # PUT /api/v2/monitoredcluster/{id}
+    # Update a specific cluster
+    # @return [Wavefront::Response]
+    #
+    def update(id, body, modify = true)
+      wf_monitoredcluster_id?(id)
+      raise ArgumentError unless body.is_a?(Hash)
+
+      return api.put(id, body, 'application/json') unless modify
+
+      api.put(id, hash_for_update(describe(id).response, body),
+              'application/json')
+    end
+
+    # PUT /api/v2/monitoredcluster/merge/{id1}/{id2}
+    # Merge two monitored clusters. The first cluster will remain and the
+    # second cluster will be deleted, with its id added as an alias to the
+    # first cluster.
+    # @param id1 [String, Integer] ID of the target cluster
+    # @param id2 [String, Integer] ID of the other cluster
+    # @return [Wavefront::Response]
+    #
+    def merge(id1, id2)
+      wf_monitoredcluster_id?(id1)
+      wf_monitoredcluster_id?(id2)
+
+      api.put(['merge', id1, id2].uri_concat, nil, 'application/json')
+    end
+
+    def valid_id?(id)
+      wf_monitoredcluster_id?(id)
+    end
+  end
+end

data/lib/wavefront-sdk/stdlib/time.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Extensions to the stdlib Time class
+#
+class Time
+  #
+  # The real hi-res time. See
+  # https://blog.dnsimple.com/2018/03/elapsed-time-with-ruby-the-right-way/
+  #
+  def self.right_now
+    Process.clock_gettime(Process::CLOCK_MONOTONIC)
+  end
+end

data/lib/wavefront-sdk/unstable/README.md

@@ -0,0 +1,4 @@
+The classes in here use undocumented APIs. They are thus subject to
+change or revocation at any time.
+
+Use them at your own risk.

data/lib/wavefront-sdk/unstable/chart.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require_relative '../defs/constants'
+require_relative '../core/api'
+
+module Wavefront
+  module Unstable
+    #
+    # This is an unstable class. Please refer to README.md.
+    #
+    class Chart < CoreApi
+      def all_metrics
+        metrics_under('')
+      end
+
+      # Gets a list of metrics under the given path. This must be done via
+      # recursive calls to the API, so calls can take a while. If you ask for
+      # all your metrics, expect to be waiting some time.
+      #
+      # @return [Wavefront::Response]
+      #
+      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/AbcSize
+      def metrics_under(path, cursor = nil, limit = 100)
+        resp = api.get('metrics/all',
+                       { trie: true, q: path, p: cursor, l: limit }.compact)
+
+        return resp unless resp.ok?
+
+        metrics = resp.response.items
+
+        metrics.each do |m|
+          if m.end_with?('.')
+            metrics += metrics_under(m).response.items
+            metrics.delete(m)
+          end
+        end
+
+        # resp.more_items? doesn't work: we don't get that from this API
+
+        if metrics.size == limit
+          metrics += metrics_under(path, metrics.last, limit).response.items
+        end
+
+        resp.response.items = metrics.sort
+        resp
+      end
+      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/AbcSize
+
+      def api_path
+        '/chart'
+      end
+
+      # We have to try to make the response we get from the API look
+      # like the one we get from the public API. To begin with, it's
+      # nothing like it.
+      #
+      # This method must be public because a #respond_to? looks for
+      # it.
+      #
+      def response_shim(resp, status)
+        { response: parse_response(resp),
+          status: { result: status == 200 ? 'OK' : 'ERROR',
+                    message: extract_api_message(status, resp),
+                    code: status } }.to_json
+      end
+
+      private
+
+      def parse_response(resp)
+        metrics = JSON.parse(resp, symbolize_names: true)[:metrics]
+
+        { items: metrics,
+          offset: 0,
+          limit: metrics.size,
+          totalItems: metrics.size,
+          moreItems: false }
+      rescue JSON::ParserError
+        nil
+      end
+
+      def extract_api_message(_status, resp)
+        resp.match(/^message='(.*)'/)[1]
+      rescue NoMethodError
+        ''
+      end
+    end
+  end
+end

data/lib/wavefront-sdk/unstable/spy.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require_relative '../defs/constants'
+require_relative '../core/api'
+
+module Wavefront
+  module Unstable
+    #
+    # THIS IS AN UNSTABLE CLASS. PLEASE REFER TO README.md.
+    #
+    # Everything about this API is different from the public one. To make it
+    # appear similar we must change various things we normally take for
+    # granted.
+    #
+    # This class is built according to the documentation at
+    # https://docs.wavefront.com/wavefront_monitoring_spy.html
+    #
+    class Spy < CoreApi
+      # https://<cluster>.wavefront.com/api/spy/points
+      # Gets new metric data points that are added to existing time series.
+      # @param sampling [Float] the amount of points to sample, from 0
+      #   (none) to 1 (all)
+      # @param filter [Hash] with the following keys:
+      #   :prefix [String] only list points whose metric name begins with this
+      #     case-sensitive string
+      #   :host [Array] only list points if source name begins with this
+      #     case-sensitive string
+      #   :tag_key [String,Array[String]] only list points with one or more of
+      #     the given points tags
+      # @param options [Hash] with the following keys
+      #   :timestamp [Boolean] prefix each block of streamed data with a
+      #     timestamp
+      #   :timeout [Integer] how many seconds to run the spy. After this time
+      #     the method returns
+      # @raise Wavefront::Exception::InvalidSamplingValue
+      # @return [Nil]
+      #
+      def points(sampling = 0.01, filters = {}, options = {})
+        wf_sampling_value?(sampling)
+        api.get_stream('points', points_filter(sampling, filters), options)
+      end
+
+      # Gets new histograms that are added to existing time series.
+      # @param sampling [Float] see #points
+      # @param filter [Hash] see #points
+      # @param options [Hash] see #points
+      # @raise Wavefront::Exception::InvalidSamplingValue
+      # @return [Nil]
+      #
+      def histograms(sampling = 0.01, filters = {}, options = {})
+        wf_sampling_value?(sampling)
+        api.get_stream('histograms',
+                       histograms_filter(sampling, filters),
+                       options)
+      end
+
+      # https://<cluster>.wavefront.com/api/spy/spans
+      # Gets new spans with existing source names and span tags.
+      # @param sampling [Float] see #points
+      # @param filter [Hash] see #points
+      # @param options [Hash] see #points
+      # @raise Wavefront::Exception::InvalidSamplingValue
+      # @return [Nil]
+      #
+      def spans(sampling = 0.01, filters = {}, options = {})
+        wf_sampling_value?(sampling)
+        api.get_stream('spans', spans_filter(sampling, filters), options)
+      end
+
+      # https://<cluster>.wavefront.com/api/spy/ids
+      # Gets newly allocated IDs that correspond to new metric names, source
+      # names, point tags, or span tags. A new ID generally indicates that a
+      # new time series has been introduced.
+      # @param sampling [Float] see #points
+      # @param filter [Hash] with keys:
+      #   :prefix [String] only list assignments whose metric name begins with
+      #     this case-sensitive string
+      #   :type [String] one of METRIC, SPAN, HOST or STRING
+      # @param options [Hash] see #points
+      #
+      def ids(sampling = 0.01, filters = {}, options = {})
+        wf_sampling_value?(sampling)
+        api.get_stream('ids', ids_filter(sampling, filters), options)
+      end
+
+      def api_path
+        '/api/spy'
+      end
+
+      # We have to try to make the response we get from the API look
+      # like the one we get from the public API. To begin with, it's
+      # nothing like it.
+      #
+      # This method must be public because a #respond_to? looks for
+      # it.
+      #
+      def _response_shim(resp, status)
+        { response: parse_response(resp),
+          status: { result: status == 200 ? 'OK' : 'ERROR',
+                    message: extract_api_message(status, resp),
+                    code: status } }.to_json
+      end
+
+      private
+
+      def points_filter(sampling, filters)
+        { metric: filters.fetch(:prefix, nil),
+          host: filters.fetch(:host, nil),
+          sampling: sampling,
+          pointTagKey: filters.fetch(:tag_key, nil) }.compact
+      end
+
+      def histograms_filter(sampling, filters)
+        { histogram: filters.fetch(:prefix, nil),
+          host: filters.fetch(:host, nil),
+          sampling: sampling,
+          histogramTagKey: filters.fetch(:tag_key, nil) }.compact
+      end
+
+      def spans_filter(sampling, filters)
+        { name: filters.fetch(:prefix, nil),
+          host: filters.fetch(:host, nil),
+          sampling: sampling,
+          spanTagKey: filters.fetch(:tag_key, nil) }.compact
+      end
+
+      def ids_filter(sampling, filters)
+        { name: filters.fetch(:prefix, nil),
+          type: filters.fetch(:type, nil),
+          sampling: sampling }.compact
+      end
+    end
+  end
+end

data/lib/wavefront-sdk/unstable/unstable.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Wavefront
+  #
+  # Placeholder for unstable API classes
+  #
+  module Unstable
+  end
+end

data/lib/wavefront-sdk/validators.rb

@@ -594,6 +594,27 @@ module Wavefront
         raise Wavefront::Exception::InvalidAccountId, id
       end
     end
+
+    # Ensure the given argument is a valid monitored cluster ID
+    # @param id [String]
+    # @raise Wavefront::Exception::InvalidMonitoredClusterId if the ID is not
+    #   valid
+    #
+    def wf_monitoredcluster_id?(id)
+      return true if id.is_a?(String) && id.size < 256 && id =~ /^[a-z0-9\-_]+$/
+
+      raise Wavefront::Exception::InvalidMonitoredClusterId, id
+    end
+
+    # Ensure the given value is a valid sampling rate.
+    # @param rate [Float]
+    # @raise Wavefront::Exception::InvalidSamplingValue
+    #
+    def wf_sampling_value?(value)
+      return true if value.is_a?(Numeric) && value.between?(0, 0.05)
+
+      raise Wavefront::Exception::InvalidSamplingValue, value
+    end
   end
   # rubocop:enable Metrics/ModuleLength
 end

data/lib/wavefront-sdk/write.rb

@@ -113,7 +113,7 @@ module Wavefront
     # @return Wavefront::Response
     #
     def composite_response(responses)
-      result, code = response_codes(responses)
+      result, code = response_results(responses)
 
       summary = { sent: 0, rejected: 0, unsent: 0 }
 
@@ -127,6 +127,14 @@ module Wavefront
       )
     end
 
+    def response_results(responses)
+      if responses.all?(&:ok?)
+        ['OK', 200]
+      else
+        ['ERROR', 400]
+      end
+    end
+
     def manage_conn
       opts[:noauto] ? false : true
     end
@@ -248,13 +256,5 @@ module Wavefront
     rescue LoadError
       raise(Wavefront::Exception::UnsupportedWriter, writer)
     end
-
-    def response_codes(responses)
-      if responses.all?(&:ok?)
-        ['OK', 200]
-      else
-        ['ERROR', 400]
-      end
-    end
   end
 end

data/spec/spec_helper.rb

@@ -23,6 +23,10 @@ class WavefrontTestBase < MiniTest::Test
     "../lib/wavefront-sdk/#{class_basename.downcase}"
   end
 
+  def dummy_response
+    DUMMY_RESPONSE
+  end
+
   private
 
   def setup

data/spec/support/minitest_assertions.rb

@@ -20,7 +20,7 @@ module Minitest
       headers = DEFAULT_HEADERS
       stub_request(:get, uri(api_path))
         .with(headers: headers)
-        .to_return(body: DUMMY_RESPONSE, status: 200)
+        .to_return(body: dummy_response, status: 200)
       yield block
       assert_requested(:get, uri(api_path), headers: headers)
       WebMock.reset!
@@ -39,7 +39,7 @@ module Minitest
       payload = 'null' if payload.nil?
       stub_request(:post, uri(api_path))
         .with(body: payload, headers: headers)
-        .to_return(body: DUMMY_RESPONSE, status: 200)
+        .to_return(body: dummy_response, status: 200)
       yield block
       assert_requested(:post, uri(api_path), headers: headers)
       WebMock.reset!
@@ -58,7 +58,7 @@ module Minitest
       payload = 'null' if payload.nil?
       stub_request(:put, uri(api_path))
         .with(body: payload, headers: headers)
-        .to_return(body: DUMMY_RESPONSE, status: 200)
+        .to_return(body: dummy_response, status: 200)
       yield block
       assert_requested(:put, uri(api_path), headers: headers)
       WebMock.reset!
@@ -72,7 +72,7 @@ module Minitest
       headers = DEFAULT_HEADERS
       stub_request(:delete, uri(api_path))
         .with(headers: headers)
-        .to_return(body: DUMMY_RESPONSE, status: 200)
+        .to_return(body: dummy_response, status: 200)
       yield block
       assert_requested(:delete, uri(api_path), headers: headers)
       WebMock.reset!

data/spec/wavefront-sdk/core/api_caller_spec.rb

@@ -37,6 +37,49 @@ class WavefrontApiCallerTest < MiniTest::Test
     assert_requested(:get, uri, headers: headers)
   end
 
+  def test_get_flat_params
+    query = { rkey: %w[val1 val2 val3], ukey: 36 }
+    uri = "#{uri_base}/path?rkey=val1&rkey=val2&rkey=val3&ukey=36"
+    stub_request(:get, uri).to_return(body: DUMMY_RESPONSE, status: 200)
+    wf.get_flat_params('/path', query)
+    assert_requested(:get, uri, headers: headers)
+  end
+
+  def test_get_stream
+    uri = "#{uri_base}/path?key1=val1"
+    stub_request(:get, uri).to_return(body: DUMMY_RESPONSE, status: 200)
+    out, err = capture_io { wf.get_stream('/path', key1: 'val1') }
+    assert_requested(:get, uri, headers: headers)
+    assert_equal(out.strip, DUMMY_RESPONSE)
+    assert_empty(err)
+  end
+
+  def test_get_stream_array_params
+    uri = "#{uri_base}/path?key=val1&key=val2"
+    stub_request(:get, uri).to_return(body: DUMMY_RESPONSE, status: 200)
+    out, err = capture_io { wf.get_stream('/path', key: %w[val1 val2]) }
+    assert_requested(:get, uri, headers: headers)
+    assert_equal(out.strip, DUMMY_RESPONSE)
+    assert_empty(err)
+  end
+
+  def test_get_stream_timestamp
+    uri = "#{uri_base}/path?key1=val1"
+    stub_request(:get, uri).to_return(body: DUMMY_RESPONSE, status: 200)
+
+    out, err = capture_io do
+      wf.get_stream('/path',
+                    { key1: 'val1' },
+                    timestamp_chunks: true)
+    end
+
+    assert_requested(:get, uri, headers: headers)
+    out_lines = out.split("\n")
+    assert_match(/^\d{4}-\d\d-\d\d \d\d:\d\d:\d\d \+\d{4}$/, out_lines[0])
+    assert_equal(out_lines[1], DUMMY_RESPONSE)
+    assert_empty(err)
+  end
+
   def test_post
     uri = "#{uri_base}/path"
     obj = { key: 'value' }

data/spec/wavefront-sdk/monitoredcluster_spec.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../spec_helper'
+require_relative '../test_mixins/general'
+require_relative '../test_mixins/tag'
+
+# Unit tests for MonitoredCluster class
+#
+class WavefrontMonitoredClusterTest < WavefrontTestBase
+  include WavefrontTest::Create
+  include WavefrontTest::Delete
+  include WavefrontTest::Describe
+  include WavefrontTest::List
+  include WavefrontTest::Update
+  include WavefrontTest::Tag
+
+  def test_merge
+    assert_puts("/api/v2/monitoredcluster/merge/#{id}/#{id2}", nil, :json) do
+      wf.merge(id, id2)
+    end
+
+    assert_invalid_id { wf.merge(id, invalid_id) }
+  end
+
+  private
+
+  def api_class
+    'monitoredcluster'
+  end
+
+  def id
+    'k8s-sample'
+  end
+
+  def id2
+    'eks-cluster'
+  end
+
+  def invalid_id
+    '!!!!'
+  end
+
+  def payload
+    { id: 'k8s-sample',
+      name: 'Sample cluster',
+      platform: 'EKS',
+      version: '1.2',
+      additionalTags: {
+        region: 'us-west-2',
+        az: 'testing'
+      },
+      tags: %w[alertTag1] }
+  end
+end

data/spec/wavefront-sdk/unstable/chart_spec.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../../spec_helper'
+require_relative '../../../lib/wavefront-sdk/unstable/chart'
+
+# Unit tests for Chart class
+#
+class WavefrontChartTest < MiniTest::Test
+  attr_reader :wf
+
+  def setup
+    @wf = Wavefront::Unstable::Chart.new(CREDS)
+  end
+
+  def test_all_metrics
+    assert_gets('/chart/metrics/all?l=100&q=&trie=true') do
+      wf.metrics_under('')
+    end
+  end
+
+  def test_metrics_under
+    assert_gets('/chart/metrics/all?l=100&q=test.path&trie=true') do
+      wf.metrics_under('test.path')
+    end
+
+    assert_gets('/chart/metrics/all?l=10&q=test.path&trie=true') do
+      wf.metrics_under('test.path', nil, 10)
+    end
+
+    assert_gets('/chart/metrics/all?l=100&p=last.one&q=test.path&trie=true') do
+      wf.metrics_under('test.path', 'last.one')
+    end
+  end
+
+  def dummy_response
+    { metrics: ['test data'] }.to_json
+  end
+end

data/spec/wavefront-sdk/unstable/spy_spec.rb

@@ -0,0 +1,113 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../../spec_helper'
+require_relative '../../../lib/wavefront-sdk/unstable/spy'
+
+# Unit tests for Spy class
+#
+class WavefrontSpyTest < MiniTest::Test
+  attr_reader :wf
+
+  def setup
+    @wf = Wavefront::Unstable::Spy.new(CREDS)
+  end
+
+  def test_points
+    capture_io do
+      assert_gets('/api/spy/points?sampling=0.01') { wf.points }
+      assert_gets('/api/spy/points?sampling=0.05') { wf.points(0.05) }
+
+      assert_gets('/api/spy/points?sampling=0.05&metric=my_prefix') do
+        wf.points(0.05, prefix: 'my_prefix')
+      end
+
+      assert_gets('/api/spy/points?sampling=0.05&metric=my_prefix&host=h1') do
+        wf.points(0.05, prefix: 'my_prefix', host: 'h1')
+      end
+
+      assert_gets('/api/spy/points?sampling=0.02&metric=my_prefix&' \
+                  'pointTagKey=mytag') do
+        wf.points(0.02, prefix: 'my_prefix', tag_key: 'mytag')
+      end
+
+      assert_gets('/api/spy/points?sampling=0.02&metric=my_prefix&' \
+                  'pointTagKey=tag1&pointTagKey=tag2') do
+        wf.points(0.02, prefix: 'my_prefix', tag_key: %w[tag1 tag2])
+      end
+    end
+  end
+
+  def test_histograms
+    capture_io do
+      assert_gets('/api/spy/histograms?sampling=0.01') { wf.histograms }
+      assert_gets('/api/spy/histograms?sampling=0.05') { wf.histograms(0.05) }
+
+      assert_gets('/api/spy/histograms?sampling=0.05&histogram=my_prefix') do
+        wf.histograms(0.05, prefix: 'my_prefix')
+      end
+
+      assert_gets(
+        '/api/spy/histograms?sampling=0.05&histogram=my_prefix&host=h1'
+      ) do
+        wf.histograms(0.05, prefix: 'my_prefix', host: 'h1')
+      end
+
+      assert_gets('/api/spy/histograms?sampling=0.02&histogram=my_prefix&' \
+                  'histogramTagKey=the_tag') do
+        wf.histograms(0.02, prefix: 'my_prefix', tag_key: 'the_tag')
+      end
+
+      assert_gets('/api/spy/histograms?sampling=0.02&histogram=my_prefix&' \
+                  'histogramTagKey=tag1&histogramTagKey=tag2') do
+        wf.histograms(0.02, prefix: 'my_prefix', tag_key: %w[tag1 tag2])
+      end
+    end
+  end
+
+  def test_spans
+    capture_io do
+      assert_gets('/api/spy/spans?sampling=0.01') { wf.spans }
+      assert_gets('/api/spy/spans?sampling=0.05') { wf.spans(0.05) }
+
+      assert_gets('/api/spy/spans?sampling=0.05&name=my_prefix') do
+        wf.spans(0.05, prefix: 'my_prefix')
+      end
+
+      assert_gets(
+        '/api/spy/spans?sampling=0.05&name=my_prefix&host=h1'
+      ) do
+        wf.spans(0.05, prefix: 'my_prefix', host: 'h1')
+      end
+
+      assert_gets('/api/spy/spans?sampling=0.02&name=my_prefix&' \
+                  'spanTagKey=the_tag') do
+        wf.spans(0.02, prefix: 'my_prefix', tag_key: 'the_tag')
+      end
+
+      assert_gets('/api/spy/spans?sampling=0.02&name=my_prefix&' \
+                  'spanTagKey=tag1&spanTagKey=tag2') do
+        wf.spans(0.02, prefix: 'my_prefix', tag_key: %w[tag1 tag2])
+      end
+    end
+  end
+
+  def test_ids
+    capture_io do
+      assert_gets('/api/spy/ids?sampling=0.01') { wf.ids }
+      assert_gets('/api/spy/ids?sampling=0.05') { wf.ids(0.05) }
+
+      assert_gets('/api/spy/ids?sampling=0.05&type=METRIC') do
+        wf.ids(0.05, type: 'METRIC')
+      end
+
+      assert_gets('/api/spy/ids?sampling=0.05&type=SPAN&name=my_prefix') do
+        wf.ids(0.05, type: 'SPAN', prefix: 'my_prefix')
+      end
+    end
+  end
+
+  def dummy_response
+    DUMMY_RESPONSE
+  end
+end

data/spec/wavefront-sdk/validators_spec.rb

@@ -386,4 +386,19 @@ class WavefrontValidatorsTest < MiniTest::Test
     bad = ['', [], {}, 'a' * 1000]
     good_and_bad('wf_account_id?', 'InvalidAccountId', good, bad)
   end
+
+  def test_wf_managedcluster_id
+    good = %w[test-cluster other-cluster cluster]
+    bad = ['', [], {}, 'a' * 1000, '£"^WR"!']
+    good_and_bad('wf_monitoredcluster_id?',
+                 'InvalidMonitoredClusterId',
+                 good,
+                 bad)
+  end
+
+  def test_wf_sampling_value
+    good = [0, 0.01, 0.003, 0.05]
+    bad = ['a', 0.1, 0.99, 1, -1, 1.1]
+    good_and_bad('wf_sampling_value?', 'InvalidSamplingValue', good, bad)
+  end
 end

data/wavefront-sdk.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |gem|
   gem.bindir        = 'bin'
 
   gem.add_dependency 'addressable', '~> 2.7'
-  gem.add_dependency 'faraday', '~> 0.17.0'
+  gem.add_dependency 'faraday', '~> 1.0'
   gem.add_dependency 'inifile', '~> 3.0'
   gem.add_dependency 'map', '~> 6.6'
 
@@ -35,5 +35,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'webmock', '~> 3.7'
   gem.add_development_dependency 'yard', '~> 0.9'
 
-  gem.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  gem.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-sdk
 version: !ruby/object:Gem::Version
-  version: 3.7.1
+  version: 4.0.0
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-10 00:00:00.000000000 Z
+date: 2020-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: inifile
   requirement: !ruby/object:Gem::Requirement
@@ -205,6 +205,7 @@ files:
 - lib/wavefront-sdk/message.rb
 - lib/wavefront-sdk/metric.rb
 - lib/wavefront-sdk/metric_helper.rb
+- lib/wavefront-sdk/monitoredcluster.rb
 - lib/wavefront-sdk/notificant.rb
 - lib/wavefront-sdk/paginator/base.rb
 - lib/wavefront-sdk/paginator/delete.rb
@@ -222,9 +223,14 @@ files:
 - lib/wavefront-sdk/stdlib/array.rb
 - lib/wavefront-sdk/stdlib/hash.rb
 - lib/wavefront-sdk/stdlib/string.rb
+- lib/wavefront-sdk/stdlib/time.rb
 - lib/wavefront-sdk/support/mixins.rb
 - lib/wavefront-sdk/support/parse_time.rb
 - lib/wavefront-sdk/types/status.rb
+- lib/wavefront-sdk/unstable/README.md
+- lib/wavefront-sdk/unstable/chart.rb
+- lib/wavefront-sdk/unstable/spy.rb
+- lib/wavefront-sdk/unstable/unstable.rb
 - lib/wavefront-sdk/usage.rb
 - lib/wavefront-sdk/user.rb
 - lib/wavefront-sdk/usergroup.rb
@@ -270,6 +276,7 @@ files:
 - spec/wavefront-sdk/message_spec.rb
 - spec/wavefront-sdk/metric_helper_spec.rb
 - spec/wavefront-sdk/metric_spec.rb
+- spec/wavefront-sdk/monitoredcluster_spec.rb
 - spec/wavefront-sdk/notificant_spec.rb
 - spec/wavefront-sdk/paginator/base_spec.rb
 - spec/wavefront-sdk/paginator/post_spec.rb
@@ -296,6 +303,8 @@ files:
 - spec/wavefront-sdk/stdlib/string_spec.rb
 - spec/wavefront-sdk/support/mixins_spec.rb
 - spec/wavefront-sdk/support/parse_time_spec.rb
+- spec/wavefront-sdk/unstable/chart_spec.rb
+- spec/wavefront-sdk/unstable/spy_spec.rb
 - spec/wavefront-sdk/usage_spec.rb
 - spec/wavefront-sdk/user_spec.rb
 - spec/wavefront-sdk/usergroup_spec.rb
@@ -320,7 +329,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -365,6 +374,7 @@ test_files:
 - spec/wavefront-sdk/message_spec.rb
 - spec/wavefront-sdk/metric_helper_spec.rb
 - spec/wavefront-sdk/metric_spec.rb
+- spec/wavefront-sdk/monitoredcluster_spec.rb
 - spec/wavefront-sdk/notificant_spec.rb
 - spec/wavefront-sdk/paginator/base_spec.rb
 - spec/wavefront-sdk/paginator/post_spec.rb
@@ -391,6 +401,8 @@ test_files:
 - spec/wavefront-sdk/stdlib/string_spec.rb
 - spec/wavefront-sdk/support/mixins_spec.rb
 - spec/wavefront-sdk/support/parse_time_spec.rb
+- spec/wavefront-sdk/unstable/chart_spec.rb
+- spec/wavefront-sdk/unstable/spy_spec.rb
 - spec/wavefront-sdk/usage_spec.rb
 - spec/wavefront-sdk/user_spec.rb
 - spec/wavefront-sdk/usergroup_spec.rb