sensu-cli

#
# Welcome to the sensu-cli.
#          ______
#       .-'      '-.
#     .'     __     '.
#    /      /  \      \
#    ------------------
#            /\
#           '--'
#         SENSU-CLI
#

A sensu-cli for interacting with the sensu api.

What is Sensu? http://sensuapp.org/

Features

• API interaction with info, health, stashes, events, clients, aggregates and checks
• Resolve Events
• Silence clients and checks
• Get Requests (get clients, stashes, events, etc.)
• 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.

host  "127.0.0.1"
port  "4567"
ssl   false
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

• If your Sensu API has basic auth, add the parameters to the config.

host  "127.0.0.1"
port  "4567"
ssl   false
user "some_user"
password "some_secret_password"

If read_timeout and open_timeout are not set, they default to 15 and 5 seconds respectively.

Expire Silenced Hosts/Checks

I added an expires option to sensu-cli silence to be used like sensu-cli silence HOST -e 30 where -e denotes the number of minutes from now a host/checks silence should expire. This won't work by itself. We add a key to the silence stash with a time in the future. If you run check-stashes on your sensu-server it will check for expired stashes and delete them.

There is also a reason option -r available. Be nice and use it so your colleagues know what you're doing.

Examples

Available subcommands: (for details, sensu SUB-COMMAND --help)

** Aggregate Commands **
sensu-cli aggregate list (OPTIONS)
sensu-cli aggregate show CHECK (OPTIONS)
sensu-cli aggregate delete CHECK

** Check Commands **
sensu-cli check list
sensu-cli check show CHECK
sensu-cli check request CHECK SUB1,SUB2

** Client Commands **
sensu-cli client list (OPTIONS)
sensu-cli client show NODE
sensu-cli client delete NODE
sensu-cli client history NODE

** Event Commands **
sensu-cli event list
sensu-cli event show NODE (OPTIONS)
sensu-cli event delete NODE CHECK

** Health Commands **
sensu-cli health (OPTIONS)

** Info Commands **
sensu-cli info

** Silence Commands **
sensu-cli silence NODE (OPTIONS)

** Stash Commands **
sensu-cli stash list (OPTIONS)
sensu-cli stash show STASHPATH
sensu-cli stash delete STASHPATH
sensu-cli stash create PATH

** Resolve Commands **
sensu-cli resolve NODE CHECK

  --version, -v:   Print version and exit
     --help, -h:   Show this message

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.

TODO

• cleanup the cli
• Once complete api support is implemented I'll add other features like filtering or issuing a event.

License and Author

I'm releasing this under the MIT or Apache 2.0 license. You pick.

Author:: Bryan Brandau agent462@gmail.com

Copyright:: 2013, Bryan Brandau

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.