wavefront-sdk 1.6.2 → 2.0.0

data/lib/wavefront-sdk/credentials.rb

@@ -15,7 +15,7 @@ module Wavefront
   #   @return [Map] information for speaking to a Wavefront proxy
   #
   class Credentials
-    attr_reader :opts, :config, :creds, :proxy
+    attr_reader :opts, :config, :creds, :proxy, :all
 
     # Gives you an object of credentials and options for speaking to
     # Wavefront. It will look in the following places:
@@ -57,8 +57,11 @@ module Wavefront
     #
     def populate(raw)
       @config = Map(raw)
-      @creds = Map(raw.select { |k, _v| %i[endpoint token].include?(k) })
-      @proxy = Map(raw.select { |k, _v| %i[proxy port].include?(k) })
+      @creds  = Map(raw.select { |k, _v| %i[endpoint token].include?(k) })
+      @proxy  = Map(raw.select { |k, _v| %i[proxy port].include?(k) })
+      @all    = Map(raw.select do |k, _v|
+        %i[proxy port endpoint token].include?(k)
+      end)
     end
 
     # @return [Array] a list of possible credential files

data/lib/wavefront-sdk/dashboard.rb

@@ -1,10 +1,10 @@
-require_relative 'base'
+require_relative 'core/api'
 
 module Wavefront
   #
   # View and manage dashboards.
   #
-  class Dashboard < Base
+  class Dashboard < CoreApi
     def update_keys
       %i[id name url description sections]
     end
@@ -17,7 +17,7 @@ module Wavefront
     # @return [Wavefront::Response]
     #
     def list(offset = 0, limit = 100)
-      api_get('', offset: offset, limit: limit)
+      api.get('', offset: offset, limit: limit)
     end
 
     # POST /api/v2/dashboard
@@ -29,7 +29,7 @@ module Wavefront
     #
     def create(body)
       raise ArgumentError unless body.is_a?(Hash)
-      api_post('', body, 'application/json')
+      api.post('', body, 'application/json')
     end
 
     # DELETE /api/v2/dashboard/id
@@ -43,7 +43,7 @@ module Wavefront
     #
     def delete(id)
       wf_dashboard_id?(id)
-      api_delete(id)
+      api.delete(id)
     end
 
     # GET /api/v2/dashboard/id
@@ -59,7 +59,7 @@ module Wavefront
       wf_version?(version) if version
       fragments = [id]
       fragments += ['history', version] if version
-      api_get(fragments.uri_concat)
+      api.get(fragments.uri_concat)
     end
 
     # PUT /api/v2/dashboard/id
@@ -77,9 +77,9 @@ module Wavefront
       wf_dashboard_id?(id)
       raise ArgumentError unless body.is_a?(Hash)
 
-      return api_put(id, body, 'application/json') unless modify
+      return api.put(id, body, 'application/json') unless modify
 
-      api_put(id, hash_for_update(describe(id).response, body),
+      api.put(id, hash_for_update(describe(id).response, body),
               'application/json')
     end
 
@@ -91,7 +91,7 @@ module Wavefront
     #
     def history(id)
       wf_dashboard_id?(id)
-      api_get([id, 'history'].uri_concat)
+      api.get([id, 'history'].uri_concat)
     end
 
     # GET /api/v2/dashboard/id/tag
@@ -102,7 +102,7 @@ module Wavefront
     #
     def tags(id)
       wf_dashboard_id?(id)
-      api_get([id, 'tag'].uri_concat)
+      api.get([id, 'tag'].uri_concat)
     end
 
     # POST /api/v2/dashboard/id/tag
@@ -116,7 +116,7 @@ module Wavefront
       wf_dashboard_id?(id)
       tags = Array(tags)
       tags.each { |t| wf_string?(t) }
-      api_post([id, 'tag'].uri_concat, tags.to_json, 'application/json')
+      api.post([id, 'tag'].uri_concat, tags.to_json, 'application/json')
     end
 
     # DELETE /api/v2/dashboard/id/tag/tagValue
@@ -129,7 +129,7 @@ module Wavefront
     def tag_delete(id, tag)
       wf_dashboard_id?(id)
       wf_string?(tag)
-      api_delete([id, 'tag', tag].uri_concat)
+      api.delete([id, 'tag', tag].uri_concat)
     end
 
     # PUT /api/v2/dashboard/id/tag/tagValue
@@ -142,7 +142,7 @@ module Wavefront
     def tag_add(id, tag)
       wf_dashboard_id?(id)
       wf_string?(tag)
-      api_put([id, 'tag', tag].uri_concat)
+      api.put([id, 'tag', tag].uri_concat)
     end
 
     # POST /api/v2/dashboard/id/undelete
@@ -153,7 +153,7 @@ module Wavefront
     #
     def undelete(id)
       wf_dashboard_id?(id)
-      api_post([id, 'undelete'].uri_concat)
+      api.post([id, 'undelete'].uri_concat)
     end
   end
 end

data/lib/wavefront-sdk/{constants.rb → defs/constants.rb}

@@ -1,3 +1,4 @@
 # Constants
 #
 DELTA = "\u2206".freeze # "Increment" -- alt-J on a Mac
+PAGE_SIZE = 999

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

@@ -0,0 +1 @@
+WF_SDK_VERSION = '2.0.0'.freeze

data/lib/wavefront-sdk/derivedmetric.rb

@@ -1,10 +1,10 @@
-require_relative 'base'
+require_relative 'core/api'
 
 module Wavefront
   #
   # View and manage derived metrics
   #
-  class DerivedMetric < Base
+  class DerivedMetric < CoreApi
     def update_keys
       # %i[id name url description sections]
     end
@@ -17,7 +17,7 @@ module Wavefront
     # @return [Wavefront::Response]
     #
     def list(offset = 0, limit = 100)
-      api_get('', offset: offset, limit: limit)
+      api.get('', offset: offset, limit: limit)
     end
 
     # POST /api/v2/derivedmetric
@@ -29,7 +29,7 @@ module Wavefront
     #
     def create(body)
       raise ArgumentError unless body.is_a?(Hash)
-      api_post('', body, 'application/json')
+      api.post('', body, 'application/json')
     end
 
     # DELETE /api/v2/derivedmetric/id
@@ -43,7 +43,7 @@ module Wavefront
     #
     def delete(id)
       wf_derivedmetric_id?(id)
-      api_delete(id)
+      api.delete(id)
     end
 
     # GET /api/v2/derivedmetric/id
@@ -59,7 +59,7 @@ module Wavefront
       wf_version?(version) if version
       fragments = [id]
       fragments += ['history', version] if version
-      api_get(fragments.uri_concat)
+      api.get(fragments.uri_concat)
     end
 
     # PUT /api/v2/derivedmetric/id
@@ -77,9 +77,9 @@ module Wavefront
       wf_derivedmetric_id?(id)
       raise ArgumentError unless body.is_a?(Hash)
 
-      return api_put(id, body, 'application/json') unless modify
+      return api.put(id, body, 'application/json') unless modify
 
-      api_put(id, hash_for_update(describe(id).response, body),
+      api.put(id, hash_for_update(describe(id).response, body),
               'application/json')
     end
 
@@ -91,7 +91,7 @@ module Wavefront
     #
     def history(id)
       wf_derivedmetric_id?(id)
-      api_get([id, 'history'].uri_concat)
+      api.get([id, 'history'].uri_concat)
     end
 
     # GET /api/v2/derivedmetric/id/tag
@@ -103,7 +103,7 @@ module Wavefront
     #
     def tags(id)
       wf_derivedmetric_id?(id)
-      api_get([id, 'tag'].uri_concat)
+      api.get([id, 'tag'].uri_concat)
     end
 
     # POST /api/v2/derivedmetric/id/tag
@@ -118,7 +118,7 @@ module Wavefront
       wf_derivedmetric_id?(id)
       tags = Array(tags)
       tags.each { |t| wf_string?(t) }
-      api_post([id, 'tag'].uri_concat, tags.to_json, 'application/json')
+      api.post([id, 'tag'].uri_concat, tags.to_json, 'application/json')
     end
 
     # DELETE /api/v2/derivedmetric/id/tag/tagValue
@@ -131,7 +131,7 @@ module Wavefront
     def tag_delete(id, tag)
       wf_derivedmetric_id?(id)
       wf_string?(tag)
-      api_delete([id, 'tag', tag].uri_concat)
+      api.delete([id, 'tag', tag].uri_concat)
     end
 
     # PUT /api/v2/derivedmetric/id/tag/tagValue
@@ -144,7 +144,7 @@ module Wavefront
     def tag_add(id, tag)
       wf_derivedmetric_id?(id)
       wf_string?(tag)
-      api_put([id, 'tag', tag].uri_concat)
+      api.put([id, 'tag', tag].uri_concat)
     end
 
     # POST /api/v2/derivedmetric/id/undelete
@@ -156,7 +156,7 @@ module Wavefront
     #
     def undelete(id)
       wf_derivedmetric_id?(id)
-      api_post([id, 'undelete'].uri_concat)
+      api.post([id, 'undelete'].uri_concat)
     end
   end
 end

data/lib/wavefront-sdk/distribution.rb

@@ -0,0 +1,75 @@
+require_relative 'write'
+require_relative 'support/mixins'
+
+module Wavefront
+  #
+  # Help a user write histogram distributions to a Wavefront proxy
+  #
+  class Distribution < Write
+    include Wavefront::Mixins
+
+    # Make a distribution from a lot of numbers. The returned
+    # distribution is an array of arrays ready for dropping into
+    # #write. If you need a "real" Wavefront representation of the
+    # distribution, use #mk_wf_distribution.
+    # @param args [String, Array] numbers. Can be multiple
+    #   arguments, a whitespace-separated string, or one or more
+    #   arrays.
+    # @return [Array[Array]] of the form [[1, 3], [4, 5]...]
+    #
+    def mk_distribution(*args)
+      flat = args.flatten
+      raw = flat.first.is_a?(String) ? flat.first.split : flat
+
+      hash = raw.each_with_object(Hash.new(0)) do |v, sum|
+        sum[v] += 1
+        sum
+      end
+
+      hash.to_a.map { |a, b| [b, a.to_f] }
+    end
+
+    def mk_wf_distribution(*args)
+      array2dist(mk_distribution(args))
+    end
+
+    def validation
+      :wf_distribution?
+    end
+
+    def default_port
+      40000
+    end
+
+    # Convert a validated point to a string conforming to
+    # https://docs.wavefront.com/proxies_histograms.html. No
+    # validation is done here.
+    #
+    # @param point [Hash] a hash describing a distribution. See
+    #   #write() for the format.
+    #
+    # rubocop:disable Metrics/AbcSize
+    def hash_to_wf(dist)
+      logger.log("writer subclass #{writer}", :debug)
+      format('!%s %i %s %s source=%s %s %s',
+             dist[:interval].to_s.upcase || raise,
+             parse_time(dist.fetch(:ts, Time.now)),
+             array2dist(dist[:value]),
+             dist[:path] || raise,
+             dist.fetch(:source, HOSTNAME),
+             dist[:tags] && dist[:tags].to_wf_tag,
+             opts[:tags] && opts[:tags].to_wf_tag).squeeze(' ').strip
+    rescue StandardError => e
+      puts e
+      raise Wavefront::Exception::InvalidDistribution
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    # Turn an array of arrays into a the values part of a distribution
+    # @return [String]
+    #
+    def array2dist(values)
+      values.map { |x, v| format('#%i %s', x, v) }.join(' ')
+    end
+  end
+end

data/lib/wavefront-sdk/event.rb

@@ -1,11 +1,11 @@
-require_relative 'base'
+require_relative 'core/api'
 
 module Wavefront
   #
   # View and manage events. Events are identified by their millisecond
   # epoch timestamp.
   #
-  class Event < Base
+  class Event < CoreApi
     def update_keys
       %i[startTime endTime name annotations]
     end
@@ -38,7 +38,7 @@ module Wavefront
                cursor:                       cursor,
                limit:                        limit }
 
-      api_get('', body.cleanse)
+      api.get('', body.cleanse)
     end
 
     # POST /api/v2/event
@@ -53,7 +53,7 @@ module Wavefront
     #
     def create(body)
       raise ArgumentError unless body.is_a?(Hash)
-      api_post('', body, 'application/json')
+      api.post('', body, 'application/json')
     end
 
     # DELETE /api/v2/event/id
@@ -64,7 +64,7 @@ module Wavefront
     #
     def delete(id)
       wf_event_id?(id)
-      api_delete(id)
+      api.delete(id)
     end
 
     # GET /api/v2/event/id
@@ -80,7 +80,7 @@ module Wavefront
       wf_version?(version) if version
       fragments = [id]
       fragments += ['history', version] if version
-      api_get(fragments.uri_concat)
+      api.get(fragments.uri_concat)
     end
 
     # PUT /api/v2/event/id
@@ -100,9 +100,9 @@ module Wavefront
       wf_event_id?(id)
       raise ArgumentError unless body.is_a?(Hash)
 
-      return api_put(id, body, 'application/json') unless modify
+      return api.put(id, body, 'application/json') unless modify
 
-      api_put(id, hash_for_update(describe(id), body), 'application/json')
+      api.put(id, hash_for_update(describe(id), body), 'application/json')
     end
 
     # POST /api/v2/event/id/close
@@ -112,7 +112,7 @@ module Wavefront
     #
     def close(id)
       wf_event_id?(id)
-      api_post([id, 'close'].uri_concat)
+      api.post([id, 'close'].uri_concat)
     end
 
     # GET /api/v2/event/id/tag
@@ -124,7 +124,7 @@ module Wavefront
     #
     def tags(id)
       wf_event_id?(id)
-      api_get([id, 'tag'].uri_concat)
+      api.get([id, 'tag'].uri_concat)
     end
 
     # POST /api/v2/event/id/tag
@@ -139,7 +139,7 @@ module Wavefront
       wf_event_id?(id)
       tags = Array(tags)
       tags.each { |t| wf_string?(t) }
-      api_post([id, 'tag'].uri_concat, tags, 'application/json')
+      api.post([id, 'tag'].uri_concat, tags, 'application/json')
     end
 
     # DELETE /api/v2/event/id/tag/tagValue
@@ -152,7 +152,7 @@ module Wavefront
     def tag_delete(id, tag)
       wf_event_id?(id)
       wf_string?(tag)
-      api_delete([id, 'tag', tag].uri_concat)
+      api.delete([id, 'tag', tag].uri_concat)
     end
 
     # PUT /api/v2/event/id/tag/tagValue
@@ -165,7 +165,7 @@ module Wavefront
     def tag_add(id, tag)
       wf_event_id?(id)
       wf_string?(tag)
-      api_put([id, 'tag', tag].uri_concat)
+      api.put([id, 'tag', tag].uri_concat)
     end
   end
 end

data/lib/wavefront-sdk/externallink.rb

@@ -1,10 +1,10 @@
-require_relative 'base'
+require_relative 'core/api'
 
 module Wavefront
   #
   # Manage and query Wavefront external links.
   #
-  class ExternalLink < Base
+  class ExternalLink < CoreApi
     def api_base
       '/extlink'
     end
@@ -21,7 +21,7 @@ module Wavefront
     # @param limit [Int] the number of link to return
     #
     def list(offset = 0, limit = 100)
-      api_get('', offset: offset, limit: limit)
+      api.get('', offset: offset, limit: limit)
     end
 
     # POST /api/v2/extlink
@@ -32,7 +32,7 @@ module Wavefront
     #
     def create(body)
       raise ArgumentError unless body.is_a?(Hash)
-      api_post('', body, 'application/json')
+      api.post('', body, 'application/json')
     end
 
     # DELETE /api/v2/extlink/id
@@ -43,7 +43,7 @@ module Wavefront
     #
     def delete(id)
       wf_link_id?(id)
-      api_delete(id)
+      api.delete(id)
     end
 
     # GET /api/v2/extlink/id
@@ -54,7 +54,7 @@ module Wavefront
     #
     def describe(id)
       wf_link_id?(id)
-      api_get(id)
+      api.get(id)
     end
 
     # PUT /api/v2/extlink/id
@@ -72,9 +72,9 @@ module Wavefront
       wf_link_id?(id)
       raise ArgumentError unless body.is_a?(Hash)
 
-      return api_put(id, body, 'application/json') unless modify
+      return api.put(id, body, 'application/json') unless modify
 
-      api_put(id, hash_for_update(describe(id).response, body),
+      api.put(id, hash_for_update(describe(id).response, body),
               'application/json')
     end
   end