wavefront-sdk 6.0.0 → 8.0.0

data/lib/wavefront-sdk/source.rb

@@ -43,7 +43,7 @@ module Wavefront
       api.post('', body, 'application/json')
     end
 
-    # DELETE /api/v2/source/id
+    # DELETE /api/v2/source/{id}
     # Delete metadata (description and tags) for a specific source.
     #
     # @param id [String] ID of the source
@@ -54,7 +54,7 @@ module Wavefront
       api.delete(id)
     end
 
-    # POST /api/v2/source/id/description
+    # POST /api/v2/source/{id}/description
     # Set description associated with a specific source
 
     def description_set(id, description)
@@ -63,7 +63,7 @@ module Wavefront
                'application/json')
     end
 
-    # DELETE /api/v2/source/id/description
+    # DELETE /api/v2/source/{id}/description
     # Remove description from a specific source
 
     def description_delete(id)
@@ -71,7 +71,7 @@ module Wavefront
       api.delete([id, 'description'].uri_concat)
     end
 
-    # GET /api/v2/source/id
+    # GET /api/v2/source/{id}
     # Get a specific source for a customer.
     #
     # @param id [String] ID of the source
@@ -85,10 +85,10 @@ module Wavefront
       api.get(fragments.uri_concat)
     end
 
-    # PUT /api/v2/source/id
+    # PUT /api/v2/source/{id}
     # Update metadata (description or tags) for a specific source.
     #
-    # @param id [String] a Wavefront alert ID
+    # @param id [String] a Wavefront source ID
     # @param body [Hash] key-value hash of the parameters you wish
     #   to change
     # @param modify [true, false] if true, use {#describe()} to get

data/lib/wavefront-sdk/spansamplingpolicy.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require_relative 'defs/constants'
+require_relative 'core/api'
+
+module Wavefront
+  #
+  # View and manage the Wavefront span sampling policy.
+  #
+  class SpanSamplingPolicy < CoreApi
+    def update_keys
+      %i[name active expression description samplingPercent]
+    end
+
+    # GET /api/v2/spansamplingpolicy
+    # Get all sampling policies for a customer
+    #
+    # @param offset [Int] policy at which the list begins
+    # @param limit [Int] the number of policies to return
+    # @return [Wavefront::Response]
+    #
+    def list(offset = 0, limit = 100)
+      api.get('', offset: offset, limit: limit)
+    end
+
+    # POST /api/v2/spansamplingpolicy
+    # Create a span sampling policy
+    #
+    # @param body [Hash] description of policy
+    # @return [Wavefront::Response]
+    #
+    def create(body)
+      raise ArgumentError unless body.is_a?(Hash)
+
+      api.post('', body, 'application/json')
+    end
+
+    # DELETE /api/v2/spansamplingpolicy/{id}
+    # Delete a specific span sampling policy
+    #
+    # Deleting an active policy moves it to 'trash', from where it can
+    # be restored with an #undelete operation. Deleting an policy in
+    # 'trash' removes it for ever.
+    #
+    # @param id [String] ID of the policy
+    # @return [Wavefront::Response]
+    #
+    def delete(id)
+      wf_spansamplingpolicy_id?(id)
+      api.delete(id)
+    end
+
+    # GET /api/v2/spansamplingpolicy/deleted
+    # Get all deleted sampling policies for a customer
+    # @return [Wavefront::Response]
+    #
+    def deleted
+      api.get('deleted')
+    end
+
+    # GET /api/v2/spansamplingpolicy/{id}
+    # GET /api/v2/spansamplingpolicy/{id}/history/{version}
+    # Get a specific span sampling policy
+    # Get a specific policy / Get a specific historical version of a specific
+    # sampling policy
+    #
+    # @param id [String] ID of the policy
+    # @param version [Integer] version of policy
+    # @return [Wavefront::Response]
+    #
+    def describe(id, version = nil)
+      wf_spansamplingpolicy_id?(id)
+      wf_version?(version) if version
+      fragments = [id]
+      fragments += ['history', version] if version
+      api.get(fragments.uri_concat)
+    end
+
+    # PUT /api/v2/spansamplingpolicy/{id}
+    # Update a specific span sampling policy
+    #
+    # @param id [String] a Wavefront span-sampling policy 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_spansamplingpolicy_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
+
+    # GET /api/v2/spansamplingpolicy/{id}/history
+    # Get the version history of a specific sampling policy
+    #
+    # @param id [String] ID of the policy
+    # @return [Wavefront::Response]
+    #
+    def history(id, offset = nil, limit = nil)
+      wf_spansamplingpolicy_id?(id)
+      qs = {}
+      qs[:offset] = offset if offset
+      qs[:limit] = limit if limit
+
+      api.get([id, 'history'].uri_concat, qs)
+    end
+
+    # POST /api/v2/spansamplingpolicy/{id}/undelete
+    # Restore a deleted span sampling policy
+    #
+    # @param id [String] ID of the policy
+    # @return [Wavefront::Response]
+    #
+    def undelete(id)
+      wf_spansamplingpolicy_id?(id)
+      api.post([id, 'undelete'].uri_concat)
+    end
+  end
+end

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

@@ -11,6 +11,6 @@ class String
   # @return [String] a URI path
   #
   def tagescape
-    gsub(/"/, '\"')
+    gsub('"', '\"')
   end
 end

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

@@ -23,7 +23,7 @@ module Wavefront
     # @raise Wavefront::InvalidTimestamp
     #
     def parse_time(time, in_ms = false)
-      return relative_time(time, in_ms) if time.to_s.match?(/^[\-+]/)
+      return relative_time(time, in_ms) if time.to_s.match?(/^[-+]/)
 
       ParseTime.new(time, in_ms).parse!
     end

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

@@ -55,7 +55,7 @@ module Wavefront
     end
 
     def parse!
-      method = ('parse_time_' + t.class.name.downcase).to_sym
+      method = "parse_time_#{t.class.name.downcase}".to_sym
       send(method)
     rescue StandardError
       raise Wavefront::Exception::InvalidTimestamp, t

data/lib/wavefront-sdk/user.rb

@@ -49,7 +49,7 @@ module Wavefront
       api.post("?sendEmail=#{send_email}", body, 'application/json')
     end
 
-    # DELETE /api/v2/user/id
+    # DELETE /api/v2/user/{id}
     # Delete a specific user. See also #delete_users.
     #
     # @param id [String] ID of the user
@@ -61,7 +61,7 @@ module Wavefront
       api.delete(id)
     end
 
-    # GET /api/v2/user/id
+    # GET /api/v2/user/{id}
     # Retrieves a user by identifier (email addr).
     #
     # @param id [String] ID of the user
@@ -73,7 +73,7 @@ module Wavefront
       api.get(id)
     end
 
-    # PUT /api/v2/user/id
+    # PUT /api/v2/user/{id}
     # Update a specific user definition.
     #
     # @param id [String] a Wavefront user ID
@@ -124,7 +124,7 @@ module Wavefront
                'application/json')
     end
 
-    # PUT /api/v2/user/id/grant
+    # POST /api/v2/user/{id}/grant
     # Grants a specific user permission.
     #
     # @param id [String] ID of the user
@@ -147,7 +147,7 @@ module Wavefront
                'application/x-www-form-urlencoded')
     end
 
-    # PUT /api/v2/user/id/revoke
+    # POST /api/v2/user/{id}/revoke
     # Revokes a specific user permission.
     #
     # @param id [String] ID of the user

data/lib/wavefront-sdk/usergroup.rb

@@ -16,8 +16,8 @@ module Wavefront
 
     # GET /api/v2/usergroup
     # Get all user groups for a customer
-    # @param offset [Int] alert at which the list begins
-    # @param limit [Int] the number of alerts to return
+    # @param offset [Int] usergroup at which the list begins
+    # @param limit [Int] the number of usergroups to return
     # @return [Wavefront::Response]
     #
     def list(offset = 0, limit = 100)

data/lib/wavefront-sdk/validators.rb

@@ -81,7 +81,7 @@ module Wavefront
       # commas in tags and descriptions. This might be too restrictive,
       # but if it is, this is the only place we need to change it.
       #
-      if str.is_a?(String) && str.size < 1024 && str =~ /^[\-\w .,]*$/
+      if str.is_a?(String) && str.size < 1024 && str =~ /^[-\w .,]*$/
         return true
       end
 
@@ -164,8 +164,7 @@ module Wavefront
     #
     # @param version [Integer] the version number to validate
     # @return True if the version is valid
-    # @raise Wavefront::Exception::InvalidVersion if the alert ID is
-    #   not valid
+    # @raise Wavefront::Exception::InvalidVersion if the ID is not valid
     #
     def wf_version?(version)
       version = version.to_i if version.is_a?(String) && version =~ /^\d+$/
@@ -197,7 +196,7 @@ module Wavefront
     def wf_point_tag?(key, val)
       if key && val && (key.size + val.size < 254) &&
          key =~ /^[\w\-.:]+$/ && val !~ /\\$/
-        return
+        return false
       end
 
       raise Wavefront::Exception::InvalidTag, "#{key}=#{val}"
@@ -256,7 +255,7 @@ module Wavefront
     #   dashboard ID is not valid
     #
     def wf_dashboard_id?(id)
-      return true if id.is_a?(String) && id.size < 256 && id.match(/^[\w\-]+$/)
+      return true if id.is_a?(String) && id.size < 256 && id.match(/^[\w-]+$/)
 
       raise Wavefront::Exception::InvalidDashboardId, id
     end
@@ -391,7 +390,7 @@ module Wavefront
     #   is not valid
     #
     def wf_source_id?(source)
-      if source.is_a?(String) && source.match(/^[\w.\-]+$/) &&
+      if source.is_a?(String) && source.match(/^[\w.-]+$/) &&
          source.size < 1024
         return true
       end
@@ -589,10 +588,10 @@ module Wavefront
     #   ID is not valid
     #
     def wf_account_id?(id)
-      return true if wf_user_id?(id)
+      true if wf_user_id?(id)
     rescue Wavefront::Exception::InvalidUserId
       begin
-        return true if wf_serviceaccount_id?(id)
+        true if wf_serviceaccount_id?(id)
       rescue Wavefront::Exception::InvalidServiceAccountId
         raise Wavefront::Exception::InvalidAccountId, id
       end
@@ -609,6 +608,17 @@ module Wavefront
       raise Wavefront::Exception::InvalidMonitoredClusterId, id
     end
 
+    # Ensure the given argument is a valid monitored application ID
+    # @param id [String]
+    # @raise Wavefront::Exception::InvalidMonitoredApplicationId if the ID is
+    #   not valid
+    #
+    def wf_monitoredapplication_id?(id)
+      return true if id.is_a?(String) && id.size < 256 && id =~ /^[a-z0-9\-_]+$/
+
+      raise Wavefront::Exception::InvalidMonitoredApplicationId, id
+    end
+
     # Ensure the given value is a valid sampling rate.
     # @param rate [Float]
     # @raise Wavefront::Exception::InvalidSamplingValue
@@ -654,6 +664,19 @@ module Wavefront
 
       raise Wavefront::Exception::InvalidMetricsPolicyId, id
     end
+
+    # Ensure the given argument is a valid Wavefront Span Sampling Policy ID.
+    # So far as I can tell they're just strings.
+    #
+    # @param id [String] the span sampling policy ID to validate
+    # @return true if the ID is valid
+    # @raise Wavefront::Exception::InvalidSpanSamplingPolicyId if the ID is
+    #   not valid
+    def wf_spansamplingpolicy_id?(id)
+      return true if id.is_a?(String)
+
+      raise Wavefront::Exception::InvalidSpanSamplingPolicyId, id
+    end
   end
   # rubocop:enable Metrics/ModuleLength
 end

data/lib/wavefront-sdk/webhook.rb

@@ -35,7 +35,7 @@ module Wavefront
       api.post('', body, 'application/json')
     end
 
-    # DELETE /api/v2/webhook/id
+    # DELETE /api/v2/webhook/{id}
     # Delete a specific webhook.
     #
     # @param id [String, Integer] ID of the webhook
@@ -46,7 +46,7 @@ module Wavefront
       api.delete(id)
     end
 
-    # GET /api/v2/webhook/id
+    # GET /api/v2/webhook/{id}
     # Get a specific webhook.
     #
     # @param id [String, Integer] ID of the webhook
@@ -57,7 +57,7 @@ module Wavefront
       api.get(id)
     end
 
-    # PUT /api/v2/webhook/id
+    # PUT /api/v2/webhook/{id}
     # Update a specific webhook.
     #
     # @param id [String] a Wavefront webhook ID

data/lib/wavefront-sdk/write.rb

@@ -88,6 +88,7 @@ module Wavefront
       writer.close
     end
 
+    # POST /report
     # A wrapper to the writer class's #write method.
     # Writers implement this method differently, Check the
     # appropriate class documentation for @return information etc.

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

@@ -6,10 +6,23 @@ require_relative '../core/api_caller'
 module Wavefront
   module Writer
     #
-    # Send points direct to Wavefront's API. This requires an
-    # endpoint, a token, and HTTPS egress.
+    # Send points direct to Wavefront's API. This requires an endpoint, a
+    # token, and HTTPS egress.
+    #
+    # Points are sent in batches of BATCH_SIZE. We attempt to make a summary
+    # of how many points are sent or rejected, but it's quantized by the batch
+    # size.
+    #
+    # TODO I think this needs a composite response. It makes one or more API
+    # calls depending on the amount of metrics to be sent, and the CLI needs
+    # to know if there was anything other than a 200. Options are to return
+    # the first failure when it happens, or to try all the chunks and return
+    # the last non-200, or the highest numbered return code, or some other
+    # indication of failure.
     #
     class Api < Core
+      BATCH_SIZE = 100
+
       def open
         @conn = Wavefront::ApiCaller.new(self, creds, opts)
       end
@@ -32,7 +45,6 @@ module Wavefront
 
       def send_point(body)
         _send_point(body)
-        summary.sent += body.size
         true
       rescue StandardError => e
         summary.unsent += body.size
@@ -52,15 +64,26 @@ module Wavefront
         send_point(body)
       end
 
-      # Send points in batches of a hundred. I'm not sure exactly
-      # how much the API can cope with in a single call, so this
-      # might change.
+      # Send points in batches of BATCH_SIZE. I'm not sure exactly how much the
+      # API can cope with in a single call, so this might change.
+      # @return [Nil]
       #
+      # rubocop:disable Metrics/MethodLength
       def _send_point(body)
-        body.each_slice(100) do |p|
-          conn.post('/?f=wavefront', p.join("\n"), 'application/octet-stream')
+        body.each_slice(BATCH_SIZE) do |p|
+          ret = conn.post('/?f=wavefront', p.join("\n"),
+                          'application/octet-stream')
+
+          if ret.ok?
+            logger.log("sent #{BATCH_SIZE} points", :debug)
+            summary.sent += p.count
+          else
+            logger.log("failed to send #{BATCH_SIZE} points", :debug)
+            summary.unsent += p.count
+          end
         end
       end
+      # rubocop:enable Metrics/MethodLength
     end
   end
 end

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

@@ -112,7 +112,7 @@ module Wavefront
         ret = [points].flatten
         return ret unless prefix
 
-        ret.map { |pt| pt.tap { |p| p[:path] = prefix + '.' + p[:path] } }
+        ret.map { |pt| pt.tap { |p| p[:path] = "#{prefix}.#{p[:path]}" } }
       end
 
       # Filter invalid points out of an array of points

data/lib/wavefront_sdk.rb

@@ -4,7 +4,7 @@
 #
 require 'pathname'
 
-libdir = Pathname.new(__dir__) + 'wavefront-sdk'
+libdir = Pathname.new(__dir__).join('wavefront-sdk')
 
 libdir.children.select { |f| f.extname == '.rb' }.each do |f|
   require_relative f

data/spec/constants.rb

@@ -19,8 +19,8 @@ DUMMY_RESPONSE = '{"status":{"result":"OK","message":"","code":200},' \
                  '"response":{"items":[{"name":"test data"}],"offset":0,' \
                  '"limit":100,"totalItems":3,"moreItems":false}}'
 
-RESOURCE_DIR = (Pathname.new(__FILE__).dirname +
-                'wavefront-sdk' + 'resources').freeze
+RESOURCE_DIR = Pathname.new(__FILE__).dirname.join('wavefront-sdk',
+                                                   'resources').freeze
 
 U_ACL_1 = 'someone@example.com'
 U_ACL_2 = 'other@elsewhere.com'

data/spec/spec_helper.rb

@@ -10,7 +10,7 @@ require_relative 'constants'
 
 # Abstract class which sets up everything needed by the API tests
 #
-class WavefrontTestBase < MiniTest::Test
+class WavefrontTestBase < Minitest::Test
   attr_reader :wf, :wf_noop, :headers, :invalid_id, :valid_id
 
   def initialize(args)

data/spec/wavefront-sdk/accesspolicy_spec.rb

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../spec_helper'
+require_relative '../test_mixins/general'
+
+# Unit tests for AccessPolicy class
+#
+class WavefrontAccessPolicyTest < WavefrontTestBase
+  def test_describe
+    assert_gets('/api/v2/accesspolicy') { wf.describe }
+  end
+
+  def test_update
+    assert_puts('/api/v2/accesspolicy', payload.to_json) do
+      wf.update(payload)
+    end
+  end
+
+  def test_validate
+    assert_gets('/api/v2/accesspolicy/validate?ip=1.2.3.4') do
+      wf.validate('1.2.3.4')
+    end
+  end
+
+  private
+
+  def api_class
+    'accesspolicy'
+  end
+
+  def payload
+    {
+      status: {
+        result: 'OK',
+        message: 'string',
+        code: 0
+      },
+      response: {
+        customer: 'string',
+        lastUpdatedMs: 0,
+        policyRules: [
+          {
+            name: 'string',
+            description: 'string',
+            subnet: 'string',
+            action: 'ALLOW'
+          }
+        ]
+      }
+    }
+  end
+end

data/spec/wavefront-sdk/account_spec.rb

@@ -179,6 +179,18 @@ class WavefrontAccountTest < WavefrontTestBase
     assert_raises(ArgumentError) { wf.validate_accounts }
   end
 
+  def test_admins
+    assert_gets('/api/v2/account/user/admin') { wf.admins }
+  end
+
+  def test_update_perms
+    assert_invalid_id { wf.update_perms(invalid_id, perms_payload) }
+
+    assert_puts("/api/v2/account/user/#{user_id}", perms_payload.to_json) do
+      wf.update_perms(user_id, perms_payload, false)
+    end
+  end
+
   private
 
   def api_class
@@ -203,6 +215,10 @@ class WavefrontAccountTest < WavefrontTestBase
        2659191e-aad4-4302-a94e-9667e1515678]
   end
 
+  def user_id
+    'user@example.com'
+  end
+
   def invalid_role
     %w[bad_role]
   end
@@ -212,7 +228,7 @@ class WavefrontAccountTest < WavefrontTestBase
   end
 
   def id_list
-    %w[sa:test user@example.com]
+    ['sa:test', user_id]
   end
 
   def invalid_permission
@@ -235,4 +251,19 @@ class WavefrontAccountTest < WavefrontTestBase
     { emailAddress: id,
       groups: %w[browse] }
   end
+
+  def perms_payload
+    {
+      identifier: 'user@example.com',
+      groups: [
+        'user_management'
+      ],
+      userGroups: [
+        '8b23136b-ecd2-4cb5-8c92-62477dcc4090'
+      ],
+      roles: [
+        'Role'
+      ]
+    }
+  end
 end

data/spec/wavefront-sdk/alert_spec.rb

@@ -35,6 +35,23 @@ class WavefrontAlertTest < WavefrontTestBase
     assert_invalid_id { wf.unsnooze(invalid_id) }
   end
 
+  def test_check_query
+    query = {
+      inputQuery: 'string',
+      translatedInput: 'sum(http_requests_total{method="GET"})',
+      queryType: 'PromQL'
+    }
+    assert_posts('/api/v2/alert/checkQuery', query.to_json) do
+      wf.check_query(query)
+    end
+  end
+
+  def test_preview
+    assert_posts('/api/v2/alert/preview', payload.to_json) do
+      wf.preview(payload)
+    end
+  end
+
   def test_summary
     assert_gets('/api/v2/alert/summary') { wf.summary }
   end

data/spec/wavefront-sdk/api_mixins/user_mixins_spec.rb

@@ -8,7 +8,7 @@ require_relative '../../../lib/wavefront-sdk/core/exception'
 
 # Test user mixins
 #
-class WavefrontUserMixinsTest < MiniTest::Test
+class WavefrontUserMixinsTest < Minitest::Test
   include Wavefront::Mixin::User
   include Wavefront::Validators
 

data/spec/wavefront-sdk/apitoken_spec.rb

@@ -10,6 +10,18 @@ class WavefrontApiTokenTest < WavefrontTestBase
     assert_gets('/api/v2/apitoken') { wf.list }
   end
 
+  def test_list_customer_tokens
+    assert_gets('/api/v2/apitoken/customertokens') { wf.list_customer_tokens }
+  end
+
+  def test_describe_customer_token
+    assert_invalid_id { wf.describe_customer_token(invalid_token_id) }
+
+    assert_gets("/api/v2/apitoken/customertokens/#{token_id}") do
+      wf.describe_customer_token(token_id)
+    end
+  end
+
   def test_create
     assert_posts('/api/v2/apitoken', 'null') { wf.create }
     assert_raises(ArgumentError) { wf.create('test') }

data/spec/wavefront-sdk/cluster_spec.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../spec_helper'
+require_relative '../test_mixins/general'
+
+# Unit tests for Cluster class
+#
+class WavefrontClusterTest < WavefrontTestBase
+  def test_describe
+    assert_gets('/api/v2/cluster/info') { wf.describe }
+  end
+end