sensu-plugins-graylog 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34875fc3e0b9379938f61e3dd91ee152958883a6
-  data.tar.gz: 7fa8d94e8e8626bf49adc3c3b81e6f3b8baeaff1
+  metadata.gz: 9305d0144c683c909d1891e7edd558e1a8685bbf
+  data.tar.gz: 6cfca28d71fbccd4e83ac8580afeeb6aabec35b9
 SHA512:
-  metadata.gz: 99751c6798ac9b26cf7a22e214e39cf215eae6af28977b707a9e62c0736b554da2d9e97f840171add79f73f75eb63d221428c7bfccf9fa720205ea290487b21f
-  data.tar.gz: ded6b4ad2ea4ebf9af0e88362527d7cbea3cc4bfa52e180608e36ac912792e4cb2a1aabfb2372b5c058b4ab637a6eb6977526a24910004cbf9ed5f3123eb48f4
+  metadata.gz: 39ef211ff1d170d227a78245a330e48d73bbc51fc20fd8de865a0d0c27e6b259cacff74e49c0128c957633298d90a7c8d2983c9177c8c34e76de37578a699449
+  data.tar.gz: 24852c0f9c0767040ede3775cd3fc2fb8863179e97b6d29fe8f75aee4cfb92e00110280474f5cc05f1ac9f43f73ae237544f740ca7321ea47445b49361edc758

data/CHANGELOG.md

@@ -5,6 +5,12 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 
 ## [Unreleased]
 
+## [1.1.0] - 2017-04-25
+### Changed
+- update readme to fix script names (@nathanhruby)
+
+### Added
+- add check-graylog-streams.rb to check and alert on paused streams (@nathanhruby)
 
 ## [1.0.0] - 2017-03-15
 This release drops support for Ruby 1.9.3 and converts `check-graylog-buffers` and `metrics-graylog`
@@ -44,7 +50,8 @@ in your environment is encouraged.
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-graylog/compare/1.0.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-graylog/compare/1.1.0...HEAD
+[1.1.0]: https://github.com/sensu-plugins/sensu-plugins-graylog/compare/1.0.0...1.1.0
 [1.0.0]: https://github.com/sensu-plugins/sensu-plugins-graylog/compare/0.1.0...1.0.0
 [0.1.0]: https://github.com/sensu-plugins/sensu-plugins-graylog/compare/0.0.2...0.1.0
 [0.0.2]: https://github.com/sensu-plugins/sensu-plugins-graylog/compare/0.0.1...0.0.2

data/README.md

@@ -10,9 +10,10 @@
 This plugin provides availability monitoring and metrics collection for the [Graylog](https://www.graylog.org/) log management system.
 
 ## Files
+ * bin/check-graylog-buffers.rb
+ * bin/check-graylog-streams.rb
  * bin/check-graylog2-alive.rb
- * bin/check-graylog-buffers.py
- * bin/metrics-graylog.py
+ * bin/metrics-graylog.rb
 
 ## Usage
 
@@ -22,5 +23,6 @@ This plugin provides availability monitoring and metrics collection for the [Gra
 
 ## Notes
 - If you want a limited access user for monitoring purposes please see the [Graylog FAQ](http://docs.graylog.org/en/latest/pages/faq.html#how-can-i-create-a-restricted-user-to-check-internal-graylog-metrics-in-my-monitoring-system+)
+  - A limited user must also have the "streams:read" permission on their role in order to use the check-graylog-streams.rb check
 - Users may further obfuscate their credentials by creating an [Access Token](http://docs.graylog.org/en/latest/pages/configuration/rest_api.html?highlight=access%20tokens#creating-and-using-access-token) to use instead of their normal login credentials.
   - Note that only an admin may create a token by default.  If you want to have a dedicated monitoring user with an access token you will need to create them as a Admin user, create the token, then change the user to the monitoring specific role. You can change the default behavior by granting `users:tokencreate`, `users:tokenlist`, and `users:tokenremove` to a role and adding that role to the monitoring user.

data/bin/check-graylog-streams.rb

@@ -0,0 +1,91 @@
+#!/usr/bin/env ruby
+#
+# Checks Graylog paused streams
+# ===
+#
+# DESCRIPTION:
+#   This plugin checks Graylog for any 'paused' streams.
+#
+# OUTPUT:
+#   plain-text
+#
+# PLATFORMS:
+#   all
+#
+# DEPENDENCIES:
+#   A graylog user with streams:read permission (admin or role perm)
+#
+# LICENSE:
+#   Seandy Wibowo <swibowo@sugarcrm.com>
+#   nathan hruby <nhruby@sugarcrm.com>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+
+require 'sensu-plugin/check/cli'
+require 'rest-client'
+require 'json'
+
+class CheckGraylogStreams < Sensu::Plugin::Check::CLI
+  option :username,
+         short:       '-u',
+         long:        '--username USERNAME',
+         description: 'Graylog Username',
+         required:    true
+
+  option :password,
+         short:       '-p',
+         long:        '--password PASSWORD',
+         description: 'Graylog Password',
+         required:    true
+
+  option :host,
+         short:       '-h',
+         long:        '--host GRAYLOG_HOST',
+         description: 'Graylog host to query',
+         default:     'localhost'
+
+  option :port,
+         short:       '-P',
+         long:        '--port GRAYLOG_PORT',
+         description: 'Graylog port to query',
+         default:     12_900
+
+  option :apipath,
+         short:       '-a',
+         long:        '--apipath /api',
+         description: 'Graylog API path prefix',
+         default:     ''
+
+  def graylog_streams
+    resource = RestClient::Resource.new(
+      "http://#{config[:host]}:#{config[:port]}#{config[:apipath]}/streams",
+      user: config[:username],
+      password: config[:password],
+      timeout: 10
+    )
+    JSON.parse(resource.get, symbolize_names: true)
+
+  rescue RestClient::RequestTimeout
+    unknown 'Connection timeout'
+  rescue SocketError
+    unknown 'Network unavailable'
+  rescue RestClient::Unauthorized
+    unknown 'Missing or incorrect API credentials'
+  rescue JSON::ParserError
+    unknown 'API returned invalid JSON'
+  end
+
+  def run
+    streams = graylog_streams
+    disabled_streams = streams[:streams].select { |s| (s[:disabled] == true) }
+
+    if disabled_streams.count > 0
+      streams_desc = []
+      disabled_streams.each { |v| streams_desc.push(v[:title]) }
+
+      critical("Streams currently paused/disabled: #{streams_desc.join(', ')}")
+    else
+      ok('No streams are paused')
+    end
+  end
+end

data/lib/sensu-plugins-graylog/version.rb

@@ -1,7 +1,7 @@
 module SensuPluginsGraylog
   module Version
     MAJOR = 1
-    MINOR = 0
+    MINOR = 1
     PATCH = 0
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-graylog
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-16 00:00:00.000000000 Z
+date: 2017-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -182,6 +182,7 @@ description: Sensu graylog plugins
 email: "<sensu-users@googlegroups.com>"
 executables:
 - check-graylog-buffers.rb
+- check-graylog-streams.rb
 - check-graylog2-alive.rb
 - metrics-graylog.rb
 extensions: []
@@ -192,6 +193,7 @@ files:
 - README.md
 - bin/check-graylog-buffers.py
 - bin/check-graylog-buffers.rb
+- bin/check-graylog-streams.rb
 - bin/check-graylog2-alive.rb
 - bin/metrics-graylog.py
 - bin/metrics-graylog.rb