sensu-plugins-netscaler 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 417b5f1d25562554dea34e86753001bee2df66bb
-  data.tar.gz: 9056b3c033a6f296208a44a6e1d5abda3a504317
+  metadata.gz: 144a8f8b312273a6a9bafc38f172f68e6e5881fa
+  data.tar.gz: 25a837bf4becd193a2e4bf1edf1360f6140eb605
 SHA512:
-  metadata.gz: 9ceee66280827a85d58bd99300ef8aa3192c0da05a3086843705b3124a34c52523aa9414bdc684323d3da8352945f155acb39da02ebfd719159bd769f88cf694
-  data.tar.gz: 865c09ca32670484573df907ada1a2ece9d046e67830ebc3cf4da895af01f010449cb3f7463de00fcebc2f50af79c09a6933bd4e1c5d1c9c1ed3eebd8ed500df
+  metadata.gz: 3097ff1c25523d595dbf8a3fd8a20d740f28d10e73eb5fa40630f5938bb780eb5fbb2ea3e9ee2bd1fbc89c8fee5dd697158fc156962df1982487cac061ac00a2
+  data.tar.gz: df0f79930414ad35715c3ac9bc49ac348e186bdd9e3d15a7949c8374b3a2f6eb27ca3232fd4796720698a165e2f817a49f2cfcf0925a7135068011bc05340fd9

data/CHANGELOG.md

@@ -3,12 +3,23 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
 
-## Unreleased][unreleased]
+## [Unreleased][unreleased]
+
+## [0.1.0] - 2015-08-11
+### Added
+- Add metrics-netscaler.py plugin
+
+### Changed
+- bump rubocop
 
 ## [0.0.2] - 2015-07-14
 ### Changed
 - updated sensu-plugin gem to 1.2.0
 
-## [0.0.1] - 2015-06-04
+## 0.0.1 - 2015-06-04
 ### Added
 - initial release
+
+[unreleased]: https://github.com/sensu-plugins/sensu-plugins-netscaler/compare/0.1.0...HEAD
+[0.0.3]: https://github.com/sensu-plugins/sensu-plugins-netscaler/compare/0.0.2...0.1.0
+[0.0.2]: https://github.com/sensu-plugins/sensu-plugins-netscaler/compare/0.0.1...0.0.2

data/README.md

@@ -10,11 +10,12 @@
 ## Functionality
 
 ## Files
+- metrics-netscaler.py
 
 ## Usage
 
 ## Installation
 
-[Installation and Setup](https://github.com/sensu-plugins/documentation/blob/master/user_docs/installation_instructions.md)
+[Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)
 
 ## Notes

data/bin/metrics-netscaler.py

@@ -0,0 +1,175 @@
+#!/usr/bin/env python
+#
+# DESCRIPTION:
+# Grabs stats from a netscaler appliance via the Nitro REST API.
+# Prints to STDOUT in graphite format thus meant for a TCP handler
+# To find out what each stat means download the Nitro SDK
+# http://support.citrix.com/proddocs/topic/netscaler-main-api-10-map/ns-nitro-rest-feat-stat-api-ref.html
+# You should also be able to get the stats docs in a PDF that can be downloaded
+# from your netscaler web UI.
+#
+# OUTPUT:
+# Graphite plain-text format (name value timestamp\n)
+#
+# DEPENDENCIES:
+# Python 2.7 (untested on python 3 but should work fine)
+# Python Requests (http://docs.python-requests.org)
+#
+# LICENSE:
+# Jaime Gago contact@jaimegago.com
+# Released under the same terms as Sensu (the MIT license); see LICENSE
+# for details.
+import logging
+import logging.handlers
+import optparse
+import requests
+import sys
+import time
+
+FLAT_STATS_ENDPOINTS = [
+    'ns',
+    'cmp',
+    'ssl',
+    'system'
+    ]
+
+STATS_WITH_IDS = [
+    {
+      'endpoint' : 'lbvserver',
+      'identifier' : 'name'
+      },
+    {
+      'endpoint' : 'Interface',
+      'identifier' : 'id'
+      }
+    ]
+
+
+FAILURE_CONSTANT = 1
+
+def set_syslog():
+  '''Set a syslog logger'''
+  try:
+    logger = logging.getLogger(__name__)
+    logger.setLevel(logging.DEBUG)
+
+    formatter = logging.Formatter("%(pathname)s: %(message)s")
+
+    handler = logging.handlers.SysLogHandler(address = '/dev/log')
+    handler.setFormatter(formatter)
+    logger.addHandler(handler)
+  except Exception:
+    logging.critical("Failed to configure syslog handler")
+    sys.exit(1)
+  return logger
+
+def isfloat(value):
+  try:
+    float(value)
+    return True
+  except ValueError:
+    return False
+
+def graphite_printer(stats, graphite_scheme):
+  now = time.time()
+  for stat in stats:
+    print "%s.%s %s %d" % (graphite_scheme, stat, stats[stat], now)
+
+def get_flat_stats(flat_stats_end_points, nitro_version, netscaler, user,
+    password, logger):
+  nitro_rest_api = 'http://%s/nitro/%s/stat/' % (netscaler, nitro_version)
+  flat_stats = {}
+  for flat_stat_end_point in flat_stats_end_points:
+    url = nitro_rest_api + flat_stat_end_point
+    try:
+      response = requests.get(url, auth=(user, password))
+    except Exception as e:
+      logger.critical('Could not get JSON from %s' % url)
+      logger.critical(e)
+      sys.exit(FAILURE_CONSTANT)
+    data = response.json()
+    for flat_stat in data[flat_stat_end_point]:
+      value = data[flat_stat_end_point][flat_stat]
+      if isfloat(value):
+        flat_stats[flat_stat_end_point+ '.' + flat_stat] = value
+  return flat_stats
+
+def get_stats_with_ids(stat_with_ids_end_point, stat_identifier, nitro_version,
+    netscaler, user, password, logger):
+  nitro_rest_api = 'http://%s/nitro/%s/stat/' % (netscaler, nitro_version)
+  url = nitro_rest_api + stat_with_ids_end_point
+  stats_with_ids = {}
+  try:
+    response = requests.get(url, auth=(user, password))
+  except Exception as e:
+    logger.critical('Could not get JSON from %s' % url)
+    logger.critical(e)
+    sys.exit(FAILURE_CONSTANT)
+  data = response.json()
+  for stats in data[stat_with_ids_end_point]:
+    stat_id = stats[stat_identifier]
+    stat_id_alnum = ''.join(e for e in stat_id if e.isalnum())
+    for stat in stats:
+      value = stats[stat]
+      if isfloat(value):
+        stat_name = stat_with_ids_end_point + '.' + stat_id_alnum + '.' + stat
+        stats_with_ids[stat_name] = value
+  return stats_with_ids
+
+
+def main():
+  parser = optparse.OptionParser()
+
+  parser.add_option('-n', '--netscaler',
+    help    = 'netscaler (IP or FQDN) to collect stats from',
+    dest    = 'netscaler',
+    metavar = 'netscaler')
+
+  parser.add_option('-u', '--user',
+    help    = 'netscaler user with access to nitro rest',
+    dest    = 'user',
+    metavar = 'USER')
+
+  parser.add_option('-p', '--password',
+    help    = 'netscaler user password',
+    dest    = 'password',
+    metavar = 'PASSWORD')
+
+  parser.add_option('-s', '--graphite_scheme',
+    help    = 'graphite scheme to prepend, default to <netscaler>',
+    default = 'netscaler',
+    dest    = 'graphite_scheme',
+    metavar = 'GRAPHITE_SCHEME')
+
+  parser.add_option('-v', '--nitro-version',
+    help    = 'nitro REST API version, defaults to v1',
+    default = 'v1',
+    dest    = 'nitro_version',
+    metavar = 'NITRO_VERSION')
+
+  (options, args) = parser.parse_args()
+
+  if not options.netscaler or not options.user or not options.password:
+    print 'A netscaler, user and password are required'
+    sys.exit(FAILURE_CONSTANT)
+
+  nitro_version = options.nitro_version
+  netscaler = options.netscaler
+  user = options.user
+  password = options.password
+
+  logger = set_syslog()
+
+  flat_stats = get_flat_stats(FLAT_STATS_ENDPOINTS, nitro_version, netscaler, user,
+      password, logger)
+  graphite_printer(flat_stats, options.graphite_scheme)
+
+  for stat_with_ids in STATS_WITH_IDS:
+    stats_with_ids = get_stats_with_ids(stat_with_ids['endpoint'],
+        stat_with_ids['identifier'], nitro_version, netscaler, user, password,
+        logger)
+    graphite_printer(stats_with_ids, options.graphite_scheme)
+
+
+if __name__ == '__main__':
+  main()

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

@@ -1,8 +1,8 @@
 module SensuPluginsNetscaler
   module Version
     MAJOR = 0
-    MINOR = 0
-    PATCH = 2
+    MINOR = 1
+    PATCH = 0
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-netscaler
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
@@ -30,7 +30,7 @@ cert_chain:
   8sHuVruarogxxKPBzlL2is4EUb6oN/RdpGx2l4254+nyR+abg//Ed27Ym0PkB4lk
   HP0m8WSjZmFr109pE/sVsM5jtOCvogyujQOjNVGN4gz1wwPr
   -----END CERTIFICATE-----
-date: 2015-07-14 00:00:00.000000000 Z
+date: 2015-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -108,14 +108,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '0.30'
+        version: 0.32.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '0.30'
+        version: 0.32.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -181,6 +181,7 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
+- bin/metrics-netscaler.py
 - lib/sensu-plugins-netscaler.rb
 - lib/sensu-plugins-netscaler/version.rb
 homepage: https://github.com/sensu-plugins/sensu-plugins-netscaler
@@ -209,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for netscaler