wavefront-sdk 3.3.3 → 3.3.4

data/lib/wavefront-sdk/usergroup.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'core/api'
 require_relative 'api_mixins/user'
 
@@ -32,6 +34,7 @@ module Wavefront
     #
     def create(body)
       raise ArgumentError unless body.is_a?(Hash)
+
       api.post('', body, 'application/json')
     end
 

data/lib/wavefront-sdk/validators.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'defs/constants'
 require_relative 'core/exception'
 
@@ -63,6 +65,7 @@ module Wavefront
     #
     def wf_name?(name)
       return true if name.is_a?(String) && name.size < 1024 && name =~ /^\w+$/
+
       raise Wavefront::Exception::InvalidName
     end
 
@@ -93,6 +96,7 @@ module Wavefront
     #
     def wf_ts?(timestamp)
       return true if timestamp.is_a?(Time) || timestamp.is_a?(Date)
+
       raise Wavefront::Exception::InvalidTimestamp
     end
 
@@ -107,6 +111,7 @@ module Wavefront
     #
     def wf_ms_ts?(timestamp)
       return true if timestamp.is_a?(Numeric)
+
       raise Wavefront::Exception::InvalidTimestamp
     end
 
@@ -119,6 +124,7 @@ module Wavefront
     #
     def wf_epoch?(timestamp)
       return true if timestamp.is_a?(Numeric)
+
       raise Wavefront::Exception::InvalidTimestamp
     end
 
@@ -150,6 +156,7 @@ module Wavefront
     #
     def wf_value?(value)
       return true if value.is_a?(Numeric)
+
       raise Wavefront::Exception::InvalidMetricValue
     end
 
@@ -163,6 +170,7 @@ module Wavefront
     def wf_version?(version)
       version = version.to_i if version.is_a?(String) && version =~ /^\d+$/
       return true if version.is_a?(Integer) && version.positive?
+
       raise Wavefront::Exception::InvalidVersion
     end
 
@@ -176,6 +184,7 @@ module Wavefront
     #
     def wf_point_tags?(tags)
       raise Wavefront::Exception::InvalidTag unless tags.is_a?(Hash)
+
       tags.each { |k, v| wf_point_tag?(k, v) }
     end
 
@@ -203,6 +212,7 @@ module Wavefront
     #
     def wf_proxy_id?(id)
       return true if uuid?(id)
+
       raise Wavefront::Exception::InvalidProxyId
     end
 
@@ -218,6 +228,7 @@ module Wavefront
     def wf_alert_id?(id)
       id = id.to_s if id.is_a?(Numeric)
       return true if id.is_a?(String) && id.match(/^\d{13}$/)
+
       raise Wavefront::Exception::InvalidAlertId
     end
 
@@ -231,6 +242,7 @@ module Wavefront
     #
     def wf_cloudintegration_id?(id)
       return true if uuid?(id)
+
       raise Wavefront::Exception::InvalidCloudIntegrationId
     end
 
@@ -245,6 +257,7 @@ module Wavefront
     #
     def wf_dashboard_id?(id)
       return true if id.is_a?(String) && id.size < 256 && id.match(/^[\w\-]+$/)
+
       raise Wavefront::Exception::InvalidDashboardId
     end
 
@@ -274,6 +287,7 @@ module Wavefront
     #
     def wf_event_id?(id)
       return true if id.is_a?(String) && id =~ /^\d{13}:.+/
+
       raise Wavefront::Exception::InvalidEventId
     end
 
@@ -286,6 +300,7 @@ module Wavefront
     #
     def wf_link_id?(id)
       return true if id.is_a?(String) && id =~ /^\w{16}$/
+
       raise Wavefront::Exception::InvalidExternalLinkId
     end
 
@@ -312,6 +327,7 @@ module Wavefront
     #
     def wf_alert_severity?(severity)
       return true if %w[INFO SMOKE WARN SEVERE].include?(severity)
+
       raise Wavefront::Exception::InvalidAlertSeverity
     end
 
@@ -323,6 +339,7 @@ module Wavefront
     #
     def wf_message_id?(id)
       return true if id.is_a?(String) && id =~ /^\w+::\w+$/
+
       raise Wavefront::Exception::InvalidMessageId
     end
 
@@ -335,6 +352,7 @@ module Wavefront
     #
     def wf_granularity?(granularity)
       return true if %w[d h m s].include?(granularity.to_s)
+
       raise Wavefront::Exception::InvalidGranularity
     end
 
@@ -346,6 +364,7 @@ module Wavefront
     #
     def wf_savedsearch_id?(id)
       return true if id.is_a?(String) && id =~ /^\w{8}$/
+
       raise Wavefront::Exception::InvalidSavedSearchId
     end
 
@@ -360,6 +379,7 @@ module Wavefront
       return true if %w[DASHBOARD ALERT MAINTENANCE_WINDOW
                         NOTIFICANT EVENT SOURCE EXTERNAL_LINK AGENT
                         CLOUD_INTEGRATION].include?(id)
+
       raise Wavefront::Exception::InvalidSavedSearchEntity
     end
 
@@ -387,6 +407,7 @@ module Wavefront
     #
     def wf_user_id?(user)
       return true if user.is_a?(String) && user.length < 256 && !user.empty?
+
       raise Wavefront::Exception::InvalidUserId
     end
 
@@ -398,6 +419,7 @@ module Wavefront
     #
     def wf_usergroup_id?(gid)
       return true if uuid?(gid)
+
       raise Wavefront::Exception::InvalidUserGroupId
     end
 
@@ -409,6 +431,7 @@ module Wavefront
     #
     def wf_webhook_id?(id)
       return true if id.is_a?(String) && id =~ /^[a-zA-Z0-9]{16}$/
+
       raise Wavefront::Exception::InvalidWebhookId
     end
 
@@ -467,6 +490,7 @@ module Wavefront
     #
     def wf_notificant_id?(id)
       return true if id.is_a?(String) && id =~ /^\w{16}$/
+
       raise Wavefront::Exception::InvalidNotificantId
     end
 
@@ -480,6 +504,7 @@ module Wavefront
     #
     def wf_integration_id?(id)
       return true if id.is_a?(String) && id =~ /^[a-z0-9]+$/
+
       raise Wavefront::Exception::InvalidIntegrationId
     end
 
@@ -490,6 +515,7 @@ module Wavefront
     #
     def wf_distribution_interval?(interval)
       return true if %i[m h d].include?(interval)
+
       raise Wavefront::Exception::InvalidDistributionInterval
     end
 
@@ -500,6 +526,7 @@ module Wavefront
     #
     def wf_distribution_count?(count)
       return true if count.is_a?(Integer) && count.positive?
+
       raise Wavefront::Exception::InvalidDistributionCount
     end
 
@@ -510,6 +537,7 @@ module Wavefront
     #
     def wf_apitoken_id?(id)
       return true if uuid?(id)
+
       raise Wavefront::Exception::InvalidApiTokenId
     end
   end

data/lib/wavefront-sdk/webhook.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'core/api'
 
 module Wavefront
@@ -29,6 +31,7 @@ module Wavefront
     #
     def create(body)
       raise ArgumentError unless body.is_a?(Hash)
+
       api.post('', body, 'application/json')
     end
 

data/lib/wavefront-sdk/write.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'socket'
 require_relative 'core/exception'
 require_relative 'core/logger'
@@ -56,15 +58,16 @@ module Wavefront
       @writer = setup_writer
     end
 
+    # Chunk size gets overriden
+    #
     def defaults
-      { tags:        nil,
-        writer:      :socket,
-        noop:        false,
-        novalidate:  false,
-        noauto:      false,
-        verbose:     false,
-        debug:       false,
-        chunk_size:  1000,
+      { tags: nil,
+        writer: :socket,
+        noop: false,
+        novalidate: false,
+        noauto: false,
+        verbose: false,
+        debug: false,
         chunk_pause: 0 }
     end
 
@@ -94,7 +97,7 @@ module Wavefront
     #   through
     #
     def write(points = [], openclose = manage_conn, prefix = nil)
-      resps = [points].flatten.each_slice(opts[:chunk_size]).map do |chunk|
+      resps = [points].flatten.each_slice(chunk_size).map do |chunk|
         resp = writer.write(chunk, openclose, prefix)
         sleep(opts[:chunk_pause])
         resp
@@ -105,6 +108,8 @@ module Wavefront
 
     # Compound the responses of all chunked writes into one. It will
     # be 'ok' only if *everything* passed.
+    # @param responses [Array[Wavefront::Response]]
+    # @return Wavefront::Response
     #
     def composite_response(responses)
       result = responses.all?(&:ok?) ? 'OK' : 'ERROR'
@@ -115,7 +120,7 @@ module Wavefront
       end
 
       Wavefront::Response.new(
-        { status:   { result: result, message: nil, code: nil },
+        { status: { result: result, message: nil, code: nil },
           response: summary.to_h }.to_json, nil
       )
     end
@@ -189,6 +194,10 @@ module Wavefront
       :wf_point?
     end
 
+    def chunk_size
+      opts[:chunk_size] || writer.chunk_size
+    end
+
     # Convert a validated point to a string conforming to
     # https://community.wavefront.com/docs/DOC-1031.  No validation
     # is done here.
@@ -197,24 +206,30 @@ module Wavefront
     #   the format.
     #
     def hash_to_wf(point)
-      format('%s %s %s source=%s %s %s',
-             *point_array(point)).squeeze(' ').strip
-    rescue StandardError
-      raise Wavefront::Exception::InvalidPoint
+      raise Wavefront::Exception::InvalidMetricName unless point[:path]
+      raise Wavefront::Exception::InvalidMetricValue unless point[:value]
+
+      format('%<path>s %<value>s %<ts>s source=%<source>s %<tags>s %<opttags>s',
+             point_hash(point)).squeeze(' ').strip
     end
 
-    # Make an array which can be used by #hash_to_wf.
-    # @param point [Hash] a hash describing a point. See #write() for
-    #   the format.
-    # @raise
-    #
-    def point_array(point)
-      [point[:path] || raise,
-       point[:value] || raise,
-       point.fetch(:ts, nil),
-       point.fetch(:source, HOSTNAME),
-       point[:tags]&.to_wf_tag,
-       opts[:tags]&.to_wf_tag]
+    def point_hash(point)
+      point.dup.tap do |p|
+        p[:ts] ||= nil
+        p[:source] ||= HOSTNAME
+        p[:tags] = tags_or_nothing(p.fetch(:tags, nil))
+        p[:opttags] = tags_or_nothing(opts.fetch(:tags, nil))
+      end
+    end
+
+    def tags_or_nothing(tags)
+      return nil unless tags
+
+      tags.to_wf_tag
+    end
+
+    def data_format
+      :wavefront
     end
 
     private
@@ -226,8 +241,8 @@ module Wavefront
     def setup_writer
       writer = opts[:writer].to_s
       require_relative File.join('writers', writer)
-      Object.const_get(format('Wavefront::Writer::%s',
-                              writer.capitalize)).new(self)
+      Object.const_get(format('Wavefront::Writer::%<writer_class>s',
+                              writer_class: writer.capitalize)).new(self)
     rescue LoadError
       raise(Wavefront::Exception::UnsupportedWriter, writer)
     end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'core'
 require_relative '../core/api_caller'
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require_relative 'summary'
 require_relative '../core/response'
@@ -68,7 +70,7 @@ module Wavefront
 
       def respond
         Wavefront::Response.new(
-          { status:   { result: summary.result, message: nil, code: nil },
+          { status: { result: summary.result, message: nil, code: nil },
             response: summary.to_h }.to_json, nil, opts
         )
       end
@@ -130,13 +132,28 @@ module Wavefront
              Wavefront::Exception::InvalidTimestamp,
              Wavefront::Exception::InvalidSourceId,
              Wavefront::Exception::InvalidTag => e
-        logger.log('Invalid point, skipping.', :info)
-        logger.log(e.class, :info)
-        logger.log(format('Invalid point: %s (%s)', point, e.to_s), :debug)
+        log_invalid_point(point, e)
         summary.rejected += 1
         false
       end
 
+      def log_invalid_point(rawpoint, exception)
+        logger.log('Invalid point, skipping.', :info)
+        logger.log(exception.class, :info)
+        logger.log(format('Invalid point: %<rawpoint>s (%<message>s)',
+                          rawpoint: rawpoint,
+                          message: exception.to_s), :debug)
+      end
+
+      # We divide metrics up into manageable chunks and send them in
+      # batches. This dictates how large those bundles are. You can
+      # override the value with the chunk_size option
+      # @return [Integer]
+      #
+      def chunk_size
+        1000
+      end
+
       private
 
       def write_loop(points)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'core'
 require_relative '../core/api_caller'
 
@@ -11,8 +13,9 @@ module Wavefront
     #
     class Http < Core
       def open
-        creds[:endpoint] = format('%s:%s', creds[:proxy],
-                                  creds[:port] || default_port)
+        creds[:endpoint] = format('%<proxy>s:%<port>s',
+                                  proxy: creds[:proxy],
+                                  port: creds[:port] || default_port)
         opts[:scheme] = 'http'
         @conn = Wavefront::ApiCaller.new(self, creds, opts)
       end
@@ -32,6 +35,10 @@ module Wavefront
               'credentials must contain proxy')
       end
 
+      def chunk_size
+        100
+      end
+
       private
 
       def _send_point(point)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'core'
 
 module Wavefront
@@ -12,7 +14,6 @@ module Wavefront
       # in instance variable @conn.
       # @return [TCPSocket]
       #
-      # rubocop:disable Metrics/AbcSize
       def open
         if opts[:noop]
           logger.log('No-op requested. Not opening connection to proxy.')
@@ -21,15 +22,8 @@ module Wavefront
 
         port = creds[:port] || default_port
         logger.log("Connecting to #{creds[:proxy]}:#{port}.", :debug)
-
-        begin
-          @conn = TCPSocket.new(creds[:proxy], port)
-        rescue StandardError => e
-          logger.log(e, :error)
-          raise Wavefront::Exception::InvalidEndpoint
-        end
+        open_socket(creds[:proxy], port)
       end
-      # rubocop:enable Metrics/AbcSize
 
       # Close the connection described by the @conn instance variable.
       #
@@ -49,11 +43,19 @@ module Wavefront
 
       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