sensu-plugins-memory-checks 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1339009350722629ba2e914c762a63a6787b0f20d8f528896d9fa726bbdbecf
-  data.tar.gz: 89053c1f1e82b4734852623e6656ebd8524b44d356e3d493797ef421d80559e7
+  metadata.gz: 58c05cb934dc5bcc02ed2e5d041c5a261d4dbaf4e3d20f8f2612328e6c2aeefe
+  data.tar.gz: f9a68273dc15551bfcdd4e9b1f611bd5d2ae96a3ed0f03cc26abd45d7b49ef4f
 SHA512:
-  metadata.gz: 8ca80d6effcf45e3bda9d2b3f166ce4e1abe11654ac65cac33eb72879142064d6435b1324cf7597d763ba84aad37bb387722ea6b96902f314f7c025bc67fdb09
-  data.tar.gz: f2c2e8f27dff19076212789e2b2fc854a468bb986b0b2da923dbcdf2f50c8d646ed984b26bed2add2668309570a9ea621178de2d496b562e9792f50a17dfdbea
+  metadata.gz: 444ee9c818fd13079f1a8fb116cda2848743693c0b9b7b60be61e5a18cef7a098e904426ac97830d31560ccf3c17c8ff913ee884a2558f9ebb002d79a75759d5
+  data.tar.gz: 6180f388967ddc4936965581301b6933ed5eef40c48d8145972865db90853de83246f2d15ab156d01dd0b797b9f514963bd9d79b1c28ee5786b7bd1f3b30f8fb

data/CHANGELOG.md

@@ -5,6 +5,14 @@ This CHANGELOG follows the located [here](https://github.com/sensu-plugins/commu
 
 ## [Unreleased]
 
+## [4.1.0] - 2019-12-16
+### Changed
+- Updated asset build target to support Centos6
+- Updated rake development requirement from ~> 10.5 to ~> 13.0 .
+- Updated rubocop development requirement from ~> 0.51.0 to ~> 0.77.0 .
+- Updated bundler development requirement from ~> 1.7 to ~> 2.0 .
+- Updated README
+
 ## [4.0.0] - 2019-04-18
 ### Breaking Changes
 - Update minimum required ruby version to 2.3. Drop unsupported ruby versions.
@@ -155,7 +163,8 @@ This CHANGELOG follows the located [here](https://github.com/sensu-plugins/commu
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-memory-checks/compare/4.0.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-memory-checks/compare/4.1.0...HEAD
+[4.1.0]: https://github.com/sensu-plugins/sensu-plugins-memory-checks/compare/4.0.0..4.1.0
 [4.0.0]: https://github.com/sensu-plugins/sensu-plugins-memory-checks/compare/3.2.0..4.0.0
 [3.2.0]: https://github.com/sensu-plugins/sensu-plugins-memory-checks/compare/3.1.3..3.2.0
 [3.1.3]: https://github.com/sensu-plugins/sensu-plugins-memory-checks/compare/3.1.2...3.1.3

data/README.md

@@ -1,18 +1,32 @@
-## Sensu-Plugins-memory-checks
-
+[![Sensu Bonsai Asset](https://img.shields.io/badge/Bonsai-Download%20Me-brightgreen.svg?colorB=89C967&logo=sensu)](https://bonsai.sensu.io/assets/sensu-plugins/sensu-plugins-memory-checks)
 [![Build Status](https://travis-ci.org/sensu-plugins/sensu-plugins-memory-checks.svg?branch=master)](https://travis-ci.org/sensu-plugins/sensu-plugins-memory-checks)
 [![Gem Version](https://badge.fury.io/rb/sensu-plugins-memory-checks.svg)](http://badge.fury.io/rb/sensu-plugins-memory-checks)
 [![Code Climate](https://codeclimate.com/github/sensu-plugins/sensu-plugins-memory-checks/badges/gpa.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-memory-checks)
 [![Test Coverage](https://codeclimate.com/github/sensu-plugins/sensu-plugins-memory-checks/badges/coverage.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-memory-checks)
 [![Dependency Status](https://gemnasium.com/sensu-plugins/sensu-plugins-memory-checks.svg)](https://gemnasium.com/sensu-plugins/sensu-plugins-memory-checks)
-[![Sensu Bonsai Asset](https://img.shields.io/badge/Bonsai-Download%20Me-brightgreen.svg?colorB=89C967&logo=sensu)](https://bonsai.sensu.io/assets/sensu-plugins/sensu-plugins-memory-checks)
 
-## Sensu Asset  
-  The Sensu assets packaged from this repository are built against the Sensu ruby runtime environment. When using these assets as part of a Sensu Go resource (check, mutator or handler), make sure you include the corresponding Sensu ruby runtime asset in the list of assets needed by the resource.  The current ruby-runtime assets can be found [here](https://bonsai.sensu.io/assets/sensu/sensu-ruby-runtime) in the [Bonsai Asset Index](bonsai.sensu.io).
+## Sensu Memory Check Plugin
+
+- [Overview](#overview)
+- [Files](#files)
+- [Usage examples](#usage-examples)
+- [Configuration](#configuration)
+  - [Sensu Go](#sensu-go)
+    - [Asset registration](#asset-registration)
+    - [Asset definition](#asset-definition)
+    - [Check definition](#check-definition)
+  - [Sensu Core](#sensu-core)
+    - [Check definition](#check-definition)
+- [Installation from source](#installation-from-source)
+- [Additional notes](#additional-notes)
+- [Contributing](#contributing)
+
+### Overview
 
-## Functionality
 
-## Files
+This plugin provides native memory instrumentation for monitoring and metrics collection, including memory usage via `free` and `vmstat`, including metrics. **NOTE**: This plugin may have cross-platform issues.
+
+### Files
  * bin/check-memory.rb
  * bin/check-memory.sh
  * bin/check-memory-percent.rb
@@ -23,24 +37,137 @@
  * bin/check-swap.rb
  * bin/metrics-memory-percent.rb
  * bin/metrics-memory.rb
+ 
+**check-memory**
+Evaluate free system memory for Linux-based systems.
+
+**check-memory-percent**
+Evaluate the percentage of free system memory for Linux-based systems.
+
+**check-ram**
+Check the percentage of free RAM.
+
+**check-swap-percent**
+Checks swap usage as a percentage of the total swap.
+
+**check-swap**
+Evaluate swap memory usage for Linux-based systems.
+
+**metrics-memory-percent**
+Read memory statistics as a percentage and put them in a form usable by Graphite. Metrics borrowed from [HoardD](https://github.com/coredump/hoardd).
+
+**metrics-memory-vmstat**
+Read memory statistics and put them in a form usable by `vmstat`.
+
+**metrics-memory**
+Read memory statistics and put them in a form usable by Graphite. Metrics borrowed from [HoardD](https://github.com/coredump/hoardd).
+
+## Usage examples
+
+### Help
+
+**check-ram.rb**
+```
+Usage: /opt/sensu/embedded/bin/check-ram.rb (options)
+    -c CRIT
+    -f, --free                       checks free threshold, defaults to true
+    -m, --megabytes                  Unless --megabytes is specified the thresholds are in percentage of memory used as opposed to MB of ram left
+    -u, --used                       checks used threshold, defaults to false
+    -w WARN
+```
+
+**metrics-memory-percent.rb**
+```
+Usage: /opt/sensu/embedded/bin/metrics-memory-percent.rb (options)
+    -s, --scheme SCHEME              Metric naming scheme, text to prepend to metric
+```
+
+## Configuration
+### Sensu Go
+#### Asset registration
 
-## Usage
-Use `-h` flag on any command to see available usages, `-w` to set warning threshold `-c` to set critical threshold and `-p` to print out performance data. 
- * `/opt/sensu/embedded/bin/check-memory.rb -w 2500 -c 3000`  - Values in Megabytes
- * `/opt/sensu/embedded/bin/check-memory-percent.rb -w 70 -c 80` - Values in Percentages
- * `/opt/sensu/embedded/bin/check-swap.rb -w 2500 -c 3000` - Values in Megabytes
- * `/opt/sensu/embedded/bin/check-swap-percent.rb -w 70 -c 80` - Values in Percentages
- * `/opt/sensu/embedded/bin/metrics-memory.rb -s FooBar` - So metrics are now prepended with foobar, default is machine hostname. 
+Assets are the best way to make use of this plugin. If you're not using an asset, please consider doing so! If you're using sensuctl 5.13 or later, you can use the following command to add the asset: 
 
-## Installation
+`sensuctl asset add sensu-plugins/sensu-plugins-memory-checks`
 
-[Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)
+If you're using an earlier version of sensuctl, you can download the asset definition from [this project's Bonsai Asset Index page](https://bonsai.sensu.io/assets/sensu-plugins/sensu-plugins-memory-checks).
+
+#### Asset definition
+
+```yaml
+---
+type: Asset
+api_version: core/v2
+metadata:
+  name: sensu-plugins-memory-checks
+spec:
+  url: https://assets.bonsai.sensu.io/c5391d4ae186484226732344b35cf95c0b07b8ec/sensu-plugins-memory-checks_4.0.0_centos_linux_amd64.tar.gz
+  sha512: ea297a85aa3612da7f78d948f9784443fffac511040c5130a2dcde7191a0004044c2ef881e665520cbc64431955ab19920d84de6b5fed85c63da7091c4b93bf0
+```
+
+#### Check definition
+
+```yaml
+---
+type: CheckConfig
+spec:
+  command: "check-memory.rb"
+  handlers: []
+  high_flap_threshold: 0
+  interval: 10
+  low_flap_threshold: 0
+  publish: true
+  runtime_assets:
+  - sensu-plugins/sensu-plugins-memory-checks
+  - sensu/sensu-ruby-runtime
+  subscriptions:
+  - linux
+```
+
+### Sensu Core
+
+#### Check definition
+```json
+{
+  "checks": {
+    "metrics-disk-usage": {
+      "command": "metric-disk-usage.rb",
+      "subscribers": ["linux"],
+      "interval": 10,
+      "refresh": 10,
+      "handlers": ["influxdb"]
+    }
+  }
+}
+```
+
+## Installation from source
+
+### Sensu Go
+
+See the instructions above for [asset registration](#asset-registration)
+
+### Sensu Core
+
+Install and setup plugins on [Sensu Core](https://docs.sensu.io/sensu-core/latest/installation/installing-plugins/)
+
+## Additional notes
 
 ### `bin/check-ram.rb`
 
-Ruby does not have a good native way without the use of C extensions to grab information on memory usage (outside of running shell commands and parsing out). Because of this `check-ram.rb` uses a gem called `vmstat` which has a somewhat annoying dependency on a gcc to compile the C extensions. In order to not force people to install gcc if they are not using `check-ram.rb` we do not install it by default, and is up to the user to make sure that they install it. This requires two steps and can vary based on your distribution and ruby set up:
-  * Install `gcc`. If you are on a debian based system it is located in the `build-essential` package.
-  * Install `vmstat` gem into the path that sensu gems are expected to run from:
-    * `sudo /opt/sensu/embedded/bin/gem install vmstat --no-rdoc --no-ri` or the equivalent for installing sensu gems in your configuration management system
+Ruby does not have a good native way to grab information on memory usage (without using C extensions or running shell commands and parsing out). For this reason, `check-ram.rb` uses a gem called `vmstat` that has a dependency on a GCC to compile the C extensions.
+
+To avoid errors that occur when trying to compile the C extensions without GCC present, we do not install the `vmstat` gem by default.
+
+**Users who need to use `check-ram.rb` must install build tools, including GCC**. This usually requires two steps but can vary based on your distribution and Ruby setup:
+
+1. Install `gcc`. If you are on a Debian system, GCC is located in the `build-essential` package. On RHEL systems, `yum groupinstall "Development tools" ` will provide the required packages.
+2. Install the `vmstat` gem into the path from which Sensu gems are expected to run, `sudo /opt/sensu/embedded/bin/gem install vmstat --no-rdoc --no-ri`, or the equivalent for installing Sensu gems in your configuration management system.
+
+### Certification verification
+
+If you are verifying certificates in the gem install you will need the [certificate for the `sys-filesystem` gem](https://raw.githubusercontent.com/djberg96/sys-filesystem/ffi/certs/djberg96_pub.pem) loaded in the gem certificate store.
+
+## Contributing
 
-## Notes
+See [CONTRIBUTING.md](https://github.com/sensu-plugins/sensu-plugins-memory-checks/blob/master/CONTRIBUTING.md) for information about contributing to this plugin.

data/bin/check-memory-percent.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 bin_dir = File.expand_path(__dir__)
 shell_script_path = File.join(bin_dir, File.basename($PROGRAM_NAME, '.rb') + '.sh')

data/bin/check-memory.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 bin_dir = File.expand_path(__dir__)
 shell_script_path = File.join(bin_dir, File.basename($PROGRAM_NAME, '.rb') + '.sh')

data/bin/check-ram.rb

@@ -1,4 +1,6 @@
 #! /usr/bin/env ruby
+# frozen_string_literal: true
+
 #
 #   check-ram
 #
@@ -32,6 +34,7 @@
 #   Released under the same terms as Sensu (the MIT license); see LICENSE
 #   for details.
 #
+
 require 'sensu-plugin/check/cli'
 
 class CheckRAM < Sensu::Plugin::Check::CLI
@@ -71,6 +74,7 @@ class CheckRAM < Sensu::Plugin::Check::CLI
       require 'vmstat'
     rescue LoadError => e
       raise unless e.message =~ /vmstat/
+
       unknown "Error unable to load vmstat gem: #{e}"
     end
 

data/bin/check-swap-percent.rb

@@ -1,4 +1,6 @@
 #! /usr/bin/env ruby
+# frozen_string_literal: true
+
 #
 # Checks SWAP usage as a % of the total swap
 #

data/bin/check-swap.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 bin_dir = File.expand_path(__dir__)
 shell_script_path = File.join(bin_dir, File.basename($PROGRAM_NAME, '.rb') + '.sh')

data/bin/metrics-memory-percent.rb

@@ -1,5 +1,6 @@
 #! /usr/bin/env ruby
-#
+# frozen_string_literal: true
+
 #   metrics-memory-percent
 #
 # DESCRIPTION:

data/bin/metrics-memory-vmstat.rb

@@ -1,4 +1,6 @@
 #! /usr/bin/env ruby
+# frozen_string_literal: true
+
 #
 #   metrics-memory-vmstat
 #

data/bin/metrics-memory.rb

@@ -1,4 +1,6 @@
 #! /usr/bin/env ruby
+# frozen_string_literal: true
+
 #
 #   metrics-memory
 #
@@ -67,7 +69,7 @@ class MemoryGraphite < Sensu::Plugin::Metric::CLI::Graphite
       mem['usedWOBuffersCaches'] = mem['used'] - (mem['buffers'] + mem['cached'])
       mem['freeWOBuffersCaches'] = mem['free'] + (mem['buffers'] + mem['cached'])
     end
-    mem['swapUsedPercentage'] = 100 * mem['swapUsed'] / mem['swapTotal'] if mem['swapTotal'] > 0
+    mem['swapUsedPercentage'] = 100 * mem['swapUsed'] / mem['swapTotal'] if mem['swapTotal'].positive?
 
     mem
   end

data/lib/sensu-plugins-memory-checks.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'sensu-plugins-memory-checks/version'

data/lib/sensu-plugins-memory-checks/version.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module SensuPluginsMemoryChecks
   module Version
     MAJOR = 4
-    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-memory-checks
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Sensu Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-19 00:00:00.000000000 Z
+date: 2019-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.51.0
+        version: 0.77.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.51.0
+        version: 0.77.0
 - !ruby/object:Gem::Dependency
   name: vmstat
   requirement: !ruby/object:Gem::Requirement
@@ -171,14 +171,14 @@ description: |-
                                 Note that this plugin may have cross-platform issues.
 email: "<sensu-users@googlegroups.com>"
 executables:
-- check-memory-percent.rb
-- check-swap-percent.rb
 - check-swap.rb
-- check-ram.rb
-- metrics-memory.rb
-- check-memory.rb
 - metrics-memory-percent.rb
+- check-swap-percent.rb
+- metrics-memory.rb
+- check-memory-percent.rb
 - metrics-memory-vmstat.rb
+- check-ram.rb
+- check-memory.rb
 extensions: []
 extra_rdoc_files: []
 files:
@@ -223,7 +223,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for checking memory