sensu-cli 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b31028364300b102bb6e93d2b2e9ad975f8584dd
-  data.tar.gz: 90d6965b752621f42420c930db92fad2a65d10a5
+  metadata.gz: 546537d8a2709dc4b64d0bd982ffe216a09d91cf
+  data.tar.gz: 178295249672c82615cf7ad97d410d93bb5fd128
 SHA512:
-  metadata.gz: 38a34f132d4a8b5799bc05faea57b075fc58b6a375985fd334ddd4274a417100de259ad21f98cc26fe1966c94ecbe2f4f22dedd98d5dc92237b7acc3b9653200
-  data.tar.gz: 77d84377e361fc299680a37a0e9a22edc9ef3aeab5ded344e9576cd8c3c6d3bf45325dd1d842e8c5339e33ff5df8d222ed7ad2fd459c26821c5b857e35b5137a
+  metadata.gz: d8b38cb52fef977e61637ebdc7061bcd46d071c434090d74caeb2b0b64bed0471ea31cd657363973316bbe80bb74ad1dab6da903009428ca817936a16794a7db
+  data.tar.gz: bcdd5b0965bae88c8220f83315da775c36085966774f576d87a83bf33a31fd3637e6762f3d02fed13e40d7f27f1b483e7e5a8afe17702dd20bb466794a135940

data/README.md

@@ -1,5 +1,4 @@
-sensu-cli
-=========
+# sensu-cli
 ```
 #
 # Welcome to the sensu-cli.
@@ -17,8 +16,8 @@ A sensu-cli for interacting with the sensu api.
 
 What is Sensu? http://sensuapp.org/
 
-Features
---------
+## Features
+
 * API interaction with info, health, stashes, events, clients, aggregates and checks
 * Resolve Events
 * Silence clients and checks
@@ -26,12 +25,14 @@ Features
 * Delete Requests (delete clients, stashes, aggregates and events)
 
 
-Usage and Configuration
------------------------
-* gem install sensu-cli
-
-* There is one settings file for host, port, ssl, and HTTP timeout that lives in your user directory ~/.sensu/settings.rb.  You can alternatively place this in /etc/sensu/sensu-cli/settings.rb.
+## Usage and Configuration
 
+* Installation: `gem install sensu-cli`
+* Installation using the embedded Sensu ruby: `/opt/sensu/embedded/bin/gem install sensu-cli && ln -s /opt/sensu/embedded/bin/sensu-cli /usr/local/bin/`
+* There is one settings file for host, port, ssl, and HTTP timeout that lives
+  in your user directory `~/.sensu/settings.rb`.  You can alternatively place
+  this in `/etc/sensu/sensu-cli/settings.rb`.
+* An example config file:
 ````
 host  "127.0.0.1"
 port  "4567"
@@ -40,23 +41,26 @@ api_endpoint "/api"
 read_timeout 20
 open_timeout 20
 ````
-This format was chosen so you can do some ENV magic via your profile and setting up an alias. For details see the [wiki](https://github.com/agent462/sensu-cli/wiki)
-
-* All Configuration Settings    
-`host` String - Required - Host of the Sensu API    
-`port` String/Integer - Required - Port of the Sensu API    
-`ssl`  Boolean - Optional - Defaults False    
-`api_endpoint` String - Optional - Default ''    
-`read_timeout` Integer - Optional - Default 15 (seconds)    
-`open_timeout` Integer - Optional - Default 5 (seconds)    
-`pretty_colors` Boolean - Optional - Default True    
-`proxy_address` String - Optional    
-`proxy_port` Integer - Optional    
-`user` String - Optional - User for the Sensu API    
-`password` String - Optional - Password for the Sensu API    
-
-Examples
------------
+
+This format was chosen so you can do some ENV magic via your profile and
+setting up an alias. For details see the
+[wiki](https://github.com/agent462/sensu-cli/wiki)
+
+All Configuration Settings:
+* `host` String - Required - Host of the Sensu API
+* `port` String/Integer - Required - Port of the Sensu API
+* `ssl`  Boolean - Optional - Defaults False
+* `api_endpoint` String - Optional - Default ''
+* `read_timeout` Integer - Optional - Default 15 (seconds)
+* `open_timeout` Integer - Optional - Default 5 (seconds)
+* `pretty_colors` Boolean - Optional - Default True
+* `proxy_address` String - Optional
+* `proxy_port` Integer - Optional
+* `user` String - Optional - User for the Sensu API
+* `password` String - Optional - Password for the Sensu API
+
+## Examples
+
 ````
 Available subcommands: (for details, sensu SUB-COMMAND --help)
 
@@ -107,8 +111,7 @@ sensu-cli socket raw INPUT
      --help, -h:   Show this message
 ````
 
-Filters
--------
+### Filters
 
 Filters are strings in 'key,value' format.
 
@@ -122,24 +125,73 @@ sensu-cli event list -i name,foo
 sensu-cli event list -i output,foo
 ````
 
-Socket
--------
-This command can only be used on a host that is running sensu-client.  sensu-client exposes a socket for arbritary check results.  For more information you can see the [sensu client documentation](https://sensuapp.org/docs/0.18/clients#client-socket-input).
+### Socket
+
+This command can only be used on a host that is running sensu-client.
+The sensu-client exposes a socket for arbritary check results. For more
+information you can see the [sensu client documentation](https://sensuapp.org/docs/0.25/reference/clients.html#client-socket-input).
+
+Examples:
 ````
 # send a check result to the sensu server
-sensu-cli socket create -name "host33" --output "Something broke really bad" --status 1
+sensu-cli socket create --name "check33" --output "Warn: Something broke really bad" --status 1
 
 # send raw json check result to the sensu server
-sensu-cli socket raw '{"name": "host34", "output": "Something broke even worse than on host33", "status": 1}'
+sensu-cli socket raw '{"name": "check34", "output": "Crit: Something broke even worse than on check33", "status": 2}'
+
+# send raw json check result to the sensu server, faking the source
+sensu-cli socket raw '{"name": "snmp", "output": "Crit: SNMP is bad on this switch", "status": 2, "source": "switch01"}'
 ````
 
-Contributions
--------------
-Please provide a pull request.  I'm an ops guy, not a developer, so if you're submitting code cleanup, all I ask is that you explain the improvement so I can learn.
+### Advanced Examples
+
+These advanced examples show off the power of being able to use the
+sensu-cli tool in combination with other command line tools. Some use
+the [jq](https://stedolan.github.io/jq/) command to do JSON parsing.
+
+#### Have a host silence itself
+
+```bash
+sensu-cli silence `hostname -f` --owner root --reason "This server was just created" --expire 3600
+```
+
+#### Silence any client that has the word "test" in the name
+
+```bash
+sensu-cli client list -f json |
+  jq -r .[].name |
+  grep "test" |
+  xargs --verbose --no-run-if-empty -n1 sensu-cli silence
+```
+
+#### Delete sliences older than 3 days
+
+```bash
+THRESHOLD=$(date +%s --date="3 days ago")
+sensu-cli stash list --format json |
+  jq -r "map(select( .[\"content\"][\"timestamp\"] < $THRESHOLD )) | .[].path " |
+  xargs --verbose --no-run-if-empty -n1 sensu-cli stash delete
+```
+
+#### Resolve any checks that haven't checked in in a month
+
+```bash
+THRESHOLD=$(date +%s --date="1 month ago")
+sensu-cli event list --format json |
+  jq --raw-output "map(select( .[\"check\"][\"issued\"] < $THRESHOLD )) | .[] | .client.name + \" \" +  .check.name " |
+  xargs --verbose --no-run-if-empty -n2 sensu-cli resolve
+```
+
+
+### Contributions
+
+Please provide a pull request. I'm an ops guy, not a developer, so if you're
+submitting code cleanup, all I ask is that you explain the improvement so I can
+learn.
+
 
+## License and Author
 
-License and Author
-==================
 I'm releasing this under the MIT or Apache 2.0 license.  You pick.
 
 Author:: Bryan Brandau <agent462@gmail.com>

data/lib/sensu-cli/api.rb

@@ -39,11 +39,13 @@ module SensuCli
         JSON.parse(body)
       when '201'
         puts 'The stash has been created.' if command == 'stashes' || command == 'silence'
+        puts 'The silence has been created.' if command == 'silenced'
       when '202'
         puts 'The item was submitted for processing.'
       when '204'
         puts 'Sensu is healthy' if command == 'health'
         puts 'The item was successfully deleted.' if command == 'aggregates' || command == 'stashes'
+        puts 'The silence has been cleared.' if command == 'silenced'
       when '400'
         puts 'The payload is malformed.'.color(:red)
       when '401'

data/lib/sensu-cli/base.rb

@@ -31,7 +31,11 @@ module SensuCli
       else
         settings.create(directory, file)
       end
-      Rainbow.enabled = Config.pretty_colors == false ? false : true
+      if $stdout.isatty and not Config.pretty_colors == false
+        Rainbow.enabled = true
+      else
+        Rainbow.enabled = false
+      end
     end
 
     def api_path(cli)

data/lib/sensu-cli/cli.rb

@@ -4,17 +4,18 @@ require 'rainbow/ext/string'
 
 module SensuCli
   class Cli # rubocop:disable ClassLength
-    SUB_COMMANDS    = %w(info client check event stash aggregate silence resolve health socket)
-    CLIENT_COMMANDS = %w(list show delete history)
-    CHECK_COMMANDS  = %w(list show request)
-    EVENT_COMMANDS  = %w(list show delete)
-    STASH_COMMANDS  = %w(list show delete create)
-    AGG_COMMANDS    = %w(list show delete)
-    SIL_COMMANDS    = ''
-    RES_COMMANDS    = ''
-    INFO_COMMANDS   = ''
-    HEALTH_COMMANDS = ''
-    SOCKET_COMMANDS = %w(create raw)
+    SUB_COMMANDS    = %w[info client check event stash aggregate silence silenced resolve health socket].freeze
+    CLIENT_COMMANDS = %w[list show delete history].freeze
+    CHECK_COMMANDS  = %w[list show request].freeze
+    EVENT_COMMANDS  = %w[list show delete].freeze
+    STASH_COMMANDS  = %w[list show delete create].freeze
+    AGG_COMMANDS    = %w[list show delete].freeze
+    SIL_COMMANDS    = ''.freeze
+    SILD_COMMANDS   = %w[list create clear].freeze
+    RES_COMMANDS    = ''.freeze
+    INFO_COMMANDS   = ''.freeze
+    HEALTH_COMMANDS = ''.freeze
+    SOCKET_COMMANDS = %w[create raw].freeze
 
     CLIENT_BANNER = <<-EOS.gsub(/^ {10}/, '')
           ** Client Commands **
@@ -60,6 +61,14 @@ module SensuCli
           ** Silence Commands **
           sensu-cli silence NODE (OPTIONS)\n\r
         EOS
+    SILD_BANNER = <<-EOS.gsub(/^ {10}/, '')
+          ** Silenced Commands **
+          sensu-cli silenced list (OPTIONS)
+          sensu-cli silenced create (OPTIONS)
+          sensu-cli silenced clear (OPTIONS)
+
+          Supported only in Sensu 0.26+\n\r
+        EOS
     RES_BANNER = <<-EOS.gsub(/^ {10}/, '')
           ** Resolve Commands **
           sensu-cli resolve NODE CHECK\n\r
@@ -93,17 +102,16 @@ module SensuCli
         banner HEALTH_BANNER
         banner INFO_BANNER
         banner SIL_BANNER
+        banner SILD_BANNER
         banner STASH_BANNER
         banner RES_BANNER
         banner SOCKET_BANNER
         stop_on SUB_COMMANDS
       end
-
       Trollop::with_standard_exception_handling global_opts do
         global_opts.parse ARGV
         raise Trollop::HelpNeeded if ARGV.empty? # show help screen
       end
-
       cmd = next_argv
       self.respond_to?(cmd) ? send(cmd) : explode(global_opts)
     end
@@ -302,12 +310,52 @@ module SensuCli
         opt :owner, 'The owner of the stash', :short => 'o', :type => :string
         opt :reason, 'The reason this check/node is being silenced', :short => 'r', :type => :string
         opt :expire, 'The number of seconds the silenced event is valid', :short => 'e', :type => :integer
+        opt :source, 'The name of the source of the silence', :short => 's', :type => :string, :default => 'sensu-cli'
       end
       command = next_argv
       explode(opts) if command.nil?
       deep_merge({ :command => 'silence', :method => 'Post', :fields => { :client => command } }, { :fields => p })
     end
 
+    def silenced
+      opts = parser('SILD')
+      command = next_argv
+      explode_if_empty(opts, command)
+      case command
+      when 'list'
+        p = Trollop::options do
+          opt :check, 'The check entries to return', :short => 'c', :type => :string
+          opt :subscription, 'The subscription entries to return', :short => 's', :type => :string
+          opt :limit, 'The number of aggregates to return', :short => 'l', :type => :string
+          opt :offset, 'The number of aggregates to offset before returning', :short => 'o', :type => :string
+        end
+        Trollop::die :offset, 'Offset depends on the limit option --limit ( -l )'.color(:red) if p[:offset] && !p[:limit]
+        { :command => 'silenced', :method => 'Get', :fields => p }
+      when 'create'
+        p = Trollop::options do
+          opt :check, 'The check to silence', :short => 'c', :type => :string
+          opt :creator, 'The owner of the stash', :short => 'o', :type => :string
+          opt :reason, 'The reason this check/node is being silenced', :short => 'r', :type => :string, :default => 'Silenced via API - no reason given'
+          opt :expire, 'The number of seconds the silenced event is valid', :short => 'e', :type => :integer
+          opt :expire_on_resolve, 'Entry will be automatically cleared once resolved', :short => 'f', :type => :boolean
+          opt :source, 'The name of the source of the silence', :short => 's', :type => :string, :default => 'sensu-cli'
+          opt :subscription, 'The name of the subscription to silence', :short => 'n', :type => :string
+        end
+        Trollop::die :check, 'Check or Subscription is required'.color(:red) if !p[:check] && !p[:subscription]
+        deep_merge({ :command => 'silenced', :method => 'Post', :fields => { :create => true } }, { :fields => p })
+      when 'clear'
+        p = Trollop::options do
+          opt :id, 'The id of the silenced item', :short => 'i', :type => :string
+          opt :check, 'The check of the silenced item', :short => 'c', :type => :string
+          opt :subscription, 'The subscription of the silenced item', :short => 's', :type => :string
+        end
+        Trollop::die :id, 'ID, Check or Subscription is required'.color(:red) if !p[:check] && !p[:subscription] && !p[:id]
+        { :command => 'silenced', :method => 'Post', :clear => true, :fields => p }
+      else
+        explode(opts)
+      end
+    end
+
     def resolve
       opts = parser('RES')
       command = next_argv
@@ -330,7 +378,7 @@ module SensuCli
         end
         { :command => 'socket', :method => 'create', :fields => p }
       when 'raw'
-        p = Trollop::options
+        Trollop::options
         { :command => 'socket', :method => 'raw', :raw => next_argv }
       else
         explode(opts)

data/lib/sensu-cli/path.rb

@@ -58,6 +58,7 @@ module SensuCli
       content = { :timestamp => Time.now.to_i }
       content.merge!(:owner => cli[:fields][:owner]) if cli[:fields][:owner]
       content.merge!(:reason => cli[:fields][:reason]) if cli[:fields][:reason]
+      content.merge!(:source => cli[:fields][:source]) if cli[:fields][:source]
       payload = { :content =>  content }
       payload.merge!(:expire => cli[:fields][:expire].to_i) if cli[:fields][:expire]
       silence_path = 'silence'
@@ -67,6 +68,25 @@ module SensuCli
       respond('/stashes', payload)
     end
 
+    def silenced(cli)
+      payload = {}
+      if !cli[:fields][:creator] && cli[:method] == 'Post'
+        cli[:fields][:creator] = `whoami`.strip if %w[darwin linux].any? { |word| RUBY_PLATFORM.include?(word) }
+      end
+      payload.merge!(:creator => cli[:fields][:creator]) if cli[:fields][:creator]
+      payload.merge!(:reason => cli[:fields][:reason]) if cli[:fields][:reason]
+      payload.merge!(:expire => cli[:fields][:expire].to_i) if cli[:fields][:expire]
+      payload.merge!(:expire_on_resolve => cli[:fields][:expire_on_resolve]) if cli[:fields][:expire_on_resolve]
+      payload.merge!(:check => cli[:fields][:check]) if cli[:fields][:check]
+      payload.merge!(:subscription => cli[:fields][:subscription]) if cli[:fields][:subscription]
+      silenced_path = '/silenced'
+      silenced_path << "/subscriptions/#{cli[:fields][:subscription]}" if cli[:fields][:subscription] && cli[:method] == 'Get'
+      silenced_path << "/checks/#{cli[:fields][:check]}" if cli[:fields][:check] && cli[:method] == 'Get'
+      silenced_path << "/clear" if cli[:clear]
+      silenced_path << pagination(cli)
+      respond(silenced_path, payload.to_json)
+    end
+
     def aggregates(cli)
       path = '/aggregates'
       path << "/#{cli[:fields][:check]}" if cli[:fields][:check]
@@ -90,7 +110,7 @@ module SensuCli
     end
 
     def respond(path, payload = false)
-      { :path => "#{Config.api_endpoint}#{path}", :payload => payload }
+      { :path => ::File.join(Config.api_endpoint.to_s, path), :payload => payload }
     end
   end
 end

data/lib/sensu-cli/templates/event.erb

@@ -11,7 +11,13 @@
   <%= "interval:".color(:cyan) %> <%= check['interval'].to_s.color(:green) %>
   <%= "subscribers:".color(:cyan) %> <%= check['subscribers'].to_s.color(:green) %>
   <%= "issued:".color(:cyan) %> <%= check['issued'].to_s.color(:green) %>
+  <% if check['issued'] -%>
+  <%= "issued_s:".color(:cyan) %> <%= Time.at(check['issued']).to_s.color(:green) %>
+  <% end -%>
   <%= "executed:".color(:cyan) %> <%= check['executed'].to_s.color(:green) %>
+  <% if check['executed'] -%>
+  <%= "executed_s:".color(:cyan) %> <%= Time.at(check['executed']).to_s.color(:green) %>
+  <% end -%>
   <%= "duration:".color(:cyan) %> <%= check['duration'].to_s.color(:green) %>
   <%= "output:".color(:cyan) %> <%= check['output'].rstrip.to_s.color(:green) %>
   <%= "status:".color(:cyan) %> <%= check['status'].to_s.color(:green) %>

data/lib/sensu-cli/version.rb

@@ -1,3 +1,3 @@
 module SensuCli
-  VERSION = '0.7.1'
+  VERSION = '0.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-cli
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Bryan Brandau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-23 00:00:00.000000000 Z
+date: 2017-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -42,14 +42,14 @@ dependencies:
   name: mixlib-config
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
 - !ruby/object:Gem::Dependency
@@ -84,28 +84,28 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A command line utility for interacting with the Sensu api.
@@ -144,17 +144,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: A command line utility for Sensu.