circactivator 2.1.0

data/lib/circactivator.rb

@@ -0,0 +1,40 @@
+#
+# Author:: Adam Leff (<aleff@webmd.net>)
+# Copyright:: Copyright (c) 2015 WebMD, LLC
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'circactivator/checkupdater'
+require 'circactivator/cli'
+require 'circactivator/log'
+require 'circactivator/monitoring'
+require 'circactivator/version'
+require 'fileutils'
+require 'settingslogic'
+
+module CircActivator
+  class Config < Settingslogic
+    def self.load_from_file(file)
+      source file
+      load!
+    end
+  end
+
+  module Exception
+    class CheckNotFound < RuntimeError; end
+    class CirconusError < RuntimeError; end
+    class NoConfigFile < RuntimeError; end
+  end
+end

data/lib/circactivator/checkupdater.rb

@@ -0,0 +1,93 @@
+#
+# Author:: Adam Leff (<aleff@webmd.net>)
+# Copyright:: Copyright (c) 2015 WebMD, LLC
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'httparty'
+require 'json'
+
+module CircActivator
+  class CheckUpdater
+
+    attr_reader :check_bundle
+    attr_accessor :name_regex
+    
+    def initialize(check_bundle_id)
+      @check_bundle_id = check_bundle_id
+      @check_bundle    = Hash.new
+      @name_regex      = '.*'
+    end
+
+    def http_headers
+      {
+        'X-Circonus-Auth-Token' => CircActivator::Config.circonus.api_key,
+        'X-Circonus-App-Name'   => CircActivator::Config.circonus.api_app_name,
+        'Accept'                => 'application/json'
+      }
+    end
+
+    def url
+      CircActivator::Config.circonus.base_url + '/check_bundle/' + @check_bundle_id.to_s
+    end
+
+    def fetch
+      response = HTTParty.get(url + '?query_broker=1', headers: http_headers, verify: false)
+      raise_exceptions!(response)
+      @check_bundle = JSON.load(response.body)
+    end
+
+    def activate_metrics
+      return if @check_bundle['metrics'].nil?
+      updated_metrics = Array.new
+      @check_bundle['metrics'].select {
+        |metric| metric['status'] == 'available' && metric['name'] =~ /#{self.name_regex}/
+      }.each do |metric|
+        updated_metrics << metric['name']
+        metric['status'] = 'active'
+      end
+      updated_metrics
+    end
+
+    def payload_hash
+      @check_bundle.select { |k,v| k =~ /brokers|config|display_name|metrics|notes|period|status|tags|target|timeout|type/ }
+    end
+
+    def update
+      response = HTTParty.put(url, headers: http_headers, body: payload_hash.to_json, verify: false)
+      raise_exceptions!(response)
+    end
+
+    def raise_exceptions!(response)
+      case response.code.to_s
+      when /^2/
+        return
+      when '404'
+        raise CircActivator::Exception::CheckNotFound, "Check bundle ID #{@check_bundle_id} not found"
+      else
+        raise CircActivator::Exception::CirconusError, 
+          "Server error when handling check bundle #{@check_bundle_id}: #{response.body}"
+      end
+    end
+
+    def run(logging=false)
+      fetch
+      updated_metrics = activate_metrics
+      update
+      
+      updated_metrics
+    end
+  end
+end

data/lib/circactivator/cli.rb

@@ -0,0 +1,98 @@
+#
+# Author:: Adam Leff (<aleff@webmd.net>)
+# Copyright:: Copyright (c) 2015 WebMD, LLC
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'thor'
+
+module CircActivator
+  class CLI < Thor
+
+    class_option :debug, :type => :boolean
+
+    def initialize(*args)
+      super
+      CircActivator::Log.create(options[:debug])
+      @monitoring = CircActivator::Monitoring.new
+    end
+
+    desc 'update_group GROUP', 'Activate metrics for each check_bundle configured in GROUP'
+    def update_group(group)
+      unless CircActivator::Config['check_bundles'].include?(group)
+        CircActivator::Log.fatal("Site #{group} not found in the configuration.")
+        exit(1)
+      end
+
+      CircActivator::Config['check_bundles'][group].each do |check_bundle_id, regex|
+        run_updater(group, check_bundle_id, regex)
+      end
+
+      exit_handler
+    end
+
+    desc 'update_all_groups', 'Activate all metrics for all check bundles in the configuration'
+    def update_all_groups
+      CircActivator::Config.check_bundles.each do |group, check_bundles|
+        check_bundles.each do |check_bundle_id, regex|
+          run_updater(group, check_bundle_id, regex)
+        end
+      end
+
+      exit_handler
+    end
+
+    desc 'update_check_bundle CHECK_BUNDLE_ID [REGEX]', 'Activates all metrics for an arbitrary check bundle, activating only the metrics whose name match the optional regex'
+    def update_check_bundle(check_bundle_id, regex=nil)
+      run_updater('no_group', check_bundle_id, regex)
+      exit_handler
+    end
+
+    no_commands do
+      def run_updater(group, check_bundle_id, regex)
+        CircActivator::Log.info("Starting update for group #{group}, check bundle #{check_bundle_id}")
+
+        begin
+          updater = CircActivator::CheckUpdater.new(check_bundle_id)
+          updater.name_regex = regex unless regex.nil?
+          updated_metrics = updater.run(options[:debug])
+        rescue => e
+          log_error("Error updating #{check_bundle_id}: #{e.class}: #{e.message}")
+          return
+        end
+
+        if updated_metrics.length > 0
+          CircActivator::Log.info("Update for group #{group}, check bundle #{check_bundle_id} complete.  Metrics added: #{updated_metrics.join(', ')}")
+        else
+          CircActivator::Log.info("Update for group #{group}, check bundle #{check_bundle_id} complete.  No metrics updated.")
+        end
+      end
+
+      def log_error(msg)
+        CircActivator::Log.error(msg)
+        @monitoring.add_error_message(msg)
+      end
+
+      def exit_handler
+        @monitoring.set_error_file unless options[:debug]
+        if @monitoring.errors?
+          Kernel.exit(2)
+        else
+          Kernel.exit(0)
+        end
+      end
+    end
+  end
+end

data/lib/circactivator/log.rb

@@ -0,0 +1,29 @@
+#
+# Author:: Adam Leff (<aleff@webmd.net>)
+# Copyright:: Copyright (c) 2015 WebMD, LLC
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'mixlib/log'
+
+module CircActivator
+  module Log
+    extend Mixlib::Log
+    def self.create(stdout=false)
+      init(CircActivator::Config.log.file, CircActivator::Config.log.count) unless stdout
+      level(CircActivator::Config.log.level.to_sym)
+    end
+  end
+end

data/lib/circactivator/monitoring.rb

@@ -0,0 +1,46 @@
+#
+# Author:: Adam Leff (<aleff@webmd.net>)
+# Copyright:: Copyright (c) 2015 WebMD, LLC
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module CircActivator
+  class Monitoring
+
+    attr_reader :error_messages
+    
+    def initialize
+      @error_messages = Array.new
+    end
+
+    def add_error_message(msg)
+      @error_messages << msg
+    end
+
+    def errors?
+      @error_messages.length > 0
+    end
+
+    def set_error_file
+      if errors?
+        File.write(CircActivator::Config.monitoring.error_file, @error_messages.join("\n"))
+        true
+      else
+        FileUtils.rm_f(CircActivator::Config.monitoring.error_file)
+        false
+      end
+    end
+  end
+end

data/lib/circactivator/version.rb

@@ -0,0 +1,21 @@
+#
+# Author:: Adam Leff (<aleff@webmd.net>)
+# Copyright:: Copyright (c) 2015 WebMD, LLC
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module CircActivator
+  VERSION = '2.1.0'
+end

data/spec/checkupdater_spec.rb

@@ -0,0 +1,138 @@
+#
+# Author:: Adam Leff (<aleff@webmd.net>)
+# Copyright:: Copyright (c) 2015 WebMD, LLC
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+describe CircActivator::CheckUpdater do
+  let(:check_bundle_id) { 123 }
+  let(:updated_metrics_all) {
+    %w( vserver1:80`actsvcs
+        vserver1:80`curclntconnections
+        vserver1:80`cursrvrconnections
+        vserver1:80`inactsvcs
+        vserver1:80`totalrequestbytes
+        vserver1:80`totalrequests
+        vserver1:80`totalresponsebytes
+        vserver1:80`totalresponses
+        vserver1:80`tothits
+        vserver1:80`vslbhealth
+    )
+  }
+  let(:updated_metrics_with_regex) {
+    %w( vserver1:80`actsvcs
+        vserver1:80`inactsvcs
+    )
+  }
+
+  before(:each) do
+    @checkupdater = CircActivator::CheckUpdater.new(check_bundle_id)
+  end
+
+  it 'returns http headers' do
+    expect(@checkupdater.http_headers['X-Circonus-Auth-Token']).to eq('a12345')
+    expect(@checkupdater.http_headers['X-Circonus-App-Name']).to eq('my_app')
+  end
+
+  it 'returns a check bundle URL' do
+    expect(@checkupdater.url).to eq("https://api.circonus.com/v2/check_bundle/123")
+  end
+
+  it 'raises an exception if the check is not found' do
+    stub_request(:get, format_webmock_url("/check_bundle/#{check_bundle_id}?query_broker=1")).to_return(status: 404)
+    expect { @checkupdater.fetch }.to raise_error(CircActivator::Exception::CheckNotFound)
+  end
+
+  it 'raises an exception if the status code is not 200 or 404' do
+    stub_request(:get, format_webmock_url("/check_bundle/#{check_bundle_id}?query_broker=1")).to_return(status: 500)
+    expect { @checkupdater.fetch }.to raise_error(CircActivator::Exception::CirconusError)
+  end
+
+  it 'activate_metrics returns nil when check_bundle is empty' do
+    expect(@checkupdater.activate_metrics).to eq(nil)
+  end
+
+  context 'check with data' do
+    before(:each) do
+      stub_request(:get, format_webmock_url("/check_bundle/#{check_bundle_id}?query_broker=1")).
+        to_return(:status => 200, :body => File.read(webmock_sample_file('lbvserver_check_bundle.json')))
+      stub_request(:put, format_webmock_url("/check_bundle/#{check_bundle_id}")).to_return(status: 201)
+
+      @checkupdater = CircActivator::CheckUpdater.new(check_bundle_id)
+      @checkupdater.fetch
+    end
+
+    it 'fetches a check' do
+      expect(@checkupdater.check_bundle.size).to be > 0
+      expect(@checkupdater.check_bundle.include?('_cid')).to eq(true)
+      expect(@checkupdater.check_bundle.include?('metrics')).to eq(true)
+    end
+
+    it 'activates the appropriate list of metrics - .* regex as default' do
+      expect(@checkupdater.activate_metrics.sort).to eq(updated_metrics_all.sort)
+    end
+
+    it 'activates the appropriate list of metrics - svcs regex' do
+      @checkupdater.name_regex = 'svcs'
+      expect(@checkupdater.activate_metrics.sort).to eq(updated_metrics_with_regex.sort)
+    end
+
+    it 'returns a payload hash containing the necessary fields' do
+      expect(@checkupdater.payload_hash.keys.sort).to eq([
+        'brokers',
+        'config',
+        'display_name',
+        'metrics',
+        'notes',
+        'period',
+        'status',
+        'tags',
+        'target',
+        'timeout',
+        'type'
+      ])
+      expect(@checkupdater.payload_hash['metrics'].length).to be > 0
+    end
+
+    it 'updates the check' do
+      expect { @checkupdater.update }.to_not raise_error
+    end
+
+    it 'calls the right methods during the run' do
+      expect(@checkupdater).to receive(:fetch)
+      expect(@checkupdater).to receive(:activate_metrics).and_return(['metric1', 'metric2'])
+      expect(@checkupdater).to receive(:update)
+      @checkupdater.run
+    end
+
+    it 'does not call update when no metrics are returned' do
+      expect(@checkupdater).to receive(:activate_metrics).and_return([])
+      expect(@checkupdater).to_not receive(:update)
+      @checkupdater.run
+    end
+
+    it "#run does not debug log if logging is disabled (disabled by default)" do
+      expect(CircActivator::Log).to_not receive(:debug)
+      @checkupdater.run
+    end
+
+    it '#run debug logs when logging is enabled' do
+      expect(CircActivator::Log).to receive(:debug).exactly(3).times
+      @checkupdater.run(logging=true)
+    end
+  end
+end