sensu-extensions-system-profile-wmi 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6531b4394898319ca773b79139b4653f7316de92
+  data.tar.gz: a60898ca6eb50f15075d311d63af7e0b747208ee
+SHA512:
+  metadata.gz: affe75ff3f9950630b2dbec0825fd250083471405ea54f63a40e8d13d09a065ce4b85b2db6c1b1e6d3c3ae76ba1572b390217f21277bbb509eba0d6203c7fa8e
+  data.tar.gz: 769f3bfcc620ae1d8da24022ab472c1927c524a96d556aa9814cef19aa93648ce55f450cd7f55c70cf9485bc7f53665f484179106f55413cdd8a601186d1989e

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Change Log
+
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/).
+
+## [Unreleased]
+
+## 1.0.0 - 2016-01-01
+
+### Added
+
+- Initial release.
+
+## The Before Time
+
+This extension was originally committed to the now-defunct
+sensu-community-plugins repository in April of 2014. With the advent of
+extension gem loading in Sensu 0.26, [the most recent version of the
+extension commited to that repo][community-repo-commit] is relesed here as version 1.0.0.
+
+Complete change history prior to 1.0.0 is available [here][before-time-changes].
+
+[community-repo-commit]: https://github.com/sensu/sensu-community-plugins/blob/14edca8b46753e1444363d5fc294f2502e70d198/extensions/checks/wmi_metrics.rb
+[before-time-changes]: https://github.com/sensu/sensu-community-plugins/commits/e58c1f3ce39c6c0ca271fadd470c04362e92b190/extensions/checks/wmi_metrics.rb
+[Unreleased]: https://github.com/sensu-extensions/sensu-extensions-system-profile-wmi/compare/v1.0.0...HEAD

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Sensu-Extensions
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# Sensu::Extensions::SystemProfileWmi
+
+This check extension collects Windows system metrics using the SVCHOST WMI
+service, and formats them as plaintext Graphite data.
+
+## Installation
+
+1. Install this gem using sensu-install
+
+    ``` bash
+    $ sensu-install -e sensu-extensions-system-profile-wmi
+    ```
+
+2. Configure Sensu to load the extension, as [documented here][0].
+
+    ``` json
+    {
+      "extensions": {
+        "system-profile-wmi": {
+          "gem": "sensu-extensions-system-profile-wmi"
+        }
+      }
+    }
+    ```
+
+## Configuration
+
+`/etc/sensu/conf.d/system_profile.json`:
+
+``` json
+{
+  "wmi_metrics": {
+    "interval": 10,
+    "handler": "graphite",
+    "add_client_prefix": true,
+    "path_prefix": "system",
+    "prefix_at_start": true
+  }
+}
+```
+
+[0]: https://sensuapp.org/docs/latest/reference/extensions.html

data/lib/sensu/extensions/system-profile-wmi.rb

@@ -0,0 +1,196 @@
+# WMI Metrics
+# ===
+#
+# Collects a variety of system metrics every 10 seconds (by default).
+# Expects a "graphite" handler on the Sensu server, eg:
+#
+# "graphite": {
+#   "type": "tcp",
+#   "socket": {
+#     "host": "graphite.hw-ops.com",
+#     "port": 2003
+#   },
+#   "mutator": "only_check_output"
+# }
+#
+# Copyright 2016 Heavy Water Operations, LLC.
+#
+# Changelog
+# ----------
+# 03/11/2015 - Alan Smith (@cloakedcode) added cumulative metric
+#              collection for network traffic over interval timespan.
+#
+# Released under the same terms as Sensu (the MIT license); see LICENSE
+# for details.
+
+require 'sensu/extension'
+require 'win32ole'
+
+module Sensu
+  module Extension
+    class SystemProfileWMI < Check
+      def name
+        'wmi_metrics'
+      end
+
+      def description
+        'collects system metrics, using wmi and the graphite plain-text format'
+      end
+
+      def definition
+        {
+          type: 'metric',
+          name: name,
+          interval: options[:interval],
+          standalone: true,
+          handler: options[:handler]
+        }
+      end
+
+      def post_init
+        @metrics = {}
+        @wmi = WIN32OLE.connect('winmgmts://')
+
+        # setup timer for cumulative metrics
+        EM.add_periodic_timer(1) do
+          network_interface_metrics do
+          end
+        end
+        true
+      end
+
+      def run
+        memory_metrics do
+          disk_metrics do
+            cpu_metrics do
+              yield flush_metrics, 0
+            end
+          end
+        end
+      end
+
+      private
+
+      def options
+        return @options if @options
+        @options = {
+          interval: 60,
+          handler: 'graphite',
+          add_client_prefix: true,
+          path_prefix: 'WMI',
+          prefix_at_start: 0
+        }
+        if settings[:wmi_metrics].is_a?(Hash)
+          @options.merge!(settings[:wmi_metrics])
+        end
+        @options
+      end
+
+      def flush_metrics
+        metrics = @metrics.map { |k, v| [k, v, Time.now.to_i].join(' ') }
+        @metrics = {}
+        metrics.join("\n") + "\n"
+      end
+
+      def add_metric(*args)
+        value = args.pop
+        path = []
+        path << options[:path_prefix] if options[:prefix_at_start]
+        path << settings[:client][:name] if options[:add_client_prefix]
+        path << options[:path_prefix] unless options[:prefix_at_start]
+        path = (path + args).join('.')
+
+        @metrics[path] = 0 if @metrics[path].nil?
+        @metrics[path] += value.to_i
+      end
+
+      def formatted_perf_data(provider, &_callback)
+        full_provider = 'Win32_PerfFormattedData_' + provider
+        EM.next_tick do
+          result = []
+          begin
+            result = @wmi.ExecQuery('select * from ' + full_provider)
+          rescue => error
+            @logger.debug('wmi query error', error: error.to_s)
+          end
+          yield result
+        end
+      end
+
+      def memory_metrics
+        formatted_perf_data('PerfOS_Memory') do |result|
+          result.each do |data|
+            %w(
+              AvailableBytes
+              CacheBytes
+              CommittedBytes
+            ).each do |point|
+              add_metric('Memory', point, data.send(point.to_sym))
+            end
+          end
+          yield
+        end
+      end
+
+      def disk_metrics
+        formatted_perf_data('PerfDisk_LogicalDisk') do |disks|
+          disks.each do |data|
+            %w(
+              AvgDiskQueueLength
+              FreeMegabytes
+              PercentDiskTime
+              PercentFreeSpace
+            ).each do |point|
+              disk_name = data.Name.gsub(/[^0-9a-z]/i, '')
+              add_metric('Disk', disk_name, point, data.send(point.to_sym))
+            end
+          end
+          yield
+        end
+      end
+
+      def cpu_metrics
+        formatted_perf_data('PerfOS_Processor') do |processors|
+          processors.each do |data|
+            %w(
+              InterruptsPerSec
+              PercentIdleTime
+              PercentInterruptTime
+              PercentPrivilegedTime
+              PercentProcessorTime
+              PercentUserTime
+            ).each do |point|
+              cpu_name = data.Name.gsub(/[^0-9a-z]/i, '')
+              add_metric('CPU', cpu_name, point, data.send(point.to_sym))
+            end
+          end
+          yield
+        end
+      end
+
+      def network_interface_metrics
+        formatted_perf_data('Tcpip_NetworkInterface') do |interfaces|
+          interfaces.each do |data|
+            %w(
+              BytesReceivedPerSec
+              BytesSentPerSec
+              BytesTotalPerSec
+              OutputQueueLength
+              PacketsOutboundDiscarded
+              PacketsOutboundErrors
+              PacketsPerSec
+              PacketsReceivedDiscarded
+              PacketsReceivedErrors
+              PacketsReceivedPerSec
+              PacketsSentPerSec
+            ).each do |point|
+              interface_name = data.Name.gsub(/[^0-9a-z]/i, '')
+              add_metric('Interface', interface_name, point, data.send(point.to_sym))
+            end
+          end
+          yield
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: sensu-extensions-system-profile-wmi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sensu-Extensions and contributors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sensu-extension
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: sensu-logger
+  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: sensu-settings
+  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: EXTENSION_TYPE extension to do X
+email:
+- "<sensu-users@googlegroups.com>"
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/sensu/extensions/system-profile-wmi.rb
+homepage: https://github.com/sensu-extensions/sensu-extensions-system-profile-wmi
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.6.13
+signing_key: 
+specification_version: 4
+summary: EXTENSION_TYPE extension to do X
+test_files: []