sensu-extensions-occurrences 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: efca1b4530797c34ca1d7bd601a7ac27dc02aeee
-  data.tar.gz: 953cc6eccc46a002820020bc451f3d6867dd6ef5
+  metadata.gz: e15818a78d87722c31cb29beddc1c7d61ab0b1a2
+  data.tar.gz: 4f6064fa7b503cb6c2a426c429fef139a3b89c9e
 SHA512:
-  metadata.gz: 59c859ac33e3368a45a786a2e025b63280472a584623e17397ded8807796794b6e7acf0d50f0e76d1c4ca242fca0b21e6187c0b2258678e693ab3fdaffa3193a
-  data.tar.gz: 722aae756c62093b673e79e8acb56ec1126ac522209ce3504f453086d60071ef1bc54f3efbbdcd2ceebf20f5774baf355373433b55726979df6ae2aa2c3c4c25
+  metadata.gz: 2511f18976ad8a63f050d13ba216002824bf9b59bf9799ff29038dedb5a660f42d44d1f816a1461a3aaa84edff60d8c316ce500f10ee0c893e6db79386d1f5aa
+  data.tar.gz: bd2a4ddda648b662b7a23504230fe4ac84c63dc5feb6f065e3a3d1efa7170a6648716393e8b2bcd4f56a2a944b905fc84c8b63ba3274ef2a64b43903ed648519

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/).
+
+## [1.0.0] - 2016-07-27
+
+### Added
+
+- Added a LICENSE, CHANGELOG, (from
+[sensu-extensions/template](https://github.com/sensu-extensions/template)).
+
+### Changed
+
+- Updated gemspec and README to better represent a desired Sensu extension
+repository.
+
+## 0.0.1 - 2016-07-21
+
+### Added
+
+- Initial release.
+
+[Unreleased]: https://github.com/sensu-extensions/sensu-extensions-occurrences/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/sensu-extensions/sensu-extensions-occurrences/compare/v0.0.1...v1.0.0

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

@@ -1,36 +1,73 @@
-# Sensu::Extensions::Only::Check::Output
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sensu/extensions/only/check/output`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'sensu-extensions-only-check-output'
+# Sensu::Extensions::Occurrences
+
+This filter extension provides the Sensu Core built-in filter
+`occurrences`.
+
+This filter provides the functionality that will soon be removed from
+the sensu-plugin handler library. Cameron Johnston wrote a great blog
+post on this topic, [Deprecating Event Filtering in
+sensu-plugin](https://sensuapp.org/blog/2016/07/07/sensu-plugin-filter-deprecation.html).
+
+The `occurrences` filter will determine if an event occurrence count
+meets the user defined requirements in the event check definition.
+Users can specify a minimum number of `occurrences` before an event
+will be passed to a handler. Users can also specify a `refresh` time,
+in seconds, to reset where recurrences are counted from.
+
+## Configuration
+
+The `occurrences` filter is included in every install of Sensu. To
+apply the filter to handler, use the `"filter"` or `"filters"` handler
+definition attribute.
+
+For example:
+
+``` json
+{
+  "handlers": {
+    "email": {
+      "...": "...",
+      "filter": "occurrences"
+    }
+  }
+}
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install sensu-extensions-only-check-output
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sensu-extensions-only-check-output.
+or
+
+``` json
+{
+  "handlers": {
+    "email": {
+      "...": "...",
+      "filters": ["occurrences"]
+    }
+  }
+}
+```
 
+The `occurrences` filter uses two custom check definition attributes,
+`occurrences`, and `refresh`.
+
+`occurrences`: The number of event occurrences that must occur before
+an event is handled for the check (default is `1`).
+
+`refresh`: Time in seconds until the event occurrence count is
+considered reset for the purpose of counting occurrences, to allow an
+event for the check to be handled again (default is `1800`). For
+example, a check with a `refresh` of 1800 will have its events
+(recurrences) handled every 30 minutes, to remind users of the issue.
+
+For example:
+
+``` json
+{
+  "checks": {
+    "check-http": {
+      "...": "...",
+      "occurrences": 2,
+      "refresh": 3600
+    }
+  }
+}
+```

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-extensions-occurrences
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
-- Sean Porter
+- Sensu-Extensions and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-21 00:00:00.000000000 Z
+date: 2016-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-extension
@@ -94,19 +94,17 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: The Sensu Core built-in occurrences files
+description: The Sensu Core built-in occurrences filter
 email:
-- portertech@gmail.com
+- "<sensu-users@googlegroups.com>"
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- Gemfile
-- Gemfile.lock
+- CHANGELOG.md
+- LICENSE
 - README.md
-- Rakefile
 - lib/sensu/extensions/occurrences.rb
-- sensu-extensions-occurrences.gemspec
 homepage: https://github.com/sensu-extensions/sensu-extensions-occurrences
 licenses: []
 metadata: {}

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in sensu-extensions-only-check-output.gemspec
-gemspec

data/Gemfile.lock

@@ -1,49 +0,0 @@
-PATH
-  remote: .
-  specs:
-    sensu-extensions-occurrences (0.0.1)
-      sensu-extension
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    diff-lcs (1.2.5)
-    eventmachine (1.2.0.1)
-    oj (2.14.6)
-    rake (10.5.0)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.4)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
-    sensu-extension (1.5.0)
-      eventmachine
-    sensu-json (2.0.0)
-      oj (= 2.14.6)
-    sensu-logger (1.2.0)
-      eventmachine
-      sensu-json
-    sensu-settings (6.0.0)
-      sensu-json (>= 1.1.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.6)
-  rake
-  rspec
-  sensu-extensions-occurrences!
-  sensu-logger
-  sensu-settings
-
-BUNDLED WITH
-   1.11.2

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/sensu-extensions-occurrences.gemspec

@@ -1,23 +0,0 @@
-# coding: utf-8
-
-Gem::Specification.new do |spec|
-  spec.name          = "sensu-extensions-occurrences"
-  spec.version       = "0.0.1"
-  spec.authors       = ["Sean Porter"]
-  spec.email         = ["portertech@gmail.com"]
-
-  spec.summary       = "The Sensu Core built-in occurrences filter"
-  spec.description   = "The Sensu Core built-in occurrences files"
-  spec.homepage      = "https://github.com/sensu-extensions/sensu-extensions-occurrences"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "sensu-extension"
-
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "sensu-logger"
-  spec.add_development_dependency "sensu-settings"
-end