wavefront-sdk 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0952995059b2df5a2e5cb7397196778b71980772aab6d1dde45159bba1ab2df6
-  data.tar.gz: 59c74424a6a87e417048ba9a39c4a933e499dbfad5ed07a5bc94720847fe113d
+  metadata.gz: b87526142545d12d92b9772ceaf89a740b3c1ebdc0ffc43917721bc07052afdf
+  data.tar.gz: 0a57d859684bd0041a40aaeb28460191472cc1d972453525b5d5619fdea315fe
 SHA512:
-  metadata.gz: b91d2f04af892dade0a9884bb7d2dca7e21dd9b9eae2406c4035dcb1e36d38232d773805acf2ca87716cb04e7a188b239e7d964d082ba9eea4006738b91ff41e
-  data.tar.gz: ffba7fc41db91a7ab163db580540c127b139d545daff17c9a6af0347b0ec55d5c9c4cd81f3d6231efa0d6782a228962ca4c04eaca27b859ce1dbf1a44aad0487
+  metadata.gz: b06e5be378442d4e9b079e6f9989f1d03bbc91336a8b9c75ea41175e2f3663a6f9a27a9457554b99259ef7d2fbef81bf7295bf24f4e5c9f40833f399bfafe64f
+  data.tar.gz: 93a03c4bd635bcff93015b811027a739231d773467778a547a29f429044cc1433bfac3b0b1cc76286d2d6087e526b4707161bd6352806de781dea008b3eb61c0

data/README.md

@@ -94,9 +94,12 @@ Wavefront::Query.new(CREDS).query(
 )
 ```
 
-We can write points too, assuming we have access to a proxy, because
-you can't write points directly via the API. Unlike all other classes, this
-one requires the proxy address and port as its credential hash.
+We can write points too. The `Write` class lets you send points to a
+proxy, and the `Report` class sends them directly via the API.
+Unlike all other classes, `Write` requires the proxy address and
+port as its credential hash. `Report` has the same methods and works
+in the same way, but uses the same credentials as all the other
+classes.
 
 ```ruby
 require 'wavefront-sdk/write'
@@ -113,6 +116,9 @@ puts task.status.result
 #OK
 ```
 
+You can send delta metrics either by manually prefixing your metric
+path with a delta symbol, or by using the `write_delta()` method
+
 The SDK also provides a helper class for extracting credentials from a
 configuration file. If you don't supply a file, defaults will be
 used.

data/lib/wavefront-sdk/base.rb

@@ -228,6 +228,10 @@ module Wavefront
       end.lazy
     end
 
+    def api_path
+      ['', 'api', 'v2', api_base].uri_concat
+    end
+
     private
 
     # Try to describe the actual HTTP calls we make. There's a bit
@@ -269,7 +273,7 @@ module Wavefront
       @net = { headers:  { 'Authorization': "Bearer #{creds[:token]}",
                            'user-agent':    creds[:agent] },
                endpoint: creds[:endpoint],
-               api_base: ['', 'api', 'v2', api_base].uri_concat }
+               api_base: api_path }
     end
   end
 end

data/lib/wavefront-sdk/base_write.rb

@@ -0,0 +1,186 @@
+require 'socket'
+require_relative './constants'
+require_relative './base'
+
+HOSTNAME = Socket.gethostname.freeze
+
+module Wavefront
+  #
+  # This class helps you send points to Wavefront. It is extended by
+  # the Write and Report classes, which respectively handle point
+  # ingestion by a proxy and directly to the API.
+  #
+  class BaseWrite < Base
+    attr_reader :sock, :summary
+
+    # Construct an object which allows us to write points to a
+    # Wavefront proxy.
+    #
+    # @param _creds [Hash] dummy parameter for correct method
+    #   signature.
+    # @param options [Hash] can contain the following keys:
+    #   proxy [String] the address of the Wavefront proxy. ('wavefront')
+    #   port [Integer] the port of the Wavefront proxy (2878)
+    #   tags [Hash] point tags which will be applied to every point
+    #   noop [Bool] if true, no proxy connection will be made, and
+    #     instead of sending the points, they will be printed in
+    #     Wavefront wire format.
+    #   novalidate [Bool] if true, points will not be validated.
+    #     This might make things go marginally quicker if you have
+    #     done point validation higher up in the chain.
+    #   verbose [Bool]
+    #   debug [Bool]
+    #
+    def post_initialize(_creds = {}, options = {})
+      defaults = { tags:       nil,
+                   noop:       false,
+                   novalidate: false,
+                   verbose:    false,
+                   debug:      false }
+
+      @summary = { sent: 0, rejected: 0, unsent: 0 }
+      @opts = setup_options(options, defaults)
+
+      wf_point_tags?(opts[:tags]) if opts[:tags]
+    end
+
+    def setup_options(user, defaults)
+      defaults.merge(user)
+    end
+
+    # Send multiple points to Wavefront.
+    #
+    # @param points [Array[Hash]] an array of points. Each point is
+    #   defined as a hash with the following keys:
+    #     path [String] metric path. (mandatory)
+    #     value [Numeric] value of metric. Numeric. Mandatory.
+    #     ts [Time, Integer] timestamp for point. Defaults to
+    #       current UTC time.
+    #     source [String] originating source of metric. Defaults to
+    #       the local hostname.
+    #     tags [Hash] key: value point tags which will be applied in
+    #       addition to any tags defined in the #initialize()
+    #       method.
+    # @param openclose [Bool] if this is false, you must have
+    #   already opened a socket to the proxy. If it is true, a
+    #   connection will be opened for you, used, and closed.
+    # @param prefix [String] prefix all metrics with this string. No
+    #   trailing dot is required.
+    # @raise any unhandled point validation error is passed through
+    # @return true if no points are rejected, otherwise false
+    #
+    def write(points = [], openclose = true, prefix = nil)
+      open if openclose
+
+      begin
+        _write_loop(prepped_points(points, prefix))
+      ensure
+        close if openclose
+      end
+
+      s_str = summary_string(summary)
+
+      resp = { status:   { result: s_str, message: nil, code: nil },
+               response: summary }.to_json
+
+      Wavefront::Response.new(resp, nil)
+    end
+
+    def summary_string(summary)
+      summary[:unsent].zero? && summary[:rejected].zero? ? 'OK' : 'ERROR'
+    end
+
+    # @return [Array] of points
+    #
+    def prepped_points(points, prefix = nil)
+      ret = [points].flatten
+
+      if prefix
+        ret.map! { |pt| pt.tap { |p| p[:path] = prefix + '.' + p[:path] } }
+      end
+
+      ret
+    end
+
+    # A wrapper method around #write() which guarantees all points
+    # will be sent as deltas. You can still manually prefix any
+    # metric with a delta symbol and use #write(), but depending on
+    # your use-case, this method may be safer. It's easy to forget
+    # the delta.
+    #
+    # @param points [Array[Hash]] see #write()
+    # @param openclose [Bool] see #write()
+    #
+    def write_delta(points, openclose = true)
+      write(paths_to_deltas(points), openclose)
+    end
+
+    # Prefix all paths in a points array (as passed to
+    # #write_delta() with a delta symbol
+    #
+    # @param points [Array[Hash]] see #write()
+    # @return [Array[Hash]]
+    #
+    def paths_to_deltas(points)
+      [points].flatten.map { |p| p.tap { p[:path] = DELTA + p[:path] } }
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    def valid_point?(point)
+      return true if opts[:novalidate]
+
+      begin
+        wf_point?(point)
+        return true
+      rescue Wavefront::Exception::InvalidMetricName,
+             Wavefront::Exception::InvalidMetricValue,
+             Wavefront::Exception::InvalidTimestamp,
+             Wavefront::Exception::InvalidSourceId,
+             Wavefront::Exception::InvalidTag => e
+        log('Invalid point, skipping.', :info)
+        log("Invalid point: #{point}. (#{e})", :debug)
+        summary[:rejected] += 1
+        return false
+      end
+    end
+
+    # Convert a validated point to a string conforming to
+    # https://community.wavefront.com/docs/DOC-1031.  No validation
+    # is done here.
+    #
+    # @param point [Hash] a hash describing a point. See #write() for
+    #   the format.
+    #
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/CyclomaticComplexity
+    def hash_to_wf(point)
+      unless point.key?(:path) && point.key?(:value)
+        raise Wavefront::Exception::InvalidPoint
+      end
+
+      point[:source] = HOSTNAME unless point.key?(:source)
+
+      m = [point[:path], point[:value]]
+      m.<< point[:ts] if point[:ts]
+      m.<< 'source=' + point[:source]
+      m.<< point[:tags].to_wf_tag if point[:tags]
+      m.<< opts[:tags].to_wf_tag if opts[:tags]
+      m.join(' ')
+    end
+
+    # Wrapper for #really_send_point(), which really sends points.
+    #
+    # @param point [String] a point description, probably from
+    #   #hash_to_wf()
+    #
+    def send_point(point)
+      if opts[:noop]
+        log "Would send: #{point}"
+        return
+      end
+
+      log("Sending: #{point}", :info)
+      really_send_point(point)
+    end
+  end
+end

data/lib/wavefront-sdk/report.rb

@@ -0,0 +1,32 @@
+require_relative 'base_write'
+
+module Wavefront
+  #
+  # This class helps you send points direct to the Wavefront API.
+  #
+  # The points are prepped in the BaseWrite class, which this
+  # extends. This class provides the transport mechanism.
+  #
+  class Report < BaseWrite
+    def api_path
+      '/report'
+    end
+
+    def write(points = [], _openclose = true, prefix = nil)
+      _write_loop(prepped_points(points, prefix))
+    end
+
+    def really_send_point(point)
+      api_post('/?f=graphite_v2', point, 'application/octet-stream')
+    end
+
+    private
+
+    # Because API calls are expensive (compared to hitting a local
+    # proxy) we will bundle up points into a single call.
+    #
+    def _write_loop(points)
+      send_point(points.map { |p| hash_to_wf(p) }.join("\n"))
+    end
+  end
+end

data/lib/wavefront-sdk/response.rb

@@ -29,6 +29,8 @@ module Wavefront
     #   response cannot be parsed. This may be because the API
     #   has changed underneath us.
     #
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/PerceivedComplexity
     def initialize(json, status, debug = false)
       raw = raw_response(json, status)
       @status = build_status(raw, status)
@@ -90,7 +92,7 @@ module Wavefront
 
         @result = if obj[:result]
                     obj[:result]
-                  elsif status == 200
+                  elsif status >= 200 && status <= 299
                     'OK'
                   else
                     'ERROR'

data/lib/wavefront-sdk/version.rb

@@ -1 +1 @@
-WF_SDK_VERSION = '1.3.2'.freeze
+WF_SDK_VERSION = '1.4.0'.freeze

data/lib/wavefront-sdk/write.rb

@@ -1,207 +1,15 @@
-require 'socket'
-require_relative './constants'
-require_relative './base'
-
-HOSTNAME = Socket.gethostname.freeze
+require_relative './base_write'
 
 module Wavefront
   #
   # This class helps you send points to a Wavefront proxy in native
   # format. Usually this is done on port 2878.
   #
-  # rubocop:disable Metrics/ClassLength
-  class Write < Base
-    attr_reader :sock, :summary
-
-    # Construct an object which allows us to write points to a
-    # Wavefront proxy.
-    #
-    # @param _creds [Hash] dummy parameter for correct method
-    #   signature.
-    # @param options [Hash] can contain the following keys:
-    #   proxy [String] the address of the Wavefront proxy. ('wavefront')
-    #   port [Integer] the port of the Wavefront proxy (2878)
-    #   tags [Hash] point tags which will be applied to every point
-    #   noop [Bool] if true, no proxy connection will be made, and
-    #     instead of sending the points, they will be printed in
-    #     Wavefront wire format.
-    #   novalidate [Bool] if true, points will not be validated.
-    #     This might make things go marginally quicker if you have
-    #     done point validation higher up in the chain.
-    #   verbose [Bool]
-    #   debug [Bool]
-    #
-    def post_initialize(_creds = {}, options = {})
-      defaults = { tags:       nil,
-                   noop:       false,
-                   novalidate: false,
-                   verbose:    false,
-                   debug:      false }
-
-      @summary = { sent: 0, rejected: 0, unsent: 0 }
-      @opts = setup_options(options, defaults)
-
-      wf_point_tags?(opts[:tags]) if opts[:tags]
-    end
-
-    def setup_options(user, defaults)
-      defaults.merge(user)
-    end
-
-    # Send raw data to a Wavefront proxy, automatically opening and
-    # closing a socket.
-    #
-    # @param points [Array[String]] an array of points in native
-    #   Wavefront wire format, as described in
-    #   https://community.wavefront.com/docs/DOC-1031. No validation
-    #   is performed.
-    # @param openclose [Boolean] whether or not to automatically
-    #   open a socket to the proxy before sending points, and
-    #   afterwards, close it.
-    #
-    def raw(points, openclose = true)
-      open if openclose
-
-      begin
-        [points].flatten.each { |p| send_point(p) }
-      ensure
-        close if openclose
-      end
-    end
-
-    # Send multiple points to a Wavefront proxy.
-    #
-    # @param points [Array[Hash]] an array of points. Each point is
-    #   defined as a hash with the following keys:
-    #     path [String] metric path. (mandatory)
-    #     value [Numeric] value of metric. Numeric. Mandatory.
-    #     ts [Time, Integer] timestamp for point. Defaults to
-    #       current UTC time.
-    #     source [String] originating source of metric. Defaults to
-    #       the local hostname.
-    #     tags [Hash] key: value point tags which will be applied in
-    #       addition to any tags defined in the #initialize()
-    #       method.
-    # @param openclose [Bool] if this is false, you must have
-    #   already opened a socket to the proxy. If it is true, a
-    #   connection will be opened for you, used, and closed.
-    # @param prefix [String] prefix all metrics with this string. No
-    #   trailing dot is required.
-    # @raise any unhandled point validation error is passed through
-    # @return true if no points are rejected, otherwise false
-    #
-    def write(points = [], openclose = true, prefix = nil)
-      open if openclose
-
-      begin
-        _write_loop(prepped_points(points, prefix))
-      ensure
-        close if openclose
-      end
-
-      s_str = summary_string(summary)
-
-      resp = { status:   { result: s_str, message: nil, code: nil },
-               response: summary }.to_json
-
-      Wavefront::Response.new(resp, nil)
-    end
-
-    def summary_string(summary)
-      summary[:unsent].zero? && summary[:rejected].zero? ? 'OK' : 'ERROR'
-    end
-
-    # @return [Array] of points
-    #
-    def prepped_points(points, prefix = nil)
-      ret = [points].flatten
-
-      if prefix
-        ret.map! { |pt| pt.tap { |p| p[:path] = prefix + '.' + p[:path] } }
-      end
-
-      ret
-    end
-
-    # A wrapper method around #write() which guarantees all points
-    # will be sent as deltas. You can still manually prefix any
-    # metric with a delta symbol and use #write(), but depending on
-    # your use-case, this method may be safer. It's easy to forget
-    # the delta.
-    #
-    # @param points [Array[Hash]] see #write()
-    # @param openclose [Bool] see #write()
-    #
-    def write_delta(points, openclose = true)
-      write(paths_to_deltas(points), openclose)
-    end
-
-    # Prefix all paths in a points array (as passed to
-    # #write_delta() with a delta symbol
-    #
-    # @param points [Array[Hash]] see #write()
-    # @return [Array[Hash]]
-    #
-    def paths_to_deltas(points)
-      [points].flatten.map { |p| p.tap { p[:path] = DELTA + p[:path] } }
-    end
-
-    # rubocop:disable Metrics/MethodLength
-    def valid_point?(point)
-      return true if opts[:novalidate]
-
-      begin
-        wf_point?(point)
-        return true
-      rescue Wavefront::Exception::InvalidMetricName,
-             Wavefront::Exception::InvalidMetricValue,
-             Wavefront::Exception::InvalidTimestamp,
-             Wavefront::Exception::InvalidSourceId,
-             Wavefront::Exception::InvalidTag => e
-        log('Invalid point, skipping.', :info)
-        log("Invalid point: #{point}. (#{e})", :debug)
-        summary[:rejected] += 1
-        return false
-      end
-    end
-
-    # Convert a validated point to a string conforming to
-    # https://community.wavefront.com/docs/DOC-1031.  No validation
-    # is done here.
-    #
-    # @param point [Hash] a hash describing a point. See #write() for
-    #   the format.
-    #
-    # rubocop:disable Metrics/AbcSize
-    # rubocop:disable Metrics/CyclomaticComplexity
-    def hash_to_wf(point)
-      unless point.key?(:path) && point.key?(:value)
-        raise Wavefront::Exception::InvalidPoint
-      end
-
-      point[:source] = HOSTNAME unless point.key?(:source)
-
-      m = [point[:path], point[:value]]
-      m.<< point[:ts] if point[:ts]
-      m.<< 'source=' + point[:source]
-      m.<< point[:tags].to_wf_tag if point[:tags]
-      m.<< opts[:tags].to_wf_tag if opts[:tags]
-      m.join(' ')
-    end
-
-    # Send a point which is already in Wavefront wire format.
-    #
-    # @param point [String] a point description, probably from
-    #   #hash_to_wf()
-    #
-    def send_point(point)
-      if opts[:noop]
-        log "Would send: #{point}"
-        return
-      end
-
-      log("Sending: #{point}", :info)
-
+  # The points are prepped in the BaseWrite class, which this
+  # extends. This class provides the transport mechanism.
+  #
+  class Write < BaseWrite
+    def really_send_point(point)
       begin
         sock.puts(point)
       rescue StandardError => e
@@ -218,6 +26,7 @@ module Wavefront
     # Open a socket to a Wavefront proxy, putting the descriptor
     # in instance variable @sock.
     #
+    # rubocop:disable Metrics/MethodLength
     def open
       if opts[:noop]
         log('No-op requested. Not opening connection to proxy.')
@@ -225,7 +34,6 @@ module Wavefront
       end
 
       port = net[:port] || 2878
-
       log("Connecting to #{net[:proxy]}:#{port}.", :info)
 
       begin
@@ -244,6 +52,35 @@ module Wavefront
       sock.close
     end
 
+    # Overload the method which sets an API endpoint. A proxy
+    # endpoint has an address and a port, rather than an address and
+    # a token.
+    #
+    def setup_endpoint(creds)
+      @net = creds
+    end
+
+    # Send raw data to a Wavefront proxy, automatically opening and
+    # closing a socket.
+    #
+    # @param points [Array[String]] an array of points in native
+    #   Wavefront wire format, as described in
+    #   https://community.wavefront.com/docs/DOC-1031. No validation
+    #   is performed.
+    # @param openclose [Boolean] whether or not to automatically
+    #   open a socket to the proxy before sending points, and
+    #   afterwards, close it.
+    #
+    def raw(points, openclose = true)
+      open if openclose
+
+      begin
+        [points].flatten.each { |p| send_point(p) }
+      ensure
+        close if openclose
+      end
+    end
+
     private
 
     def _write_loop(points)
@@ -252,13 +89,5 @@ module Wavefront
         send_point(hash_to_wf(p))
       end
     end
-
-    # Overload the method which sets an API endpoint. A proxy
-    # endpoint has an address and a port, rather than an address and
-    # a token.
-    #
-    def setup_endpoint(creds)
-      @net = creds
-    end
   end
 end

data/spec/spec_helper.rb

@@ -28,7 +28,7 @@ DUMMY_RESPONSE = '{"status":{"result":"OK","message":"","code":200},' \
 
 # Common testing code
 class WavefrontTestBase < MiniTest::Test
-  attr_reader :wf, :wf_noop, :uri_base, :headers
+  attr_reader :wf, :wf_noop, :headers
 
   def initialize(args)
     require_relative "../lib/wavefront-sdk/#{class_basename.downcase}"
@@ -46,10 +46,14 @@ class WavefrontTestBase < MiniTest::Test
   def setup
     klass = Object.const_get('Wavefront').const_get(class_basename)
     @wf = klass.new(CREDS)
-    @uri_base = "https://#{CREDS[:endpoint]}/api/v2/" + api_base
+    @uri_base = uri_base
     @headers = { 'Authorization' => "Bearer #{CREDS[:token]}" }
   end
 
+  def uri_base
+    "https://#{CREDS[:endpoint]}/api/v2/" + api_base
+  end
+
   def target_uri(path)
     [uri_base, path].join(path.start_with?('?') ? '' : '/')
   end

data/spec/wavefront-sdk/report_spec.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require_relative '../spec_helper'
+
+HEADERS = POST_HEADERS.merge('Content-Type': 'application/octet-stream')
+# Unit tests for Report class
+#
+class WavefrontReportTest < WavefrontTestBase
+  def uri_base
+    "https://#{CREDS[:endpoint]}/report"
+  end
+
+  def test_write
+    should_work(:write, POINT, ['?f=graphite_v2', nil],
+                :post, HEADERS, POINT_L)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-sdk
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-03 00:00:00.000000000 Z
+date: 2018-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -194,6 +194,7 @@ files:
 - Rakefile
 - lib/wavefront-sdk/alert.rb
 - lib/wavefront-sdk/base.rb
+- lib/wavefront-sdk/base_write.rb
 - lib/wavefront-sdk/cloudintegration.rb
 - lib/wavefront-sdk/constants.rb
 - lib/wavefront-sdk/credentials.rb
@@ -210,6 +211,7 @@ files:
 - lib/wavefront-sdk/parse_time.rb
 - lib/wavefront-sdk/proxy.rb
 - lib/wavefront-sdk/query.rb
+- lib/wavefront-sdk/report.rb
 - lib/wavefront-sdk/response.rb
 - lib/wavefront-sdk/savedsearch.rb
 - lib/wavefront-sdk/search.rb
@@ -238,6 +240,7 @@ files:
 - spec/wavefront-sdk/parse_time_spec.rb
 - spec/wavefront-sdk/proxy_spec.rb
 - spec/wavefront-sdk/query_spec.rb
+- spec/wavefront-sdk/report_spec.rb
 - spec/wavefront-sdk/resources/test.conf
 - spec/wavefront-sdk/resources/test2.conf
 - spec/wavefront-sdk/response_spec.rb
@@ -292,6 +295,7 @@ test_files:
 - spec/wavefront-sdk/parse_time_spec.rb
 - spec/wavefront-sdk/proxy_spec.rb
 - spec/wavefront-sdk/query_spec.rb
+- spec/wavefront-sdk/report_spec.rb
 - spec/wavefront-sdk/resources/test.conf
 - spec/wavefront-sdk/resources/test2.conf
 - spec/wavefront-sdk/response_spec.rb