wavefront-cli 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 903c8e5083d5ea318618590cf9e366f451e6cf044037c9771791dd647703ec68
-  data.tar.gz: 7e4fe291218861044b5d117806eaecc17457da88079704fc3394eaebfcfabeca
+  metadata.gz: 367f4cd2831b3bb22eeae430ab3b3bd9f065d847a68b59f7f6ecafa39c46c156
+  data.tar.gz: 11e4a86ec0ed8134ce921b237a068cc2910e01b600becef4d35f7a49d35e3564
 SHA512:
-  metadata.gz: eb2afd54929d82f8f97dfee37de753f8c25d4e9f4f31c8413e174446f0d90264122b1002162b3beab2ce0f0caaddf52d029a71ca61a3178b4a99c4e698626761
-  data.tar.gz: 234cb0155c0abaffac24583945bdd4311d049dfec3788f5961fdc579de9339fc6ef4033c83cbdac92e7e7e7301ab7a453178e5ae94137f9ba0d1d212e3d02a6f
+  metadata.gz: faa0fecdf792a026db31353defb49e24cd5e72e8ff2d8702aa38846dd31af53abad50f9c79bed30ccb00b323196e9d9ba5da2f53c9318066dfd731898f93cafb
+  data.tar.gz: c6febba432e3dff6aa0a5125fd1b366dbcb59d9f056ca6f2924366b9dd9f01eb64423d4385488fbdc695649010c75f448f59e173d5333f737c6d26809a14ef3c

data/.gitlab-ci.yml

@@ -0,0 +1,16 @@
+dependency_scanning:
+  image: docker:stable
+  variables:
+    DOCKER_DRIVER: overlay2
+  allow_failure: true
+  services:
+    - docker:stable-dind
+  script:
+    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - docker run
+      --env DEP_SCAN_DISABLE_REMOTE_CHECKS="${DEP_SCAN_DISABLE_REMOTE_CHECKS:-false}"
+      --volume "$PWD:/code"
+      --volume /var/run/docker.sock:/var/run/docker.sock
+      "registry.gitlab.com/gitlab-org/security-products/dependency-scanning:$SP_VERSION" /code
+  artifacts:
+    paths: [gl-dependency-scanning-report.json]

data/.travis.yml

@@ -1,10 +1,10 @@
 language: ruby
 cache: bundler
 rvm:
-- 2.2.9
-- 2.3.6
-- 2.4.3
-- 2.5.0
+- 2.2.10
+- 2.3.7
+- 2.4.4
+- 2.5.1
 before_install: gem install bundler --no-rdoc --no-ri
 deploy:
   provider: rubygems
@@ -14,7 +14,7 @@ deploy:
   on:
     tags: true
     repo: snltd/wavefront-cli
-    ruby: 2.3.6
+    ruby: 2.5.1
 notifications:
   email: false
   slack:

data/HISTORY.md

@@ -0,0 +1,91 @@
+# Changelog
+
+## 2.5.0
+
+* Support [derived
+  metrics](https://docs.wavefront.com/derived_metrics.html).
+* Remove options which were not actually supported.
+* Smarter formatting of help pages.
+* Pass API warnings through the the user on `query` commands.
+* Add Unicode sparklines to `query` output.
+* Better formatting of `query` output.
+* Remove obsolete code and test files.
+
+## 2.4.0 (10/04/2017)
+
+* Support direct data ingestion via `report` command.
+* Support writing delta metrics.
+* Add `-q` to silenty write data points.
+* Export alerts, alert targets and dashboards in HCL format, for
+  easy integration with [Space Ape's
+  Terraform
+  provider](https://github.com/spaceapegames/terraform-provider-wavefront).
+
+## 2.3.1 (24/03/2017)
+
+* Fix broken handling of negative values in `write` command.
+
+## 2.3.0 (23/02/2017)
+
+* Add query aliases.
+
+## 2.2.0 (18/02/2017)
+
+* Add `alert firing` and `alert snoozed` subcommands.
+
+## 2.1.6 (11/01/2017)
+
+* Correctly handle `=` characters in `update` subcommands.
+
+## 2.1.5 (05/12/2017)
+
+* Allow the user to tag events when they are created.
+
+## 2.1.4 (15/11/2017)
+
+* `event create` bugfix.
+
+## 2.1.3 (31/10/2017)
+
+* Use credential mechanism from SDK instead of rolling our own.
+* Fix bug which ignored supposedly supported environment variables,
+  and add support for more.
+* Cut dead wood out of codebase.
+* Eradicate build warnings.
+
+## 2.1.2 (31/10/2017)
+
+* Fix no-op bug.
+* Add BSD license.
+
+## 2.1.1 (12/10/2017)
+
+* Fix bug in relative time specifications.
+
+## 2.1.0 (12/10/2017)
+
+* Allow users to specify relative times, like `-10m`.
+
+## 2.0.0 (09/10/2017)
+
+* Support viewing and managing of integrations.
+* Support notificants. (AKA alert targets).
+* Support new source descriptions.
+* Breaking change in `source` command.
+
+## 1.0.3 (25/08/2017)
+
+* Fix nil tag bug in terse source listing.
+
+## 1.0.2 (04/08/2017)
+
+* Greatly improve support for maintenance windows. They can now be
+  extended, shrunk, and closed and created on the fly.
+
+## 1.0.1 (31/07/2017)
+
+* Report `no data` if a query returns no data.
+
+## 1.0.0 (28/07/2017)
+
+* First official release.

data/README.md

@@ -1,6 +1,5 @@
 # Wavefront CLI
-[![Build Status](https://travis-ci.org/snltd/wavefront-cli.svg?branch=master)](https://travis-ci.org/snltd/wavefront-cli) [![Maintainability](https://api.codeclimate.com/v1/badges/9b712047af0b2dafc146/maintainability)](https://codeclimate.com/github/snltd/wavefront-cli/maintainability) [![Dependency Status](https://gemnasium.com/badges/github.com/snltd/wavefront-cli.svg)](https://gemnasium.com/github.com/snltd/wavefront-cli) [![Gem Version](https://badge.fury.io/rb/wavefront-cli.svg)](https://badge.fury.io/rb/wavefront-cli) ![](http://ruby-gem-downloads-badge.herokuapp.com/wavefront-cli?type=total)
-
+[![Build Status](https://travis-ci.org/snltd/wavefront-cli.svg?branch=master)](https://travis-ci.org/snltd/wavefront-cli) [![Maintainability](https://api.codeclimate.com/v1/badges/9b712047af0b2dafc146/maintainability)](https://codeclimate.com/github/snltd/wavefront-cli/maintainability) [![Gem Version](https://badge.fury.io/rb/wavefront-cli.svg)](https://badge.fury.io/rb/wavefront-cli) ![](http://ruby-gem-downloads-badge.herokuapp.com/wavefront-cli?type=total)
 
 This package provides a command-line interface to
 [Wavefront](https://www.wavefront.com/)'s API. Each API path

data/lib/wavefront-cli/alert.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontCli
   #

data/lib/wavefront-cli/base.rb

@@ -1,7 +1,7 @@
 require 'yaml'
 require 'json'
 require 'wavefront-sdk/validators'
-require_relative './exception'
+require_relative 'exception'
 
 module WavefrontCli
   #

data/lib/wavefront-cli/base_write.rb

@@ -1,5 +1,5 @@
 require 'wavefront-sdk/mixins'
-require_relative './base'
+require_relative 'base'
 
 module WavefrontCli
   #

data/lib/wavefront-cli/cloudintegration.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontCli
   #

data/lib/wavefront-cli/commands/alert.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 # Define the Alert command
 #

data/lib/wavefront-cli/commands/cloudintegration.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 # Define the cloud integration command.
 #

data/lib/wavefront-cli/commands/dashboard.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 # Define the dashboard command.
 #
@@ -10,11 +10,11 @@ class WavefrontCommandDashboard < WavefrontCommandBase
   def _commands
     ["list #{CMN} [-l] [-f format] [-o offset] [-L limit]",
      "describe #{CMN} [-f format] [-v version] <id>",
-     "import #{CMN} [-f format] [-F] <file>",
+     "import #{CMN} [-f format] <file>",
      "update #{CMN} <key=value> <id>",
      "delete #{CMN} <id>",
      "undelete #{CMN} <id>",
-     "history #{CMN} [-b] [-f format] [-o offset] [-L limit] <id>",
+     "history #{CMN} [-f format] [-o offset] [-L limit] <id>",
      "search #{CMN} [-f format] [-o offset] [-L limit] [-l] <condition>...",
      tag_commands]
   end

data/lib/wavefront-cli/commands/derivedmetric.rb

@@ -0,0 +1,48 @@
+require_relative 'base'
+
+# Define the derivedmetric command.
+#
+class WavefrontCommandDerivedmetric < WavefrontCommandBase
+  def description
+    'view and manage derived metrics'
+  end
+
+  def sdk_file
+    'derivedmetric'
+  end
+
+  def sdk_class
+    'DerivedMetric'
+  end
+
+  def _commands
+    ["list #{CMN} [-l] [-f format] [-o offset] [-L limit]",
+     "describe #{CMN} [-f format] [-v version] <id>",
+     "create #{CMN} [-d description] [-T tag...] [-O] [-i interval] " \
+     '[-r range] <name> <query>',
+     "import #{CMN} [-f format] <file>",
+     "update #{CMN} <key=value> <id>",
+     "delete #{CMN} <id>",
+     "undelete #{CMN} <id>",
+     "history #{CMN} [-f format] [-o offset] [-L limit] <id>",
+     "search #{CMN} [-f format] [-o offset] [-L limit] [-l] <condition>...",
+     tag_commands]
+  end
+
+  def _options
+    [common_options,
+     '-l, --long              list derived metrics in detail',
+     '-o, --offset=n          start list from nth derived metrics or ' \
+                              'revision',
+     '-L, --limit=COUNT       number of derived metrics or revisions to ' \
+                              'list',
+     '-v, --version=INTEGER   version of derived metrics',
+     '-O, --obsolete          include obsolete metrics',
+     '-T, --ctag=STRING       add customer tag',
+     '-d, --desc=STRING       additional information about query',
+     '-i, --interval=INTEGER  execute query every n minutes [default: 1]',
+     '-r, --range=INTEGER     include results in the last n minutes ' \
+                              '[default: 5]',
+     '-f, --format=STRING   output format']
+  end
+end

data/lib/wavefront-cli/commands/event.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 # Define the event command.
 #

data/lib/wavefront-cli/commands/integration.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 # Define the cloud integration command.
 #

data/lib/wavefront-cli/commands/link.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 # Define the external link command.
 #

data/lib/wavefront-cli/commands/message.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 # Define the message command.
 #

data/lib/wavefront-cli/commands/metric.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 # Define the metric command.
 #

data/lib/wavefront-cli/commands/notificant.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 # Define the notificant command.
 #

data/lib/wavefront-cli/commands/proxy.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 # Define the proxy command.
 #

data/lib/wavefront-cli/commands/query.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 # Define the query command.
 #
@@ -10,10 +10,10 @@ class WavefrontCommandQuery < WavefrontCommandBase
   def _commands
     ['aliases [-DV] [-c file] [-P profile]',
      "#{CMN} [-g granularity] [-s time] [-e time] [-f format] " \
-           '[-ivO] [-S mode] [-N name] [-p points] <query>',
+           '[-WikvO] [-S mode] [-N name] [-p points] <query>',
      "raw #{CMN} [-H host] [-s time] [-e time] [-f format] <metric>",
      "run #{CMN} [-g granularity] [-s time] [-e time] [-f format] " \
-           '[-ivO] [-S mode] [-N name] [-p points] <alias>']
+           '[-WkivO] [-S mode] [-N name] [-p points] <alias>']
   end
 
   def _options
@@ -30,6 +30,8 @@ class WavefrontCommandQuery < WavefrontCommandBase
      'points (mean, median, min, max, sum, count, last, first)',
      '-O, --obsolete            include metrics unreported for > 4 weeks',
      '-H, --host=STRING         host or source to query on',
-     '-f, --format=STRING       output format']
+     '-f, --format=STRING       output format',
+     '-k, --nospark             do not show sparkline',
+     '-W, --nowarn              do not show API warning messages']
   end
 end

data/lib/wavefront-cli/commands/report.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 # Define the report command.
 #

data/lib/wavefront-cli/commands/savedsearch.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 # Define the saved search command.
 #

data/lib/wavefront-cli/commands/source.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 # Define the source command.
 #

data/lib/wavefront-cli/commands/user.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 # Define the user command.
 #

data/lib/wavefront-cli/commands/webhook.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 # Define the webhook command.
 #

data/lib/wavefront-cli/commands/window.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 # Define the maintenance window command.
 #

data/lib/wavefront-cli/commands/write.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 # Define the write command.
 #

data/lib/wavefront-cli/controller.rb

@@ -12,9 +12,9 @@ end
 require 'pathname'
 require 'pp'
 require 'docopt'
-require_relative './version'
-require_relative './exception'
-require_relative './opt_handler'
+require_relative 'version'
+require_relative 'exception'
+require_relative 'opt_handler'
 
 CMD_DIR = Pathname.new(__FILE__).dirname + 'commands'
 

data/lib/wavefront-cli/dashboard.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontCli
   #

data/lib/wavefront-cli/derivedmetric.rb

@@ -0,0 +1,53 @@
+require_relative 'base'
+
+module WavefrontCli
+  #
+  # CLI coverage for the v2 'derivedmetric' API.
+  #
+  class DerivedMetric < WavefrontCli::Base
+    def validator_exception
+      Wavefront::Exception::InvalidDerivedMetricId
+    end
+
+    def do_describe
+      wf.describe(options[:'<id>'], options[:version])
+    end
+
+    def do_delete
+      word = if wf.describe(options[:'<id>']).status.code == 200
+               'Soft'
+             else
+               'Permanently'
+             end
+
+      puts format('%s deleting derived metric definition %s', word,
+                  options[:'<id>'])
+
+      wf.delete(options[:'<id>'])
+    end
+
+    def do_history
+      wf.history(options[:'<id>'])
+    end
+
+    def do_create
+      wf.create(build_body)
+    end
+
+    def build_body
+      ret = { query:                  options[:'<query>'],
+              name:                   options[:'<name>'],
+              minutes:                options[:range].to_i,
+              includeObsoleteMetrics: options[:obsolete],
+              processRateMinutes:     options[:interval].to_i }
+
+      ret[:additionalInformation] = options[:desc] if options[:desc]
+      ret[:tags] = options[:ctag] if valid_tags?
+      ret
+    end
+
+    def valid_tags?
+      !options[:ctag].empty? && validate_tags(options[:ctag])
+    end
+  end
+end