sensu-plugins-stackstorm 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: be14a142d09aa3425b4a138764b62fbd2f3fa9ee
+  data.tar.gz: 3cbc5eea735cde517d23f385bc374aae8530a097
+SHA512:
+  metadata.gz: 1a3b5e462bd30c6ab63c4a8c33e9002f28c072badf755e5ef7115ed13198bff9ad73b27229ecbc4e3eedaf90d6fd35d0cf59aa55c5dff8b2293dd87aed5670db
+  data.tar.gz: 64ad6a92f02447001988d552c97337f2ee0821bc2815c4a32ff34aea63b6859f167c91d9467cc93df870cec67f9f473c098c8756c2da5eee8cedbf9ab9fe7004

data/.gitignore

@@ -0,0 +1,2 @@
+*.sw[p-z]
+*.gem

data/.travis.yml

@@ -0,0 +1,34 @@
+language: ruby
+cache:
+- bundler
+install:
+- bundle install
+rvm:
+- 2.0
+- 2.1
+- 2.2
+- 2.3.0
+- 2.4.1
+notifications:
+  email:
+    recipients:
+    - user.localhost2000@gmail.com
+    on_success: change
+    on_failure: always
+script:
+- bundle exec rake default
+- gem build sensu-plugins-stackstorm.gemspec
+- gem install sensu-plugins-stackstorm-*.gem
+deploy:
+  provider: rubygems
+  api_key:
+    secure: m6eh9IW8L2RCDzfFcnVNuWyr74ywhw+G+4WWwvTTUb7kp5cPu1dkqSeyVM8UobwKuFDwiJTh5rsGVfa2gTnPkaj7jaAWOVDAJcjs8q+oYxMob+dpe++eu3N1adbsqZC27wNH2AlfmIiuEohTHNTMYv6CTiIkr6OVkZCLeD1lLxx9+OyhNaxkb53hmPPgvADmvITK1ZKKyAKb43rCGrKV1/nQDFu+aL/+CmqlH0JLw7vYrx3uVFOmjoVmPWM5VWS1BO2xOZIJ2leInql85C4DK4K3FoqIDhAg+d1o5RqMEz9DvfLHhl2f2EWgHxGk2PyolVUu7JxIoPT1WgCQnKjZ4vOZZBpsdMLzjvnFJBHrFIp0wUTAUgDxHzCA16BKLEoZg0IMcPh+aVPd3jdVJg+RsUuhCr+5wZEsu8LB/LfKiLhSdaM70sjM6CsZXyfhrLFN809f32vGm/fFc3FOKy/ZHEDaVG2jIspcg2pwDwzaQ8wPYwsgp9q+RDpFF49zyk+5f9FjEyftcUwaZhzDb1WIvzQCKtR2dBNgooUZJKrCicyc/L409P1Q1XMeV7BFew+fXChteh4upbzYiqp1yile1EO3QDIDmHpPALh2CbWRwyCmpbn0y8ZfAE4YDs0Bd1V1rJqdsuUFJlEDw7coKrR9uPWzB66om8nlz3KQGfyva3I=
+  gem: sensu-plugins-stackstorm
+  on:
+    tags: true
+    all_branches: true
+    rvm: 2.4.1
+    repo: sensu-plugins/sensu-plugins-stackstorm
+addons:
+  code_climate:
+    repo_token: 

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,7 @@
+# Sensu-Plugins-StackStorm
+
+# Functionality
+
+## Files
+
+* st2_handler.py

data/Rakefile

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

data/bin/st2_handler.py

@@ -0,0 +1,380 @@
+#!/usr/bin/env python
+
+import argparse
+import base64
+import httplib
+try:
+    import simplejson as json
+except ImportError:
+    import json
+import os
+import sys
+import traceback
+from urlparse import urljoin
+
+try:
+    import requests
+    requests.packages.urllib3.disable_warnings()
+except ImportError:
+    raise ImportError('Missing dependency "requests". \
+        Do ``pip install requests``.')
+
+try:
+    import yaml
+except ImportError:
+    raise ImportError('Missing dependency "pyyaml". \
+        Do ``pip install pyyaml``.')
+
+# ST2 configuration
+
+ST2_API_BASE_URL = None  # 'https://localhost/api/v1/'
+ST2_AUTH_BASE_URL = None  # 'https://localhost/auth/v1/'
+ST2_USERNAME = None
+ST2_PASSWORD = None
+ST2_API_KEY = None
+ST2_AUTH_TOKEN = None
+ST2_SSL_VERIFY = False
+
+ST2_AUTH_PATH = 'tokens'
+ST2_WEBHOOKS_PATH = 'webhooks/st2'
+ST2_TRIGGERS_PATH = 'triggertypes'
+ST2_TRIGGERTYPE_PACK = 'sensu'
+ST2_TRIGGERTYPE_NAME = 'event_handler'
+ST2_TRIGGERTYPE_REF = '.'.join([ST2_TRIGGERTYPE_PACK, ST2_TRIGGERTYPE_NAME])
+
+# Sensu configuration
+
+SENSU_HOST = 'localhost'
+SENSU_PORT = 4567
+SENSU_USER = ''
+SENSU_PASS = ''
+
+REGISTERED_WITH_ST2 = False
+UNAUTHED = False
+IS_API_KEY_AUTH = False
+
+OK_CODES = [httplib.OK, httplib.CREATED, httplib.ACCEPTED, httplib.CONFLICT]
+UNREACHABLE_CODES = [httplib.NOT_FOUND]
+
+TOKEN_AUTH_HEADER = 'X-Auth-Token'
+API_KEY_AUTH_HEADER = 'St2-Api-Key'
+
+
+def _get_sensu_request_headers():
+    b64auth = base64.b64encode(
+        "%s:%s" %
+        (SENSU_USER, SENSU_PASS))
+    auth_header = "BASIC %s" % b64auth
+    content_header = "application/json"
+    return {"Authorization": auth_header, "Content-Type": content_header}
+
+
+def _check_stash(client, check, verbose=False):
+    sensu_api = "http://%s:%i" % (SENSU_HOST, SENSU_PORT)
+    endpoints = [
+        "silence/%s" % client,
+        "silence/%s/%s" % (client, check),
+        "silence/all/%s" % check]
+
+    for endpoint in endpoints:
+        url = "%s/stashes/%s" % (sensu_api, endpoint)
+
+        if verbose:
+            print('Getting sensu stash info from URL: %s' % url)
+
+        try:
+            response = requests.get(url, headers=_get_sensu_request_headers())
+        except requests.exceptions.ConnectionError:
+            traceback.print_exc(limit=20)
+            msg = 'Couldn\'t connect to sensu to get stash info. Is sensu running on %s:%s?' % (
+                SENSU_HOST, SENSU_PORT
+            )
+            raise Exception(msg)
+
+        if verbose:
+            print('Sensu response code: %s.' % response.status_code)
+
+        if response.status_code == 200:
+            print("Check or client is stashed")
+            sys.exit(0)
+
+
+def _get_st2_request_headers():
+    headers = {}
+
+    if not UNAUTHED:
+        if IS_API_KEY_AUTH:
+            headers[API_KEY_AUTH_HEADER] = ST2_API_KEY
+        else:
+            if ST2_AUTH_TOKEN:
+                headers[TOKEN_AUTH_HEADER] = ST2_AUTH_TOKEN
+            else:
+                pass
+
+    return headers
+
+
+def _create_trigger_type(verbose=False):
+    try:
+        url = _get_st2_triggers_base_url()
+        payload = {
+            'name': ST2_TRIGGERTYPE_NAME,
+            'pack': ST2_TRIGGERTYPE_PACK,
+            'description': 'Trigger type for sensu event handler.'
+        }
+
+        headers = _get_st2_request_headers()
+        headers['Content-Type'] = 'application/json; charset=utf-8'
+
+        if verbose:
+            print('POST to URL %s for registering trigger. Body = %s, headers = %s.' %
+                  (url, payload, headers))
+        post_resp = requests.post(url, data=json.dumps(payload),
+                                  headers=headers, verify=ST2_SSL_VERIFY)
+    except:
+        traceback.print_exc(limit=20)
+        raise Exception('Unable to connect to st2 endpoint %s.' % url)
+    else:
+        status = post_resp.status_code
+        if status in UNREACHABLE_CODES:
+            msg = 'Got response %s. Invalid triggers endpoint %s. Check configuration!' % (
+                status,
+                url
+            )
+            raise Exception(msg)
+
+        if status not in OK_CODES:
+            msg = 'Failed to register trigger type %s.%s with st2. HTTP_CODE: %s' % (
+                ST2_TRIGGERTYPE_PACK, ST2_TRIGGERTYPE_NAME, status
+            )
+            raise Exception(msg)
+        else:
+            print('Registered trigger type with st2.')
+
+
+def _get_auth_url():
+    return urljoin(ST2_AUTH_BASE_URL, ST2_AUTH_PATH)
+
+
+def _get_auth_token(verbose=False):
+    auth_url = _get_auth_url()
+
+    if verbose:
+        print('Will POST to URL %s to get auth token.' % auth_url)
+
+    try:
+        resp = requests.post(auth_url, json.dumps({'ttl': 5 * 60}),
+                             auth=(ST2_USERNAME, ST2_PASSWORD), verify=ST2_SSL_VERIFY)
+    except:
+        traceback.print_exc(limit=20)
+        raise Exception('Unable to connect to st2 endpoint %s.' % auth_url)
+    else:
+        if resp.status_code in UNREACHABLE_CODES:
+            msg = 'Got response %s. Invalid auth endpoint %s. Check configuration!' % (
+                resp.status_code,
+                auth_url
+            )
+            raise Exception(msg)
+        if resp.status_code not in OK_CODES:
+            msg = 'Cannot get a valid auth token from %s. HTTP_CODE: %s' % (
+                auth_url,
+                resp.status_code
+            )
+            raise Exception(msg)
+        return resp.json()['token']
+
+
+def _register_trigger_with_st2(verbose=False):
+    triggers_url = _get_st2_triggers_url()
+
+    try:
+        headers = _get_st2_request_headers()
+        if verbose:
+            print('Will GET from URL %s for detecting trigger %s.' % (
+                  triggers_url, ST2_TRIGGERTYPE_REF))
+            print('Request headers: %s' % headers)
+        get_resp = requests.get(triggers_url, headers=headers, verify=ST2_SSL_VERIFY)
+
+        if get_resp.status_code != httplib.OK:
+            _create_trigger_type(verbose=verbose)
+        else:
+            body = json.loads(get_resp.text)
+            if len(body) == 0:
+                _create_trigger_type(verbose=verbose)
+    except:
+        traceback.print_exc(limit=20)
+        raise Exception('Unable to connect to st2 endpoint %s.' % triggers_url)
+    else:
+        if verbose:
+            print('Successfully registered trigger %s with st2.' % ST2_TRIGGERTYPE_REF)
+
+
+def _get_st2_triggers_base_url():
+    url = urljoin(ST2_API_BASE_URL, ST2_TRIGGERS_PATH)
+    return url
+
+
+def _get_st2_triggers_url():
+    url = urljoin(_get_st2_triggers_base_url() + '/', ST2_TRIGGERTYPE_REF)
+    return url
+
+
+def _get_st2_webhooks_url():
+    url = urljoin(ST2_API_BASE_URL, ST2_WEBHOOKS_PATH)
+    return url
+
+
+def _post_webhook(url, body, verbose=False):
+    headers = _get_st2_request_headers()
+    headers['X-ST2-Integration'] = 'sensu.'
+    headers['St2-Trace-Tag'] = body['payload']['id']
+    headers['Content-Type'] = 'application/json; charset=utf-8'
+
+    try:
+        if verbose:
+            print('Webhook POST: url: %s, headers: %s, body: %s\n' % (url, headers, body))
+        r = requests.post(url, data=json.dumps(body), headers=headers, verify=False)
+    except:
+        raise Exception('Cannot connect to st2 endpoint %s.' % url)
+    else:
+        status = r.status_code
+
+        if status in UNREACHABLE_CODES:
+            msg = 'Webhook URL %s does not exist. Check StackStorm installation!' % (url)
+            raise Exception(msg)
+
+        if status not in OK_CODES:
+            sys.stderr.write('Failed posting sensu event to st2. HTTP_CODE: \
+                %d\n' % status)
+        else:
+            sys.stdout.write('Sent sensu event to st2. HTTP_CODE: \
+                %d\n' % status)
+
+
+def _post_event_to_st2(payload, verbose=False):
+    body = {}
+    body['trigger'] = ST2_TRIGGERTYPE_REF
+
+    try:
+        body['payload'] = json.loads(payload)
+    except:
+        print('Invalid JSON payload %s.' % payload)
+        sys.exit(3)
+
+    try:
+        client = body['payload']['client']['name']
+        check = body['payload']['check']['name']
+    except KeyError:
+        print('Invalid payload spec %s.' % payload)
+
+    if not _check_stash(client, check, verbose=verbose):
+        try:
+            _post_webhook(url=_get_st2_webhooks_url(), body=body, verbose=verbose)
+            return True
+        except:
+            traceback.print_exc(limit=20)
+            print('Cannot send event to st2.')
+            sys.exit(4)
+    return False
+
+
+def _register_with_st2(verbose=False):
+    global REGISTERED_WITH_ST2
+    try:
+        if not REGISTERED_WITH_ST2:
+            if verbose:
+                print('Checking if trigger %s registered with st2.' % ST2_TRIGGERTYPE_REF)
+            _register_trigger_with_st2(verbose=verbose)
+            REGISTERED_WITH_ST2 = True
+    except:
+        traceback.print_exc(limit=20)
+        sys.stderr.write(
+            'Failed registering with st2. Won\'t post event.\n')
+        sys.exit(2)
+
+
+def _set_config_opts(config_file, verbose=False, unauthed=False, ssl_verify=False):
+    global ST2_USERNAME
+    global ST2_PASSWORD
+    global ST2_API_KEY
+    global ST2_AUTH_TOKEN
+    global ST2_API_BASE_URL
+    global ST2_API_BASE_URL
+    global ST2_AUTH_BASE_URL
+    global ST2_SSL_VERIFY
+    global SENSU_HOST
+    global SENSU_PORT
+    global SENSU_USER
+    global SENSU_PASS
+    global UNAUTHED
+    global IS_API_KEY_AUTH
+
+    UNAUTHED = unauthed
+    ST2_SSL_VERIFY = ssl_verify
+
+    if not os.path.exists(config_file):
+        print('Configuration file %s not found. Exiting!!!' % config_file)
+        sys.exit(1)
+
+    with open(config_file) as f:
+        config = yaml.safe_load(f)
+
+        if verbose:
+            print('Contents of config file: %s' % config)
+
+        ST2_USERNAME = config['st2_username']
+        ST2_PASSWORD = config['st2_password']
+        ST2_API_KEY = config['st2_api_key']
+        ST2_API_BASE_URL = config['st2_api_base_url']
+        if not ST2_API_BASE_URL.endswith('/'):
+            ST2_API_BASE_URL += '/'
+        ST2_AUTH_BASE_URL = config['st2_auth_base_url']
+        if not ST2_AUTH_BASE_URL.endswith('/'):
+            ST2_AUTH_BASE_URL += '/'
+        SENSU_HOST = config.get('sensu_host', 'localhost')
+        SENSU_PORT = config.get('sensu_port', '4567')
+        SENSU_USER = config.get('sensu_user', None)
+        SENSU_PASS = config.get('sensu_pass', None)
+
+    if ST2_API_KEY:
+        IS_API_KEY_AUTH = True
+
+    if verbose:
+        print('Unauthed? : %s' % UNAUTHED)
+        print('API key auth?: %s' % IS_API_KEY_AUTH)
+        print('SSL_VERIFY? : %s' % ST2_SSL_VERIFY)
+
+    if not UNAUTHED and not IS_API_KEY_AUTH:
+        try:
+            if not ST2_AUTH_TOKEN:
+                if verbose:
+                    print('No auth token found. Let\'s get one from StackStorm!')
+                ST2_AUTH_TOKEN = _get_auth_token(verbose=verbose)
+        except:
+            traceback.print_exc(limit=20)
+            print('Unable to negotiate an auth token. Exiting!')
+            sys.exit(1)
+
+
+def main(config_file, payload, verbose=False, unauthed=False, ssl_verify=False):
+    _set_config_opts(config_file=config_file, unauthed=unauthed, verbose=verbose,
+                     ssl_verify=ssl_verify)
+    _register_with_st2(verbose=verbose)
+    _post_event_to_st2(payload, verbose=verbose)
+
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser(description='StackStorm sensu event handler.')
+    parser.add_argument('config_path',
+                        help='Exchange to listen on')
+    parser.add_argument('--verbose', '-v', required=False, action='store_true',
+                        help='Verbose mode.')
+    parser.add_argument('--unauthed', '-u', required=False, action='store_true',
+                        help='Allow to post to unauthed st2. E.g. when auth is disabled ' +
+                        'server side.')
+    parser.add_argument('--ssl-verify', '-k', required=False, action='store_true',
+                        help='Turn on SSL verification for st2 APIs.')
+    args = parser.parse_args()
+    payload = sys.stdin.read().strip()
+    main(config_file=args.config_path, payload=payload, verbose=args.verbose,
+         unauthed=args.unauthed, ssl_verify=args.ssl_verify)

data/etc/st2_handler.conf

@@ -0,0 +1,14 @@
+---
+# st2 credentials. you can either use username/password combo or specify an API key.
+st2_username: ""
+st2_password: ""
+st2_api_key: ""
+
+# trailing slash mandatory
+st2_api_base_url: "https://localhost/api/v1/"
+st2_auth_base_url: "https://localhost/auth/v1/"
+
+sensu_host: localhost
+sensu_port: 4567
+sensu_user: sensu
+sensu_pass: ""

data/sensu-plugins-stackstorm.gemspec

@@ -0,0 +1,20 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "sensu-plugins-stackstorm"
+  spec.version       = '0.0.2'
+  spec.authors       = ["Hiroyasu OHYAMA"]
+  spec.email         = ["user.localhost2000@gmail.com"]
+
+  spec.summary       = %q{Sensu plugins for StackStorm}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/userlocalhost2000/sensu-plugins-stackstorm"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.license       = "Apache-2.0"
+
+  spec.add_development_dependency 'rspec', '~> 3.6'
+  spec.add_development_dependency 'rake', '~> 12.0'
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-stackstorm
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Hiroyasu OHYAMA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+description: ''
+email:
+- user.localhost2000@gmail.com
+executables:
+- st2_handler.py
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/st2_handler.py
+- etc/st2_handler.conf
+- lib/.gitkeep
+- sensu-plugins-stackstorm.gemspec
+homepage: https://github.com/userlocalhost2000/sensu-plugins-stackstorm
+licenses:
+- Apache-2.0
+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: Sensu plugins for StackStorm
+test_files: []