wavefront-sdk 5.4.1 → 6.0.0

data/lib/wavefront-sdk/metricspolicy.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative 'core/api'
+
+module Wavefront
+  #
+  # Manage and query Wavefront metrics policies
+  #
+  class MetricsPolicy < CoreApi
+    # GET /api/v2/metricspolicy
+    # Get the metrics policy
+    # GET /api/v2/metricspolicy/history/{version}
+    # Get a specific historical version of a metrics policy
+    # @param version [Integer] specify version to describe
+    # @return [Wavefront::Response]
+    #
+    def describe(version = nil)
+      if version
+        wf_version?(version)
+        api.get(['history', version].uri_concat)
+      else
+        api.get('')
+      end
+    end
+
+    # GET /api/v2/metricspolicy/history
+    # Get the version history of metrics policy
+    #
+    # @param offset [Integer] version at which the list begins
+    # @param limit [Integer] the number of versions to return
+    #
+    def history(offset = 0, limit = 100)
+      api.get('', offset: offset, limit: limit)
+    end
+
+    # POST /api/v2/metricspolicy/revert/{version}
+    # Revert to a specific historical version of a metrics policy
+    # @param version [Integer] specify version to describe
+    # @return [Wavefront::Response]
+    #
+    def revert(version)
+      wf_version?(version)
+      api.post(['revert', version].uri_concat)
+    end
+
+    # PUT /api/v2/metricspolicy
+    # Update the metrics policy
+    # @param body [Hash] hash describing metrics policy
+    # @return [Wavefront::Response]
+    #
+    def update(body)
+      raise ArgumentError unless body.is_a?(Hash)
+
+      api.put('', body, 'application/json')
+    end
+  end
+end

data/lib/wavefront-sdk/query.rb

@@ -30,6 +30,7 @@ module Wavefront
     # @raise [ArgumentError] if query is not a string
     # @return [Wavefront::Response]
     #
+    # rubocop:disable Metrics/ParameterLists
     def query(query, granularity = nil, t_start = nil, t_end = nil,
               options = {})
 
@@ -45,6 +46,7 @@ module Wavefront
 
       api.get('api', options)
     end
+    # rubocop:enable Metrics/ParameterLists
 
     # GET /api/v2/chart/raw
     # Perform a raw data query against Wavefront servers that

data/lib/wavefront-sdk/search.rb

@@ -113,6 +113,7 @@ module Wavefront
     #   specified in the body. See the Swagger docs for more
     #   information.
     #
+    # rubocop:disable Metrics/ParameterLists
     def raw_facet_search(entity = nil, body = nil, deleted = false,
                          facet = false)
       raise ArgumentError unless entity.is_a?(String) && body.is_a?(Hash)
@@ -122,5 +123,6 @@ module Wavefront
       path.<< facet || 'facets'
       api.post(path, body, 'application/json')
     end
+    # rubocop:enable Metrics/ParameterLists
   end
 end

data/lib/wavefront-sdk/spy.rb

@@ -32,6 +32,21 @@ module Wavefront
       api.get_stream('points', points_filter(sampling, filters), options)
     end
 
+    # GET /api/spy/deltas
+    # Gets new deltas 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 deltas(sampling = 0.01, filters = {}, options = {})
+      wf_sampling_value?(sampling)
+      api.get_stream('deltas',
+                     deltas_filter(sampling, filters),
+                     options)
+    end
+
     # GET /api/spy/histograms
     # Gets new histograms that are added to existing time series.
     # @param sampling [Float] see #points
@@ -103,6 +118,13 @@ module Wavefront
         pointTagKey: filters.fetch(:tag_key, nil) }.compact
     end
 
+    def deltas_filter(sampling, filters)
+      { counter: filters.fetch(:prefix, nil),
+        host: filters.fetch(:host, nil),
+        sampling: sampling,
+        counterTagKey: filters.fetch(:tag_key, nil) }.compact
+    end
+
     def histograms_filter(sampling, filters)
       { histogram: filters.fetch(:prefix, nil),
         host: filters.fetch(:host, nil),

data/lib/wavefront-sdk/support/parse_time.rb

@@ -58,7 +58,7 @@ module Wavefront
       method = ('parse_time_' + t.class.name.downcase).to_sym
       send(method)
     rescue StandardError
-      raise Wavefront::Exception::InvalidTimestamp
+      raise Wavefront::Exception::InvalidTimestamp, t
     end
   end
 end

data/lib/wavefront-sdk/user.rb

@@ -19,7 +19,7 @@ module Wavefront
 
     def deprecation_warning
       logger.log('Wavefront::User is deprecated and will be removed from the ' \
-               'next major release. Please use Wavefront::Account.', :warn)
+                 'next major release. Please use Wavefront::Account.', :warn)
     end
 
     def post_initialize(_creds, _opts)

data/lib/wavefront-sdk/validators.rb

@@ -48,8 +48,8 @@ module Wavefront
     #
     def wf_metric_name?(metric)
       if metric.is_a?(String) && metric.size < 1024 &&
-         (metric.match(/^#{DELTA}?[\w\-.]+$/) ||
-          metric.match(%r{^"#{DELTA}?[\w\-./,]+"$}))
+         (metric.match(/^#{DELTA}?[\w\-.]+$/o) ||
+          metric.match(%r{^"#{DELTA}?[\w\-./,]+"$}o))
         return true
       end
 
@@ -467,6 +467,9 @@ module Wavefront
       true
     end
 
+    # @
+    def wf_trace?(trace); end
+
     # Validate an array of distribution values
     # @param vals [Array[Array]] [count, value]
     # @return true if valid
@@ -639,6 +642,18 @@ module Wavefront
 
       raise Wavefront::Exception::InvalidAwsExternalId, id
     end
+
+    # Ensure the given argument is a valid Wavefront metrics policy ID
+    # @param id [String] the metrics policy ID to validate
+    # @return true if the role ID is valid
+    # @raise Wavefront::Exception::InvalidMetricsPolicyId if the ID is
+    #   not valid
+    #
+    def wf_metricspolicy_id?(id)
+      return true if uuid?(id)
+
+      raise Wavefront::Exception::InvalidMetricsPolicyId, id
+    end
   end
   # rubocop:enable Metrics/ModuleLength
 end

data/lib/wavefront-sdk/write.rb

@@ -39,7 +39,7 @@ module Wavefront
     #   verbose [Bool]
     #   debug [Bool]
     #   writer [Symbol, String] the name of the writer class to use.
-    #     Defaults to :socket
+    #     Defaults to :proxy
     #   noauto [Bool] if this is false, #write will automatically
     #     open a connection to Wavefront on each invocation. Set
     #     this to true to manually manage the connection.
@@ -62,7 +62,7 @@ module Wavefront
     #
     def defaults
       { tags: nil,
-        writer: :socket,
+        writer: :proxy,
         noop: false,
         novalidate: false,
         noauto: false,
@@ -118,7 +118,7 @@ module Wavefront
       summary = { sent: 0, rejected: 0, unsent: 0 }
 
       %i[sent rejected unsent].each do |k|
-        summary[k] = responses.map { |r| r.response[k] }.inject(:+)
+        summary[k] = responses.sum { |r| r.response[k] }
       end
 
       Wavefront::Response.new(

data/lib/wavefront-sdk/writers/api.rb

@@ -19,12 +19,12 @@ module Wavefront
       end
 
       def validate_credentials(creds)
-        unless creds.key?(:endpoint)
+        unless creds.key?(:endpoint) && creds[:endpoint]
           raise(Wavefront::Exception::CredentialError,
                 'credentials must contain API endpoint')
         end
 
-        return true if creds.key?(:token)
+        return true if creds.key?(:token) && creds[:token]
 
         raise(Wavefront::Exception::CredentialError,
               'credentials must contain API token')

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

@@ -99,7 +99,7 @@ module Wavefront
       #
       def hash_to_wf(point)
         wf_point = calling_class.hash_to_wf(point)
-        logger.log(wf_point, :info)
+        logger.log(wf_point, :debug)
         wf_point
       end
 

data/lib/wavefront-sdk/writers/http.rb

@@ -29,10 +29,10 @@ module Wavefront
       end
 
       def validate_credentials(creds)
-        return true if creds.key?(:proxy)
+        return true if creds.key?(:proxy) && creds[:proxy]
 
         raise(Wavefront::Exception::CredentialError,
-              'credentials must contain proxy')
+              'credentials must contain proxy address')
       end
 
       def chunk_size

data/lib/wavefront-sdk/writers/proxy.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative 'core'
+
+module Wavefront
+  module Writer
+    #
+    # Everything specific to writing points to a Wavefront proxy, in
+    # native Wavefront format, to a socket. (The original and,
+    # once, only way to send points.)
+    #
+    class Proxy < Core
+      # Open a connection to a socket to a Wavefront proxy, putting the
+      # descriptor in instance variable @conn.
+      # @return [TCPSocket]
+      #
+      def open
+        if opts[:noop]
+          logger.log('No-op requested. Not opening connection to proxy.')
+          return true
+        end
+
+        port = creds[:port] || default_port
+        logger.log("Connecting to #{creds[:proxy]}:#{port}.", :debug)
+        open_socket(creds[:proxy], port)
+      end
+
+      # Close the connection described by the @conn instance variable.
+      #
+      def close
+        return if opts[:noop]
+
+        logger.log('Closing connection to proxy.', :debug)
+        conn.close
+      end
+
+      def validate_credentials(creds)
+        return true if creds.key?(:proxy) && creds[:proxy]
+
+        raise(Wavefront::Exception::CredentialError,
+              'credentials must contain proxy address')
+      end
+
+      private
+
+      def open_socket(proxy, port)
+        @conn = TCPSocket.new(proxy, port)
+      rescue StandardError => e
+        logger.log(e, :error)
+        raise Wavefront::Exception::InvalidEndpoint
+      end
+
+      # @param point [String] point or points in native Wavefront format.
+      # @raise [SocketError] if point cannot be written
+      #
+      def _send_point(point)
+        return if opts[:noop]
+
+        conn.puts(point)
+      rescue StandardError
+        raise Wavefront::Exception::SocketError
+      end
+
+      # return [Integer] the port to connect to, if none is supplied
+      #
+      def default_port
+        2878
+      end
+    end
+  end
+end

data/lib/wavefront-sdk/writers/socket.rb

@@ -1,70 +1,58 @@
 # frozen_string_literal: true
 
+require 'socket'
 require_relative 'core'
 
 module Wavefront
   module Writer
     #
-    # Everything specific to writing points to a Wavefront proxy, in
-    # native Wavefront format, to a socket. (The original and,
-    # once, only way to send points.)
+    # Everything specific to writing points to a Unix datagram socket.
     #
     class Socket < Core
-      # Open a socket to a Wavefront proxy, putting the descriptor
-      # in instance variable @conn.
-      # @return [TCPSocket]
+      # Make a connection to a Unix datagram socket, putting the
+      # descriptor in instance variable @conn.
+      # This requires the name of the socket file in creds[:socket]
+      # @return [UnixSocket]
       #
       def open
         if opts[:noop]
-          logger.log('No-op requested. Not opening connection to proxy.')
+          logger.log('No-op requested. Not opening socket connection.')
           return true
         end
 
-        port = creds[:port] || default_port
-        logger.log("Connecting to #{creds[:proxy]}:#{port}.", :debug)
-        open_socket(creds[:proxy], port)
+        logger.log("Connecting to #{creds[:socket]}.", :debug)
+        open_socket(creds[:socket])
       end
 
-      # Close the connection described by the @conn instance variable.
-      #
       def close
         return if opts[:noop]
 
-        logger.log('Closing connection to proxy.', :debug)
+        logger.log('Closing socket connection.', :debug)
         conn.close
       end
 
       def validate_credentials(creds)
-        return true if creds.key?(:proxy)
+        return true if creds.key?(:socket) && creds[:socket]
 
         raise(Wavefront::Exception::CredentialError,
-              'creds must contain proxy address')
+              'credentials must contain socket file path')
       end
 
       private
 
-      def open_socket(proxy, port)
-        @conn = TCPSocket.new(proxy, port)
+      def open_socket(socket)
+        @conn = UNIXSocket.new(socket)
       rescue StandardError => e
         logger.log(e, :error)
         raise Wavefront::Exception::InvalidEndpoint
       end
 
       # @param point [String] point or points in native Wavefront format.
-      # @raise [SocketError] if point cannot be written
       #
       def _send_point(point)
         return if opts[:noop]
 
-        conn.puts(point)
-      rescue StandardError
-        raise Wavefront::Exception::SocketError
-      end
-
-      # return [Integer] the port to connect to, if none is supplied
-      #
-      def default_port
-        2878
+        conn.write(point)
       end
     end
   end

data/spec/.rubocop.yml

@@ -1,23 +1,11 @@
-AllCops:
-  NewCops: enable
+inherit_from:
+  - ../.rubocop.yml
 
 Metrics/AbcSize:
   Max: 64
-
-# Configuration parameters: CountComments.
 Metrics/ClassLength:
   Max: 400
-
-# Configuration parameters: CountComments, ExcludedMethods.
 Metrics/MethodLength:
   Max: 39
-
-# Is nothing sacred?
-Layout/LineLength:
-  Max: 80
-
-Style/StringConcatenation:
-  Enabled: false
-
-Style/OptionalBooleanParameter:
+Naming/VariableNumber:
   Enabled: false

data/spec/constants.rb

@@ -26,7 +26,7 @@ U_ACL_1 = 'someone@example.com'
 U_ACL_2 = 'other@elsewhere.com'
 GRP_ACL = 'f8dc0c14-91a0-4ca9-8a2a-7d47f4db4672'
 
-DEFAULT_HEADERS = { 'Accept': /.*/,
+DEFAULT_HEADERS = { Accept: /.*/,
                     'Accept-Encoding': /.*/,
-                    'Authorization': 'Bearer 0123456789-ABCDEF',
+                    Authorization: 'Bearer 0123456789-ABCDEF',
                     'User-Agent': /wavefront-sdk \d+\.\d+\.\d+/ }.freeze