wavefront-sdk 5.4.1 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c655c861444978220b162bc7144eacd8ae34a01016acc37aa6dd8837f7c13946
-  data.tar.gz: e83e2a0bf6faa89f429e8100154c4fa0d2d394e0eaff3aa948deacf9ebad0217
+  metadata.gz: 839f24e0a1a324b6965cb8aec1c0516bcb7c193215bc3cb6c1351f888bd49863
+  data.tar.gz: 97ba3cce211abdef8d1b08265279a2998f968a6f85a58290efe26d8109314940
 SHA512:
-  metadata.gz: 98d0ddf6e9c5fd9e221919a502f1f9d417bfeced192958c14dda83bf126d883eea26af2aceadd2c713c9b1ee152494542f373c737ce4e833c87c8f2677210f0e
-  data.tar.gz: 8c7a347579b7375cac6c7c481ba13cc7ff2d393d9f6eff867b080d8f93b2d545bbddd8b67193706ec3cefda03ff46c3bb26033b0e14b824fad596d13a72a5201
+  metadata.gz: 2d72451c46077024d79451aaea09efec073db0dcfb6dfb7601382973f80b14c99cd3b732bf57ec09a1ec962938b2219470676ba84c47b27051b5d2970cdeb8ef
+  data.tar.gz: fdf2b294468db11835722f3ffbcbac2e77a42a12d8083c4e7536f637659bf8e063de0b75f023e71a46d2a25e942ad197e16e70a4229db5142b741542dbaaf2f7

data/.codeclimate.yml

@@ -11,7 +11,7 @@ engines:
   fixme:
     enabled: true
   rubocop:
-    enabled: true
+    enabled: false
 ratings:
   paths:
   - "**.rb"

data/.github/workflows/release.yml

@@ -0,0 +1,37 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - '[0-9]+.[0-9]+.[0-9]+'
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set env
+      run: echo "RELEASE_VERSION=$(echo ${GITHUB_REF:10})" >> $GITHUB_ENV
+
+    - name: Set up Ruby 2.7
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+    - run: bundle install
+
+    - name: Run tests
+      run: bundle exec rake
+
+    - name: Build Gem
+      run: bundle exec rake build
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p ${HOME}/.gem
+        echo -e "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}" >${HOME}/.gem/credentials
+        chmod 0600 ${HOME}/.gem/credentials
+        gem push pkg/*.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/test.yml

@@ -0,0 +1,23 @@
+name: Test
+
+on:
+  push:
+    branches-ignore: release
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [2.5.9, 2.6.7, 2.7.3, 3.0.1]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/.rubocop.yml

@@ -1,18 +1,20 @@
 ---
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
   NewCops: enable
 
-Metrics/ClassLength:
-  Max: 150
+require:
+  - rubocop-rake
+  - rubocop-minitest
+  - rubocop-performance
+  - rubocop-performance
 
-# Is nothing sacred?
 Layout/LineLength:
   Max: 80
-
+Metrics/ClassLength:
+  Max: 150
 Style/StringConcatenation:
   Enabled: false
-
 Style/OptionalBooleanParameter:
   Enabled: false

data/HISTORY.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## 6.0.0 (2021-07-16)
+* Drop support for Ruby 2.4. (Breaking change.)
+* Change the name of the proxy writer from `socket` to `proxy`. (Breaking
+  change.)
+* Change the name of the Unix datagram socket writer from `unix` to `socket`.
+* added `Wavefront::Event#alert_firing_details`.
+* added `Wavefront::Event#alert_queries_slug`.
+* added `Wavefront::Event#events`.
+* added `Wavefront::Event#alert_firings`.
+* Add `Wavefront::MetricsPolicy`.
+* Add `Wavefront::Spy#deltas`.
+
+## 5.4.4 (2021-02-01)
+* Fix credential validation on writer classes.
+* Improve tests for writer classes
+* Change the level of "wire format" messages from `INFO` to `DEBUG`.
+* Officially support Ruby 3.0.0.
+* Move off Travis, and on to Github Actions.
+* Modernise linting and use of linter.
+
+## 5.4.3 (2021-01-28)
+* Always pass through invalid timestamp on time-parsing error.
+
+## 5.4.2 (2021-01-11)
+* Fix bug which blocked event updates.
+
 ## 5.4.1 (2020-12-17)
 * Fix error on derived metric modification.
 

data/README.md

@@ -1,5 +1,5 @@
 # wavefront-sdk
-[![Build Status](https://travis-ci.org/snltd/wavefront-sdk.svg?branch=master)](https://travis-ci.org/snltd/wavefront-sdk) [![Code Climate](https://codeclimate.com/github/snltd/wavefront-sdk/badges/gpa.svg)](https://codeclimate.com/github/snltd/wavefront-sdk) [![Issue Count](https://codeclimate.com/github/snltd/wavefront-sdk/badges/issue_count.svg)](https://codeclimate.com/github/snltd/wavefront-sdk) [![Gem Version](https://badge.fury.io/rb/wavefront-sdk.svg)](https://badge.fury.io/rb/wavefront-sdk) ![](http://ruby-gem-downloads-badge.herokuapp.com/wavefront-sdk?type=total)
+[![Test](https://github.com/snltd/wavefront-sdk/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/snltd/wavefront-sdk/actions/workflows/test.yml) [![Release](https://github.com/snltd/wavefront-sdk/actions/workflows/release.yml/badge.svg?branch=master)](https://github.com/snltd/wavefront-sdk/actions/workflows/release.yml) [![Code Climate](https://codeclimate.com/github/snltd/wavefront-sdk/badges/gpa.svg)](https://codeclimate.com/github/snltd/wavefront-sdk) [![Issue Count](https://codeclimate.com/github/snltd/wavefront-sdk/badges/issue_count.svg)](https://codeclimate.com/github/snltd/wavefront-sdk) [![Gem Version](https://badge.fury.io/rb/wavefront-sdk.svg)](https://badge.fury.io/rb/wavefront-sdk) ![](http://ruby-gem-downloads-badge.herokuapp.com/wavefront-sdk?type=total)
 
 This is a Ruby SDK for v2 of
 [Wavefront](https://www.wavefront.com/)'s public API. It aims to be
@@ -24,7 +24,7 @@ or to build locally,
 $ gem build wavefront-sdk.gemspec
 ```
 
-`wavefront-sdk` requires Ruby >= 2.4. All its dependencies are pure
+`wavefront-sdk` requires Ruby >= 2.5. All its dependencies are pure
 Ruby, right the way down, so a compiler should never be required to
 install it.
 
@@ -41,7 +41,7 @@ method will return a `Wavefront::Response` object. This object has
 `status` and `response` methods. `status` always yields a structure
 containing `result`, `message` and `code` fields which can be
 inspected to ensure an API call was processed successfully.
-`response` gives you a the JSON response from the API, conveniently
+`response` gives you the JSON response from the API, conveniently
 processed and turned into a [`Map`](https://github.com/ahoward/map)
 object. Map objects can be interrogated in various ways. For
 instance `map['items']`, `map[:items]` and `map.items` will all get
@@ -203,7 +203,7 @@ wf.close
 ```
 
 Alternatively, pass `false` as the second argument to `Write#write`.
-(This is the legacy method, kept in for backward compatability.)
+(This is the legacy method, kept in for backward compatibility.)
 
 ```ruby
 wf = Wavefront::Write.new(Wavefront::Credentials.new.proxy)
@@ -220,7 +220,7 @@ but other methods are supported via the `writer` option.
 wf = Wavefront::Write.new(Wavefront::Credentials.new.creds, writer: :api)
 
 # To send points via a local Unix socket
-wf = Wavefront::Write.new(socket: '/tmp/wf_sock', { writer: :unix })
+wf = Wavefront::Write.new({ socket: '/tmp/wf_sock'}, { writer: :socket })
 
 # To send points over HTTP
 wf = Wavefront::Write.new(Wavefront::Credentials.new.creds, writer: :http)

data/lib/wavefront-sdk/api_mixins/acl.rb

@@ -80,7 +80,7 @@ module Wavefront
       end
 
       def valid_acl_body?(list)
-        return true if list.is_a?(Array) && list.all? { |h| h.is_a?(String) }
+        return true if list.is_a?(Array) && list.all?(String)
 
         raise ArgumentError
       end

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

@@ -94,7 +94,7 @@ module Wavefront
     def hash_for_update(old, new)
       raise ArgumentError unless old.is_a?(Hash) && new.is_a?(Hash)
 
-      Hash[old.merge(new).map { |k, v| [k.to_sym, v] }].select do |k, _v|
+      old.merge(new).transform_keys(&:to_sym).select do |k, _v|
         update_keys.include?(k)
       end
     end

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

@@ -134,7 +134,7 @@ module Wavefront
     def post(path, body = nil, ctype = 'text/plain')
       body = body.to_json unless body.is_a?(String)
       make_call(mk_conn(path,  'Content-Type': ctype,
-                               'Accept': 'application/json'),
+                               Accept: 'application/json'),
                 :post, nil, body)
     end
 
@@ -149,7 +149,7 @@ module Wavefront
     #
     def put(path, body = nil, ctype = 'application/json')
       make_call(mk_conn(path,  'Content-Type': ctype,
-                               'Accept': 'application/json'),
+                               Accept: 'application/json'),
                 :put, nil, body.to_json)
     end
 

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

@@ -6,61 +6,119 @@ module Wavefront
   #
   class Exception
     class CredentialError < RuntimeError; end
+
     class EmptyMetricName < RuntimeError; end
+
     class EnumerableError < RuntimeError; end
+
     class InvalidAccountId < RuntimeError; end
+
     class InvalidAlertId < RuntimeError; end
+
     class InvalidAlertSeverity < RuntimeError; end
+
     class InvalidApiTokenId < RuntimeError; end
+
     class InvalidAwsExternalId < RuntimeError; end
+
     class InvalidConfigFile < RuntimeError; end
+
     class InvalidCloudIntegrationId < RuntimeError; end
+
     class InvalidDashboardId < RuntimeError; end
+
     class InvalidDerivedMetricId < RuntimeError; end
+
     class InvalidDistribution < RuntimeError; end
+
     class InvalidDistributionInterval < RuntimeError; end
+
     class InvalidDistributionCount < RuntimeError; end
+
     class InvalidEndpoint < RuntimeError; end
+
     class InvalidEventId < RuntimeError; end
+
     class InvalidExternalLinkId < RuntimeError; end
+
     class InvalidGranularity < RuntimeError; end
+
     class InvalidHostname < RuntimeError; end
+
     class InvalidIngestionPolicyId < RuntimeError; end
+
     class InvalidIntegrationId < RuntimeError; end
+
     class InvalidLinkTemplate < RuntimeError; end
+
     class InvalidMaintenanceWindowId < RuntimeError; end
+
     class InvalidMonitoredClusterId < RuntimeError; end
+
     class InvalidMessageId < RuntimeError; end
+
     class InvalidMetricName < RuntimeError; end
+
+    class InvalidMetricsPolicyId < RuntimeError; end
+
     class InvalidMetricValue < RuntimeError; end
+
     class InvalidName < RuntimeError; end
+
     class InvalidNotificantId < RuntimeError; end
+
     class InvalidPermission < RuntimeError; end
+
     class InvalidPoint < RuntimeError; end
+
     class InvalidPrefixLength < RuntimeError; end
+
     class InvalidProxyId < RuntimeError; end
+
     class InvalidRoleId < RuntimeError; end
+
     class InvalidRelativeTime < RuntimeError; end
+
     class InvalidSamplingValue < RuntimeError; end
+
     class InvalidSavedSearchEntity < RuntimeError; end
+
     class InvalidSavedSearchId < RuntimeError; end
+
     class InvalidServiceAccountId < RuntimeError; end
+
     class InvalidSourceId < RuntimeError; end
+
     class InvalidString < RuntimeError; end
+
     class InvalidTag < RuntimeError; end
+
     class InvalidTimeFormat < RuntimeError; end
+
     class InvalidTimeUnit < RuntimeError; end
+
     class InvalidTimestamp < RuntimeError; end
+
     class InvalidUserId < RuntimeError; end
+
     class InvalidUserGroupId < RuntimeError; end
+
     class InvalidVersion < RuntimeError; end
+
     class InvalidWebhookId < RuntimeError; end
+
     class MissingConfigProfile < RuntimeError; end
+
     class NetworkTimeout < RuntimeError; end
+
     class NotImplemented < RuntimeError; end
+
     class SocketError < RuntimeError; end
+
     class UnparseableResponse < RuntimeError; end
+
     class UnsupportedWriter < RuntimeError; end
+
     class ValueOutOfRange < RuntimeError; end
   end
 end

data/lib/wavefront-sdk/credentials.rb

@@ -65,12 +65,14 @@ module Wavefront
     # @return void
     #
     def populate(raw)
+      creds_keys = %i[endpoint token]
+      proxy_keys = %i[proxy port]
+      all_keys = creds_keys + proxy_keys
+
       @config = Map(raw)
-      @creds  = Map(raw.select { |k, _v| %i[endpoint token].include?(k) })
-      @proxy  = Map(raw.select { |k, _v| %i[proxy port].include?(k) })
-      @all    = Map(raw.select do |k, _v|
-        %i[proxy port endpoint token].include?(k)
-      end)
+      @creds  = Map(raw.select { |k, _v| creds_keys.include?(k) })
+      @proxy  = Map(raw.select { |k, _v| proxy_keys.include?(k) })
+      @all    = Map(raw.select { |k, _v| all_keys.include?(k) })
     end
 
     # @return [Array] a list of possible credential files
@@ -126,9 +128,7 @@ module Wavefront
     # @return [Hash] options loaded from file. Each key becomes a symbol
     #
     def load_profile(file, profile = 'default')
-      IniFile.load(file)[profile].each_with_object({}) do |(k, v), memo|
-        memo[k.to_sym] = v
-      end
+      IniFile.load(file)[profile].transform_keys(&:to_sym)
     rescue StandardError
       raise Wavefront::Exception::InvalidConfigFile, file
     end

data/lib/wavefront-sdk/defs/version.rb

@@ -2,5 +2,5 @@
 
 require 'pathname'
 
-WF_SDK_VERSION = '5.4.1'
+WF_SDK_VERSION = '6.0.0'
 WF_SDK_LOCATION = Pathname.new(__dir__).parent.parent.parent

data/lib/wavefront-sdk/event.rb

@@ -12,7 +12,7 @@ module Wavefront
     include Wavefront::Mixin::Tag
 
     def update_keys
-      %i[startTime endTime name annotations]
+      %i[id name]
     end
 
     # GET /api/v2/event
@@ -28,6 +28,7 @@ module Wavefront
     # @param limit [Integer] the number of events to return
     # @return [Wavefront::Response]
     #
+    # rubocop:disable Metrics/ParameterLists
     def list(from = nil, to = Time.now, limit = 100, cursor = nil)
       raise ArgumentError unless from && to
 
@@ -37,6 +38,7 @@ module Wavefront
       wf_ms_ts?(body[:latestStartTimeEpochMillis])
       api.get('', body.cleanse)
     end
+    # rubocop:enable Metrics/ParameterLists
 
     # POST /api/v2/event
     # Create a specific event.
@@ -100,7 +102,9 @@ module Wavefront
 
       return api.put(id, body, 'application/json') unless modify
 
-      api.put(id, hash_for_update(describe(id), body), 'application/json')
+      api.put(id,
+              hash_for_update(describe(id).response, body),
+              'application/json')
     end
 
     # POST /api/v2/event/id/close
@@ -113,12 +117,75 @@ module Wavefront
       api.post([id, 'close'].uri_concat)
     end
 
-    def valid_id?(id)
+    # GET /api/v2/event/{id}/alertFiringDetails
+    # Return details of a particular alert firing, including all the series
+    # that fired during the referred alert firing
+    #
+    # @param id [String] ID of the event
+    # @return [Wavefront::Response]
+    #
+    def alert_firing_details(id)
+      wf_event_id?(id)
+      api.get([id, 'alertFiringDetails'].uri_concat)
+    end
+
+    # GET /api/v2/event/{id}/alertQueriesSlug
+    # If the specified event is associated with an alert, returns a slug
+    # encoding the queries having to do with that alert firing or resolution
+    # @param id [String] ID of the event
+    # @return [Wavefront::Response]
+    #
+    def alert_queries_slug(id)
+      wf_event_id?(id)
+      api.get([id, 'alertQueriesSlug'].uri_concat)
+    end
+
+    # GET /api/v2/event/{id}/events
+    # List all related events for a specific firing event with a time span of
+    # one hour
+    # @param id [String] ID of the event
+    # @param opts [Hash] containing one or more of
+    #   is_overlapped [Bool]
+    #   rendering_method [Symbol,String] one of :HOST, :METRIC, :SIMILARITY
+    #   limit [Integer]
+    # @return [Wavefront::Response]
+    #
+    def events(id, opts = {})
       wf_event_id?(id)
+
+      api.get([id, 'events'].uri_concat,
+              { isOverlapped: opts[:is_overlapped] || false,
+                renderingMethod: (opts[:rendering_method] || :HOST).to_s,
+                limit: opts[:limit] || nil }.compact)
+    end
+
+    # GET /api/v2/event/alertFirings
+    # Get firings events of an alert within a time range
+    # @param alert_id [String] ID of the alert
+    # @param opts [Hash] containing one or more of
+    #   earliest_start [Integer] epoch ms timestamp
+    #   latest_start [Integer] epoch ms timestamp
+    #   ascending [Bool]
+    #   limit [Integer]
+    # @return [Wavefront::Response]
+    #
+    def alert_firings(alert_id, opts = {})
+      wf_alert_id?(alert_id)
+
+      api.get('alertFirings',
+              { alertId: alert_id,
+                earliestStartTimeEpochMillis: opts[:earliest_start] || nil,
+                latestStartTimeEpochMillis: opts[:latest_start] || nil,
+                limit: opts[:limit] || nil,
+                asc: opts[:asc] || true }.compact)
     end
 
     private
 
+    def valid_id?(id)
+      wf_event_id?(id)
+    end
+
     def list_body(t_start, t_end, limit, cursor)
       { earliestStartTimeEpochMillis: parse_time(t_start, true),
         latestStartTimeEpochMillis: parse_time(t_end, true),