sensu-extensions-deregistration 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0df0b359379e91b13898784b2ab34a9cc9ac87a
+  data.tar.gz: 19e0a6566a2c5b5688f87b1e074823648b21387b
+SHA512:
+  metadata.gz: 4f7c4ef2ef5ace144f06fa833fc83fd0ce8bd75a171575f0e47c89418d80365bda2731ce5e48d54863f1ec34122c2c9229a00a24e3ac994da9866e24ade31de1
+  data.tar.gz: 7363a3997373f54d82c3dcb4e7e5a945c6cdd3fe1776c9b7a068935b993b2c3e0f6590a7e2eacc7c2cf3becb51a0ada0dcf0384770c3877eba45009315be57fe

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+# 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]
+
+### Fixed
+
+### Added
+
+### Changed
+
+## [1.0.0] - 2016-01-31
+
+### Fixed
+
+### Added
+
+### Changed
+
+## 0.0.1 - 2016-01-31
+
+### Added
+
+- Initial release.
+
+[Unreleased]: https://github.com/sensu-extensions/sensu-extensions-template/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/sensu-extensions/sensu-extensions-template/compare/v0.0.1...v1.0.0

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2018 Sensu, Inc.
+
+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,48 @@
+# Sensu::Extensions::Deregistration
+
+**NOTE: This extension is considered experimental and needs testing!**
+
+For each event recieved, this handler extension deletes the corresponding client via the /clients API
+
+## Installation
+
+1. Install this gem using sensu-install
+
+    ``` bash
+    $ sensu-install -e sensu-extensions-deregistration
+    ```
+
+2. Configure Sensu to load the extension, as [documented here][0].
+
+    ``` json
+    {
+      "extensions": {
+        "deregistration": {
+          "gem": "sensu-extensions-deregistration"
+        }
+      }
+    }
+    ```
+
+## Configuration
+
+With the extension loaded, the "deregistration" handler is now available for use with [client deregistration attributes][1]:
+
+```
+{
+  "client": {
+    "name": "1-424242",
+    "...": "...",
+    "deregister": true,
+    "deregistration": {
+      "handler": "deregistration"
+    }
+  }
+}
+
+```
+
+With this configuration in place, clients will be automatically deregistered when sensu-client process recieves a SIGTERM.
+
+[1]: https://sensuapp.org/docs/latest/reference/clients.html#deregistration-attributes
+[0]: https://sensuapp.org/docs/latest/reference/extensions.html

data/lib/sensu/extensions/deregistration.rb

@@ -0,0 +1,73 @@
+require 'sensu/extension'
+require 'net/http'
+
+module Sensu
+  module Extension
+    class Deregistration < Handler
+      def name
+        'deregistration'
+      end
+
+      def description
+        'deregisters (deletes) clients'
+      end
+
+      def options
+        return @options if @options
+        @options = {
+          timeout: 1
+        }
+        @options.merge!(@settings[:deregistration]) if @settings[:deregistration].is_a?(Hash)
+        @options
+      end
+
+      # Returns configuration for an API
+      def api
+        return @api if @api
+        @api = @settings[:api] || {}
+        if @api.key?(:endpoints) && @api[:endpoints].is_a?(Array)
+          @api = @api[:endpoints].sample
+        else
+          @api
+        end
+      end
+
+      # Remove the Sensu client from the registry, using the Sensu
+      # API. This method returns `true` if the Sensu client deletion
+      # was successful.
+      #
+      # @param event [Hash]
+      # @return [TrueClass, FalseClass]
+      def remove_sensu_client!(event)
+        http = Net::HTTP.new(api.fetch(:host, '127.0.0.1'), api.fetch(:port, 4567))
+        client_name = event[:client][:name]
+        request = Net::HTTP::Delete.new("/clients/#{client_name}")
+        if api[:user] && api[:password]
+          request.basic_auth(api[:user], api[:password])
+        end
+        response = http.request(request)
+        response.code == '202'
+      end
+
+      def run(event, &callback)
+        handle = proc do
+          event = Sensu::JSON.load(event)
+          client_name = event[:client][:name]
+          begin
+            Timeout.timeout(options[:timeout]) do
+              if remove_sensu_client!(event)
+                ["deleted client #{client_name}", 0]
+              else
+                ["error deleting client #{client_name}", 2]
+              end
+            end
+          rescue => error
+            @logger.error('client deregistration error', error: error.to_s)
+            ["error deleting client #{client_name}: #{error}", 2]
+          end
+        end
+        EM.defer(handle, callback)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: sensu-extensions-deregistration
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sensu Inc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-20 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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: The Sensu Core built-in deregistration handler
+email:
+- "<support@sensu.io>"
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/sensu/extensions/deregistration.rb
+homepage: https://github.com/sensu/sensu-extensions-deregistration
+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.11
+signing_key: 
+specification_version: 4
+summary: The Sensu Core built-in deregistration handler
+test_files: []