wavefront-sdk 3.7.1 → 5.2.0

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 = '5.2.0'
 WF_SDK_LOCATION = Pathname.new(__dir__).parent.parent.parent

data/lib/wavefront-sdk/paginator/base.rb

@@ -5,23 +5,29 @@ require_relative '../defs/constants'
 module Wavefront
   module Paginator
     #
-    # Automatically handle pagination. This is an abstract class
-    # made concrete by an extension for each HTTP request type.
+    # Automatically handle pagination. This is an abstract class made concrete
+    # by an extension for each HTTP request type.
     #
-    # This class and its children do slightly unpleasant things with
-    # the HTTP request passed to us by the user, extracting and
-    # changing values in the URI, query string, or POST/PUT body.
-    # The POST class is particularly onerous.
+    # This class and its children do slightly unpleasant things with the HTTP
+    # request passed to us by the user, extracting and changing values in the
+    # URI, query string, or POST/PUT body.  The POST class is particularly
+    # onerous.
     #
-    # Automatic pagination works by letting the user override the
-    # limit and offset values in API calls. Setting the limit to
-    # :all iteratively calls the Wavefront API, returning all
-    # requested objects an a standard Wavefront::Response wrapper;
-    # setting limit to :lazy returns a lazy Enumerable. The number
-    # of objects fetched in each API call, whether eager or lazy
-    # defaults to PAGE_SIZE, but the user can override that value by
-    # using the offset argument in conjunction with limit = :lazy |
-    # :all.
+    # Automatic pagination works by letting the user override the limit and
+    # offset values in API calls.
+    #
+    # * Calling with limit = :all iteratively calls the Wavefront API,
+    # returning all requested objects in a standard Wavefront::Response
+    # wrapper.
+    #
+    # * Calling with limit = :lazy returns a lazy Enumerable.
+    #
+    # The number of objects fetched in each API call, eager or lazy, defaults
+    # to PAGE_SIZE, but the user can override that value by using the offset
+    # argument in conjunction with limit = :lazy | :all.
+    #
+    # So, for example, to fetch all objects in blocks of ten (which could
+    # require a lot of API calls) you would use { limit: :all, offset: 10 }
     #
     class Base
       attr_reader :api_caller, :conn, :method, :args, :page_size,

data/lib/wavefront-sdk/query.rb

@@ -43,7 +43,6 @@ module Wavefront
       options[:s] = parse_time(t_start, true)
       options[:e] = parse_time(t_end, true) if t_end
 
-      options.delete_if { |k, v| v == false && k != :i }
       api.get('api', options)
     end
 

data/lib/wavefront-sdk/role.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require_relative 'core/api'
+require_relative 'api_mixins/user'
+
+module Wavefront
+  #
+  # Manage and query Wavefront roles
+  #
+  class Role < CoreApi
+    include Wavefront::Mixin::User
+
+    def update_keys
+      %i[id name description]
+    end
+
+    # GET /api/v2/role
+    # Get all roles for a customer
+    # @param offset [Int] alert at which the list begins
+    # @param limit [Int] the number of alerts to return
+    # @return [Wavefront::Response]
+    #
+    def list(offset = 0, limit = 100)
+      api.get('', offset: offset, limit: limit)
+    end
+
+    # POST /api/v2/role
+    # Create a specific role
+    # @param body [Hash] a hash of parameters describing the role.  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/role/{id}
+    # Delete a specific role
+    # @param id [String] ID of the role
+    # @return [Wavefront::Response]
+    #
+    def delete(id)
+      wf_role_id?(id)
+      api.delete(id)
+    end
+
+    # GET /api/v2/role/{id}
+    # Get a specific role
+    # @param id [String] ID of the role
+    # @return [Wavefront::Response]
+    #
+    def describe(id)
+      wf_role_id?(id)
+      api.get(id)
+    end
+
+    # PUT /api/v2/role/{id}
+    # Update a specific role
+    # @param id [String] role ID
+    # @param body [Hash] key-value hash of the parameters you wish to change
+    # @param modify [true, false] if true, use {#describe()} to get a hash
+    #   describing the existing object, and modify that with the new body. If
+    #   false, pass the new body straight through.
+    # @return [Wavefront::Response]
+    #
+    def update(id, body, modify = true)
+      wf_role_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
+
+    # POST /api/v2/role/{id}/addAssignees
+    # Add multiple users and user groups to a specific role
+    # @param id [String] role ID
+    # @param assignees [Array[String]] list of roles or accounts to be added
+    # @return [Wavefront::Response]
+    #
+    def add_assignees(id, assignees)
+      wf_role_id?(id)
+      validate_user_list(assignees)
+      api.post([id, 'addAssignees'].uri_concat, assignees, 'application/json')
+    end
+
+    # POST /api/v2/role/{id}/removeAssignees
+    # Remove multiple users and user groups from a specific role
+    # @param id [String] role ID
+    # @param assignees [Array[String]] list of roles or accounts to be removed
+    # @return [Wavefront::Response]
+    #
+    def remove_assignees(id, assignees)
+      wf_role_id?(id)
+      validate_user_list(assignees)
+      api.post([id, 'removeAssignees'].uri_concat,
+               assignees,
+               'application/json')
+    end
+
+    # POST /api/v2/role/grant/{permission}
+    # Grants a single permission to role(s)
+    # @param permission [String] permission to grant
+    # @param roles [Array[String]] list of roles to receive permission
+    # @return [Wavefront::Response]
+    #
+    def grant(permission, roles)
+      wf_permission?(permission)
+      validate_role_list(roles)
+      api.post(['grant', permission].uri_concat, roles, 'application/json')
+    end
+
+    # POST /api/v2/role/revoke/{permission}
+    # Revokes a single permission from role(s)
+    # @param permission [String] permission to revoke
+    # @param roles [Array[String]] list of roles to lose permission
+    # @return [Wavefront::Response]
+    #
+    def revoke(permission, roles)
+      wf_permission?(permission)
+      validate_role_list(roles)
+      api.post(['revoke', permission].uri_concat, roles, 'application/json')
+    end
+  end
+end

data/lib/wavefront-sdk/spy.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require_relative 'defs/constants'
+require_relative 'core/api'
+
+module Wavefront
+  #
+  # Spy on data going into Wavefront
+  #
+  class Spy < CoreApi
+    # GET /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
+
+    # GET /api/spy/histograms
+    # 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
+
+    # GET /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
+
+    # GET /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

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

@@ -11,6 +11,6 @@ class Array
   # @return [String] a URI path
   #
   def uri_concat
-    join('/').squeeze('/').sub(%r{\/$}, '').sub(%r{\/\?}, '?')
+    join('/').squeeze('/').sub(%r{/$}, '').sub(%r{/\?}, '?')
   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/unstable.rb

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