sensu_generator 0.0.25

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa5b40932e162763cc44bfc51cd2051806b3d46a
+  data.tar.gz: 23194a317cde4a606d1358ef06fa70c5e7974bcd
+SHA512:
+  metadata.gz: 5d6afad7404f580509f9f189f92fc70b5ca0c11158fa4561325ed7b2aea4b29abebbd064ebfc5be466693a8de7f5304ae9ea8084c5c90a8f6f9833d308e5bb56
+  data.tar.gz: d818013b9f39db3898ba74924063754c505ed5327f0bc473a05f3e37c922272c25c8724270181b2373180d2d129e3ffcc8adc24dcaf09ddabe61951b9b23248f

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/work

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sensu_generator.gemspec
+gemspec

data/README.md

@@ -0,0 +1,87 @@
+# SensuGenerator
+
+SensuGenerator is an intermediate layer between Consul and Sensu. It helps to set up dynamic monitoring systems. It generates check configurations from ERB templates according to *tags* listed in the KV and Consul service properties. It watches for changes Consul services state and special key in the KV. It triggers the following:
+Sensu check configuration files are generated from the templates, the result will be synced via *rsync* and Sensu servers will be restarted using http Supervisord API. All files are generated when application starts and only changes will be processed.
+
+All service checks *tag* are stored in the Consul Key-Value storage in *service/kv_tags_path* path, default *kv_tags_path* is "checks". Tag is the beginning of a service check template name and should be specified as a part of the template name in the Consul KV storage. Note that value should be comma-separated tags list. Rsync repo shuold be named as sensu service name.
+
+It can can be used master server with multiple clients which send processed templates via tcp.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sensu_generator'
+```
+
+Install it yourself as:
+
+    $ gem install sensu_generator
+
+## Usage
+
+sensu_generator start|stop|status|run -- [options]
+
+##### Example:
+
+**consul_url***/kv/nginx/checks*
+```
+check-http, check-tcp
+```
+
+Use ***svc*** (contains service data form consul) and ***check*** (contains *tag* name) in the ERB template.
+***svc.kv_svc_props(key: key)*** can be used to access to ***svc/key*** data.
+If key is not specified it will be requested the whole ***svc/*** folder.
+
+Use Slack as notifier if you want.
+
+##### Check ERB template example:
+
+```
+{
+  "checks": {
+    <% svc.properties.each do |instance| %>
+    <% next if instance.ServiceTags.include? "udp" %>
+     "check-ports-tcp-<%= "#{svc.name}-#{instance.ServiceAddress}-#{instance.ServicePort}" %>": {
+       "command": "check-ports.rb -h <%= instance.ServiceAddress %> -p <%= instance.ServicePort %>",
+       "subscribers": ["roundrobin:sensu-checker-node"],
+       "handlers": ["slack"],
+       "source": "<%= svc.name %>.service"
+      }<%= "," if instance != svc.properties.last %>
+    <% end %>
+  }
+}
+
+
+```
+
+## Configuration
+
+##### server configuration:
+
+```
+"mode": "server",
+"server": {
+  "addr": "", //ip address to listen or left it empty to listen on 0.0.0.0
+  "port": 12345 //listen port
+}
+```
+
+##### client configuration:
+
+```
+"mode": "client",
+"server": {
+  "addr": "", //ip address or domain to connect to
+  "port": 12345 //server port
+}
+```
+
+See *sensu-generator.config.example* for more information.
+
+## Development
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/aksentyev/sensu_generator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the

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/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sensu_generator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/sensu-generator

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+require 'sensu_generator'
+require 'optparse'
+require 'daemons'
+
+module SensuGenerator
+  class << self
+    def parse_args!
+      args = ARGV.dup
+
+      # get elements after '--' because of Daemons
+      args = args[(args.index('--')+1)..-1] if args.include? ('--')
+      config = nil
+      optparse = OptionParser.new do |opts|
+                  opts.banner = "sensu-generator run|start|stop|status -- [options]"
+
+                  opts.on("-c", "--config File", String, "Path to config file") do |item|
+                    config = item
+                  end
+                  opts.on_tail("--version", "Show version") do
+                    puts VERSION
+                    exit
+                  end
+
+                  opts.on_tail("-h", "--help", "Show this message") do
+                    puts opts
+                    exit
+                  end
+                end
+
+      optparse.parse!(args)
+      config ? File.expand_path(config) : nil
+    end
+
+    def run(config_file = nil)
+      config       = Config.new(config_file)
+      logger       = Logger.new(config.get[:logger])
+      logger.level = eval("Logger::#{config.get[:logger][:log_level].upcase}")
+      notifier     = Notifier.new(config.get[:slack])
+      trigger      = Trigger.new
+
+      Application.new(config: config, logger: logger, notifier: notifier, trigger: trigger).run
+    rescue => e
+      msg = %("Sensu_generator exited with non-zero code.\n #{e.to_s} \n#{e.backtrace.join("\n\t")}")
+      Logger.new(file: STDOUT).fatal msg
+    end
+  end
+end
+
+config = SensuGenerator::parse_args!
+
+Daemons.run_proc(__FILE__) do
+  SensuGenerator::run(config)
+end

data/lib/sensu_generator/application.rb

@@ -0,0 +1,134 @@
+require 'thread'
+
+module SensuGenerator
+  class Application
+    class << self
+      def logger
+        @@logger
+      end
+
+      def notifier
+        @@notifier
+      end
+
+      def config
+        @@config
+      end
+
+      def trigger
+        @@trigger
+      end
+    end
+
+    def initialize(config:, logger:, notifier:, trigger:)
+      @@logger   = logger
+      @@notifier = notifier
+      @@config   = config
+      @@trigger  = trigger
+      @threads = []
+    end
+
+    def logger
+      @@logger
+    end
+
+    def notifier
+      @@notifier
+    end
+
+    def config
+      @@config
+    end
+
+    def trigger
+      @@trigger
+    end
+
+    def run_restarter
+      logger.info "Starting restarter..."
+      loop do
+        logger.info 'Restarter is alive!'
+        if restarter.need_to_apply_new_configs?
+          restarter.perform_restart
+        end
+        sleep 60
+      end
+    rescue => e
+      raise ApplicationError, "Restarter error:\n\t #{e.to_s}\n\t #{e.backtrace}"
+    end
+
+    def run_generator
+      logger.info "Starting generator..."
+      generator.flush_results if config.get[:mode] == 'server'
+      state = ConsulState.new
+      loop do
+        logger.info 'Generator is alive!'
+        if state.changed? && state.actualized?
+          generator.services = state.changes
+          list = generator.generate!
+          logger.info "#{list.size} files processed: #{list.join(', ')}"
+          if config.get[:mode] == 'server' && list.empty? && state.changes.any? { |svc| svc.name == config.get[:sensu][:service] }
+            logger.info "Sensu-server service state was changed"
+            trigger.touch
+          end
+        end
+        sleep 60
+        state.actualize
+      end
+    rescue => e
+      raise ApplicationError, "Generator error:\n\t #{e.to_s}\n\t #{e.backtrace}"
+    end
+
+    def run_server
+      server = Server.new
+    rescue => e
+      server&.close
+      raise ApplicationError, "Server error:\n\t #{e.to_s}\n\t #{e.backtrace}"
+    end
+
+    def run
+      logger.info "Starting application #{VERSION}v in #{config.get[:mode]} mode"
+      threads = %w(generator)
+      if config.get[:mode] == 'server'
+        threads << 'restarter'
+        threads << 'server' if config.get[:server][:port]
+      end
+      threads.each do |thr|
+        @threads << run_thread(thr)
+      end
+
+      loop do
+        @threads.each do |thr|
+          unless thr.alive?
+            @threads.delete thr
+            @threads << run_thread(thr.name)
+          logger.error "#{thr.name.capitalize} is NOT ALIVE. Trying to restart."
+          end
+        end
+        sleep 60
+      end
+    end
+
+    private
+
+    def consul
+      @consul ||= Consul.new
+    end
+
+    def generator
+      @generator ||= Generator.new
+    end
+
+    def restarter
+      list = consul.sensu_servers
+      logger.info "Sensu servers discovered: #{list.map(&:address).join(', ')}"
+      Restarter.new(list)
+    end
+
+    def run_thread(name)
+      thr = eval("Thread.new { run_#{name} }")
+      thr.name = name
+      thr
+    end
+  end
+end

data/lib/sensu_generator/check_file.rb

@@ -0,0 +1,27 @@
+require 'fileutils'
+
+module SensuGenerator
+  class CheckFile
+    def self.remove_all_with(prefix)
+      FileUtils.rm(Dir.glob("#{Application.config.result_dir}/#{prefix}*"))
+    end
+
+    def initialize(filename)
+      @config   = Application.config
+      @trigger  = Application.trigger
+      @filename = filename
+      @fullpath = File.join(@config.result_dir, @filename)
+    end
+
+    def write(data)
+      file = File.open(@fullpath, 'w+')
+      file.write data
+      file.close
+      @trigger.touch
+    end
+
+    def remove
+      FileUtils.rm @fullpath
+    end
+  end
+end

data/lib/sensu_generator/client.rb

@@ -0,0 +1,60 @@
+require 'json'
+require 'socket'
+
+module SensuGenerator
+  class Client
+    def initialize
+      @logger = Application.logger
+      @config = Application.config
+      connection
+    end
+
+    attr_reader :config, :logger
+
+    def connection
+      @connection ||= connect
+    end
+
+    def connect
+      logger.info "Client: connecting to server #{server_addr}:#{server_port}"
+      s = TCPSocket.new(server_addr, server_port)
+      logger.info "Client: connected"
+      s
+    rescue => e
+      raise ClientError, "Client: connection failed #{e.inspect} #{e.backtrace}\n"
+    end
+
+    def write_file(data)
+      connection.puts data
+      logger.info "Client: data transferred successfully"
+      true
+    rescue => e
+      close
+      raise ClientError, "Client: write failed #{e.inspect} #{e.backtrace}\n"
+    end
+
+    def flush_results
+      connection.puts JSON.fast_generate({"FLUSH_WITH_PREFIX" => "#{config.file_prefix}" })
+    rescue => e
+      close
+      raise ClientError, "Client: write failed #{e.inspect} #{e.backtrace}\n"
+      close
+    end
+
+    def close
+      @connection.close
+      @connection = nil
+      logger.info "Client: connection closed"
+    end
+
+    private
+
+    def server_addr
+      @server_addr ||= config.get[:server][:addr]
+    end
+
+    def server_port
+      @server_port ||= config.get[:server][:port]
+    end
+  end
+end

data/lib/sensu_generator/config.rb

@@ -0,0 +1,64 @@
+require 'socket'
+require 'json'
+
+module SensuGenerator
+  class Config
+    @@default = {
+                :sensu => {
+                  :check_default_params => {
+                    :refresh => 86400,
+                    :interval => 60,
+                    :aggregate => true
+                  },
+                  :minimal_to_restart => 2,
+                  :service => "sensu-server",
+                  :rsync_repo => "sensu-server",
+                  :supervisor => {:user => "", :password => ""},
+                },
+                :mode => 'server',
+                :server => {
+                  :addr => '',
+                  :port => nil
+                },
+                :result_dir => "work/result",
+                :templates_dir => "work/templates",
+                :logger => {
+                  :file => STDOUT,
+                  :notify_level => "error",
+                  :log_level => "debug"
+                },
+                :slack => {
+                  :url => nil,
+                  :channel => nil,
+                  :level => "error"
+                },
+                :kv_tags_path => "checks",
+                # See diplomat documentation to set proper consul parameters
+                :consul => {
+                  :url => "http://consul.service.consul:8500"
+                }
+              }
+
+    def initialize(path = nil)
+      @config = process(path)
+    end
+
+    def get
+      @config
+    end
+
+    def process(path)
+      custom = path ? JSON(File.read(path), :symbolize_names => true) : {}
+      @config = @@default.deep_merge(custom)
+    end
+
+    def result_dir
+      raise(GeneratorError, "Result dir is not defined!") unless get[:result_dir]
+      File.expand_path(get[:result_dir])
+    end
+
+    def file_prefix
+      @file_prefix ||= get[:mode] == 'server' ? "local_" : "#{Socket.gethostname}_"
+    end
+  end
+end

data/lib/sensu_generator/consul/consul_service.rb

@@ -0,0 +1,47 @@
+module SensuGenerator
+  class ConsulService < Consul
+
+    attr_reader :name, :properties, :checks
+
+    def initialize(name:)
+      @name    = name
+      @changed = true
+      super()
+      all_properties
+      self
+    end
+
+    def all_properties
+      properties = get_props.class == Array ? get_props.map {|el| el.to_h} : get_props.to_h
+      @all_properties ||= { checks: get_checks, properties: properties }
+    end
+
+    alias :get_all_properties :all_properties
+
+    def get_checks
+      @checks ||= kv_svc_props(key: config.get[:kv_tags_path])
+    end
+
+    def get_props
+      @properties ||= get_service_props(name)
+    end
+
+    def update
+      old_all_properties = all_properties.clone
+      reset
+      get_all_properties
+      @changed = true if all_properties != old_all_properties
+    end
+
+    def changed?
+      @changed
+    end
+
+    def reset
+      @all_properties = nil
+      @properties     = nil
+      @checks         = nil
+      @changed = false
+    end
+  end
+end

data/lib/sensu_generator/consul/consul_state.rb

@@ -0,0 +1,45 @@
+module SensuGenerator
+  class ConsulState < Consul
+    def initialize
+      @actual_state = []
+      super()
+      actualize
+    end
+
+    def show
+      @actual_state
+    end
+
+    def actualize
+      reset
+      @svc_list_diff = services.map {|name, _| name.to_s } - @actual_state.map { |svc| svc.name.to_s}
+      @actual_state.each(&:update)
+      @svc_list_diff.each do |name|
+        @actual_state << ConsulService.new(name: name)
+      end
+      @actualized = true
+      logger.debug "Services actualized list: #{@actual_state.map { |svc| svc.name.to_s} }"
+      self
+    end
+
+    def changed?
+      state = !(@svc_list_diff || []).empty? || !changes.empty?
+      logger.debug "Consul state was changed: #{state.to_s}"
+      state
+    end
+
+    def changes
+      @svc_changes ||= @actual_state.select(&:changed?)
+    end
+
+    def reset
+      @actualized = false
+      @svc_changes = nil
+      @svc_list_diff = nil
+    end
+
+    def actualized?
+      @actualized ? true : false # For the case when nil
+    end
+  end
+end

data/lib/sensu_generator/consul.rb

@@ -0,0 +1,66 @@
+require 'json'
+require 'diplomat'
+
+module SensuGenerator
+  class Consul
+    attr_writer :config, :logger
+
+    def initialize
+      @config = config
+      Diplomat.configure do |consul|
+        config.get[:consul].each do |k, v|
+          consul.public_send("#{k}=", v)
+        end
+      end
+    end
+
+    def sensu_servers
+      get_service_props(config.get[:sensu][:service]).map {|el| el.ServiceAddress}.uniq.
+        map {|addr| SensuServer.new(address: addr)}
+    end
+
+    def services
+      Diplomat::Service.get_all.to_h
+    end
+
+    def get_service_props(svc)
+      result = Diplomat::Service.get(svc, :all)
+      result.class == Array ? result.map {|el| el.remove_consul_indexes} : result.remove_consul_indexes
+    end
+
+    def kv_svc_props(svc: name, key: nil)
+      opts = key ? nil : {recurse: true}
+      response = Diplomat::Kv.get("#{svc}/#{key}", opts)
+      key ? JSON(response) : response # Maybe the feature of JSON check configuration will be implemented
+    rescue
+      if response
+        if response.match(/\s+/) || key.to_s == config.get[:kv_tags_path] # tags value is designed to be a list even if it has only one element
+          response.gsub(/\s+/, '').split(',')
+        else
+          response
+        end
+      else
+        []
+      end
+    end
+
+    private
+
+    def config
+      @config ||= Application.config
+    end
+
+    def logger
+      @logger ||= Application.logger
+    end
+  end
+end
+
+class OpenStruct
+  def remove_consul_indexes
+    %w(CreateIndex ModifyIndex).each do |f|
+      self.delete_field(f) if self.respond_to?(f)
+    end
+    self
+  end
+end

data/lib/sensu_generator/exceptions.rb

@@ -0,0 +1,21 @@
+module SensuGenerator
+  %w(ApplicationError RestarterError GeneratorError SensuServerError ClientError ServerError).each do |e|
+    eval(
+      %Q(
+        class #{e} < StandardError
+          def initialize(msg)
+            Application.logger.error msg
+          end
+        end
+      )
+    )
+  end
+end
+
+module Diplomat
+  class PathNotFound < StandardError
+    def initialize(*args)
+      ::SensuGenerator::Application.logger.error "Could not connect to consul with provided url"
+    end
+  end
+end