consul-templaterb 1.0.3

data/lib/consul/async/process_handler.rb

@@ -0,0 +1,64 @@
+module Consul
+  module Async
+    class ProcessDoesNotExist < StandardError
+    end
+    class ProcessHandler
+      attr_reader :command, :sig_reload, :sig_term, :pid, :exit_status
+      def initialize(command, sig_reload: 'HUP', sig_term: 'TERM')
+        raise 'empty sig_term is not supported' unless sig_term
+        @command = command
+        @sig_reload = sig_reload
+        @sig_term = sig_term
+        @pid = nil
+        @exit_status = nil
+      end
+
+      def start
+        return pid unless pid.nil?
+        @pid = Process.spawn(command)
+      end
+
+      def reload
+        return if sig_reload.nil?
+        STDERR.puts "Sending SIG #{sig_reload} to #{pid}..."
+        begin
+          Process.kill(sig_reload, pid)
+        rescue Errno::ESRCH => e
+          STDERR.puts "*** Process #{pid} has already been killed: #{e.inspect}"
+          raise e
+        end
+      end
+
+      def kill
+        return exit_status if pid.nil?
+        the_pid = pid
+        @pid = nil
+        STDERR.puts "[KILL] Sending SIG #{sig_term} to #{the_pid}..."
+        begin
+          STDERR.puts "[KILL] waiting for #{the_pid}..."
+          Process.kill(sig_term, the_pid)
+        rescue Errno::ESRCH
+          STDERR.puts "[KILL] *** Process #{the_pid} has already been killed"
+        end
+        begin
+          _pid, @exit_status = Process.waitpid2 the_pid
+        rescue SystemCallError
+          STDERR.puts "[KILL] *** UNEXPECTED ERROR *** Failed to get return code for #{the_pid}"
+        end
+        exit_status
+      end
+
+      def process_status
+        raise ProcessDoesNotExist, 'No child process' if pid.nil?
+        begin
+          cpid, result = Process.waitpid2(pid, Process::WNOHANG)
+          raise ProcessDoesNotExist, "Unexpected PID: #{cpid}, was expecting #{pid}" unless cpid.nil? || cpid == pid
+          result
+        rescue Errno::ECHILD => e
+          e2 = ProcessDoesNotExist.new e
+          raise e2, "ChildProcess has been killed: #{e.message}", e.backtrace
+        end
+      end
+    end
+  end
+end

data/lib/consul/async/utilities.rb

@@ -0,0 +1,17 @@
+module Consul
+  module Async
+    class Utilities
+      def self.bytes_to_h(bytes)
+        if bytes < 1024
+          "#{bytes} b"
+        elsif bytes < 1_048_576
+          "#{(bytes / 1024).round(2)} Kb"
+        elsif bytes < 1_073_741_824
+          "#{(bytes / 1_048_576.0).round(2)} Mb"
+        else
+          "#{(bytes / 1_073_741_824.0).round(2)} Gb"
+        end
+      end
+    end
+  end
+end

data/lib/consul/async/version.rb

@@ -0,0 +1,5 @@
+module Consul
+  module Async
+    VERSION = '1.0.3'.freeze
+  end
+end

data/samples/checks.html.erb

@@ -0,0 +1,96 @@
+<%
+# This template can be configure the following way with environment variables
+# Environment variables to filter services/instances
+#   SERVICES_TAG_FILTER: basic tag filter for service (default HTTP)
+  services_tag_filter = ENV['SERVICES_TAG_FILTER']
+  def status_to_class(status)
+    if status == 'passing'
+      'success'
+    elsif status == 'warning'
+      'warning'
+    elsif status == 'critical'
+      'danger'
+    else
+      'info'
+    end
+  end
+  %>
+<%= render_file 'common/header.html.erb' %>
+<style type="text/css">
+.check {
+  transition: opacity 1s ease-out;
+}
+</style>
+<script type="text/javascript">
+  function updateStates() {
+    states = ['passing', 'warning', 'critical']
+    stylesheet = document.getElementById('css-states');
+    txt = "";
+    for (var i in states) {
+      var s = states[i];
+      is_checked = document.getElementById('show_'+s).checked
+      var to_append = "." + s + " { ";
+      if (is_checked) {
+        to_append += "opacity: 1; height: auto;"
+      } else {
+        to_append += "opacity: 0; height: 0; overflow: hidden;"
+      }
+      to_append += " }\r\n"
+      txt +=  to_append;
+    }
+    stylesheet.textContent = txt;
+  }
+</script>
+<div class="container-fluid">
+  <div class="row">
+    <nav class="col-2">
+      <ul>
+        <%
+          all_services = services(tag: services_tag_filter)
+          all_services.each do |service_name, tags|
+        %>
+        <li><a href="#service_<%= service_name %>"><%= service_name %></a></li>
+        <% end %>
+      </ul>
+    </nav>
+    <main class="col-10">
+      <div class="float-right">
+        <div class="state-selector">
+          <input id="show_passing" type="checkbox" class="checks-visibility" value="passing" checked="checked" onchange="updateStates()"/>
+          <label for="show_passing"><span class="badge badge-success">Passing</span></label>
+        </div>
+        <div class="state-selector">
+          <input id="show_warning" type="checkbox" class="checks-visibility" value="warning" checked="checked" onchange="updateStates()"/>
+          <label for="show_warning"><span class="badge badge-warning">Warning</span></label>
+        </div>
+        <div class="state-selector">
+          <input id="show_critical" type="checkbox" class="checks-visibility" value="critical" checked="checked" onchange="updateStates()"/>
+          <label for="show_critical"><span class="badge badge-danger">Critical</span></label>
+        </div>
+    </div>
+
+      <h1 id="services">Services <%= services_tag_filter ? " tag: #{services_tag_filter}" : 'No filtering' %></h1>
+      <% all_services.each do |service_name, tags| %>
+      <div class="service" id="service_<%= service_name %>">
+        <h2>Service <%= service_name %></h2>
+        <div class="list-group">
+          <% checks_for_service(service_name).each do |check| %>
+          <div class="list-group-item check <%= check['Status'] %>" id="<%= check['CheckID'] %>">
+            <div class="d-flex align-items-center justify-content-between">
+              <h5>
+                <%= check['Name'] %> / <%= check['Node'] %>
+              </h5>
+              <span class="badge badge-pill badge-<%= status_to_class(check['Status']) %>"><%= check['Status'] %></span>
+            </div>
+            <p><%= ERB::Util.html_escape(check['Notes']) %></p>
+            <code><%= ERB::Util.html_escape(check['Output']) %></code>
+          </div>
+          <% end %>
+        </div>
+      </div>
+      <% end %>
+    </main>
+  </div>
+</div>
+<script type="text/javascript">updateStates();</script>
+<%= render_file 'common/footer.html.erb' %>

data/samples/common/footer.html.erb

@@ -0,0 +1,10 @@
+    </div>
+    </main>
+    <!-- Bootstrap core JavaScript
+    ================================================== -->
+    <!-- Latest compiled and minified JavaScript -->
+    <script src="https://code.jquery.com/jquery-3.2.1.slim.min.js" integrity="sha384-KJ3o2DKtIkvYIK3UENzmM7KCkRr/rE9/Qpg6aAZGJwFDMVNA/GpGFF93hXpG5KkN" crossorigin="anonymous"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.12.9/umd/popper.min.js" integrity="sha384-ApNbgh9B+Y1QKtv3Rn7W3mgPxhU9K/ScQsAP7hUibX39j7fakFPskvXusvfa0b4Q" crossorigin="anonymous"></script>
+    <script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/js/bootstrap.min.js" integrity="sha384-JZR6Spejh4U02d8jOt6vLEHfe/JQGiRRSQQxSfFWpi1MquVdAyjUar5+76PVCmYl" crossorigin="anonymous"></script>
+  </body>
+</html>

data/samples/common/header.html.erb

@@ -0,0 +1,51 @@
+<%
+  # This template can be configure the following way with environment variables
+  # CONSUL_TOOLS_SUFFIX: suffix for the address of consul tools
+  # CONSUL_TOOLS_PREFIX: prefix for the address of consul tools
+  # CONSUL_TOOLS: comma sperated list of consul tools
+  tools = (ENV['CONSUL_TOOLS'] || 'criteo_choregraphies,checks,services,nodes,keys').split(",")
+  suffix = ENV['CONSUL_TOOLS_PREFIX'] || '.html'
+  prefix = ENV['CONSUL_TOOLS_SUFFIX'] || ''
+%>
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <meta name="description" content="Display Consul information">
+    <meta name="author" content="Criteo">
+    <meta http-equiv="refresh" content="<%= ENV['REFRESH'] || '600' %>"/>
+
+    <title><%= ENV['TITLE'] || 'Consul Real Time information'%></title>
+
+    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/css/bootstrap.min.css" integrity="sha384-Gn5384xqQ1aoWXA+058RXPxPg6fy4IWvTNh0E263XmFcJlSAwiGgFAW/dAiS6JXm" crossorigin="anonymous">
+    <style type="text/css">
+      body {
+      padding-top: 5rem;
+      }
+      .check {
+        transition: opacity 1s ease-out;
+      }
+    </style>
+    <style type="text/css" id="css-states">
+    </style>
+  </head>
+
+  <body>
+
+    <nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top">
+      <a class="navbar-brand" href="#">Consul</a>
+      <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarsExampleDefault" aria-controls="navbarsExampleDefault" aria-expanded="false" aria-label="Toggle navigation">
+        <span class="navbar-toggler-icon"></span>
+      </button>
+
+      <div class="collapse navbar-collapse" id="navbarsExampleDefault">
+        <ul class="navbar-nav mr-auto">
+          <% tools.each do |tool| %>
+          <li class="nav-item">
+            <a class="nav-link" href="<%= prefix + tool + suffix %>"><%= tool.gsub('_', ' ') %></a>
+          </li>
+          <% end %>
+        </ul>
+      </div>
+    </nav>

data/samples/consul_template.html.erb

@@ -0,0 +1,94 @@
+<!doctype html>
+<html lang="fr">
+  <head>
+    <meta charset="UTF-8"/>
+    <meta http-equiv="refresh" content="300"/>
+    <title>Consul Full Info</title>
+    <style type="text/css">
+.passing {
+  color:green;
+}
+.warning {
+  color: orange;
+}
+.critical {
+  color: red;
+}
+.qlink {
+  text-decoration: none;
+}
+</style>
+  </head>
+  <body>
+<% require 'base64'
+   require 'json'
+   require 'date'
+%>
+<nav>
+  <ul>
+    <li><a href="#datacenters">DataCenters</a></li>
+    <li><a href="#list_services">List of services</a></li>
+    <li><a href="#services">Services with instances</a></li>
+    <li><a href="#nodes">All Nodes</a></li>
+    <li><a href="#kv">Key/Value Store</a></li>
+  </ul>
+</nav>
+<h1 id="datacenters">List of all datacenters</h1>
+<ul>
+<% datacenters.each do |dc| %>
+  <li id="dc_<%=dc %>%"><%= dc %> with <%= services(dc:dc).keys.count %> services, <%= nodes(dc:dc).count %> nodes</li>
+<% end %>
+</ul>
+
+<h1 id="list_services">List of all services in current DC</h1>
+<ul>
+<% services.each do |service_name, tags|
+ %>
+  <li><a href="#service_<%= service_name %>"><%= service_name %></a> <%= tags.sort %></li>
+<% end %>
+</ul>
+
+<h1 id="services">List all services instances sorted by node name</h1>
+<% services.each do |service_name, tags|
+%><h2 id="service_<%= service_name %>" title="<%= tags %>"><%= service_name %> <a class="qlink" href="#service_<%= service_name %>">&#128279;</a></h2>
+<ul>
+<%     service(service_name).sort {|a,b| a['Node']['Node'] <=> b['Node']['Node'] }.each do |snode|
+  tags = snode['Service']['Tags'].sort
+  addr = snode['Node']['Address']
+  port_num = snode['Service']['Port'].to_i
+  port = port_num && port_num > 0 ? ":#{port_num}" : ''
+  url = if tags.include? 'https'
+          "https://#{addr}#{port}"
+        elsif tags.include? 'http'
+          "http://#{addr}#{port}"
+        elsif tags.include? 'ftp'
+          "ftp://#{addr}#{port}"
+        else
+          nil
+        end
+%><li><a <%= url ? "href=\"#{url}\"" : nil %>><%=
+  snode['Node']['Node'] %><%= port %></a>
+  <span class="tags"><%= snode['Service']['Tags'].sort %></tag>
+  <span class="statuses"><%
+  snode['Checks'].each do |c| %> <span title="<%= c['Name']%>" class="<%= c['Status'] %>"><%= c['Status']
+  %></span><% end if snode['Checks'] %></span></li>
+<% end%>
+</ul>
+<% end%>
+
+
+<h1 id="nodes">List all nodes for DC, sorted by name</h1>
+<ul>
+<% nodes.sort {|a,b| a['Node'] <=> b['Node'] }.each do |snode|
+%> <li id="node_#{snode['ID']"><%= snode['Address'].ljust(16) %> <%= snode['Node'] %></li>
+<% end %>
+</ul>
+
+<h1 id="kv">KV of Current DC</h1>
+<ul>
+<% kv(keys:true).each do |key|
+%><li id="kv_#{key}"><%= key %></li>
+<% end %>
+</ul>
+</body>
+</html>

data/samples/consul_template.json.erb

@@ -0,0 +1,77 @@
+<%
+# This template can be configure the following way with environment variables
+# Environment variables to filter services/instances
+#   SERVICES_TAG_FILTER: basic tag filter for service (default HTTP)
+#   INSTANCE_MUST_TAG: Second level of filtering (optional, default to SERVICES_TAG_FILTER)
+#   INSTANCE_EXCLUDE_TAG: Exclude instances having the given tag (default: canary)
+#   EXCLUDE_SERVICES: comma-separated services to exclude (default: consul-agent-http,mesos-slave,mesos-agent-watcher)
+
+  service_tag_filter = ENV['SERVICES_TAG_FILTER'] || 'http'
+  instance_must_tag = ENV['INSTANCE_MUST_TAG'] || service_tag_filter
+  instance_exclude_tag = ENV['INSTANCE_EXCLUDE_TAG'] || 'canary'
+
+  # Services to hide
+  services_blacklist = (ENV['EXCLUDE_SERVICES'] || 'consul-agent-http,mesos-slave,mesos-agent-watcher,mesos-exporter-slave').split(',')
+  # Compute the health of a Service
+  def compute_state(snode)
+    states = ['passing', []]
+    snode['Checks'].each do |chk|
+      st = chk['Status']
+      states[1] << st
+      if st == 'critical'
+        states[0] = st
+      elsif st == 'warning' && states[0] == 'passing'
+        states[0] = st
+      end
+    end
+    states
+  end
+  def compute_attributes(snode)
+    w = 100
+    snode['Service']['Tags'].each do |tag|
+      match = /^weight-([1-9][0-9])*$/.match(tag)
+      w = match[1].to_i if match
+    end
+    attributes = ""
+    states = compute_state(snode)
+    attributes = "#{attributes} disabled" if states[0] == 'critical'
+    if states[0] == 'warning'
+      w = w / 8
+    end
+    attributes = "#{attributes} weight #{w}" if w.positive?
+  end
+  backends = {}
+  services(tag: service_tag_filter).each do |service_name, tags|
+    if !services_blacklist.include?(service_name) && tags.include?(instance_must_tag)
+      the_backends = []
+      service(service_name, tag:'http').sort {|a,b| a['Node']['Node'] <=> b['Node']['Node'] }.each do |snode|
+        tags_of_instance = snode['Service']['Tags']
+        if tags_of_instance.include?(instance_must_tag) && !tags_of_instance.include?(instance_exclude_tag)
+          the_backends << snode if snode['Service']['Port']
+        end
+      end
+      # We add the backend ONLY if at least one valid instance does exists
+      backends[service_name] = the_backends
+    end
+  end
+%><%
+  json_backends = {}
+  backends.each_pair do |service_name, nodes|
+    service = {
+      name:      service_name,
+      count:     nodes.count,
+      instances: []
+    }
+    json_backends[service_name] = service
+    nodes.each do |snode|
+      server = { frontend_id: "backend_http__#{service_name}",
+                 id:     snode['Service']['ID'],
+                 addr:   snode['Node']['Address'],
+                 port:   snode['Service']['Port'],
+                 tags:   snode['Service']['Tags'],
+      }
+      service[:instances] << server
+    end
+  end
+  json = { services: json_backends}
+%><%= JSON.pretty_generate(json) %>

data/samples/consul_template.txt.erb

@@ -0,0 +1,45 @@
++ List of all datacenters
+-------------------------
+<% datacenters.  each do |dc| %>
+  * <%= dc %> with <%= services(dc:dc).keys.count %> services, <%= nodes(dc:dc).count %> nodes
+<% end %>
+
+===========
+
++ List of all services in current DC
+------------------------------------
+<% services.each do |service_name, tags|
+ %>  * <%= service_name %> [ <%= tags %> ]
+<% end %>
+
+===========
+
++ List all services instances with http tag on current DC, instances sorted by node name
+----------------------------------------------------------------------------------------
+<% services.each do |service_name, tags|
+     if tags.include? 'http'
+%>  ++ Service <%= service_name %>
+<%     service(service_name, tag:'http').sort {|a,b| a['Node']['Node'] <=> b['Node']['Node'] }.each do |snode|
+%>  * <%= service_name %> -> <%=
+  snode['Node']['Node'] %>:<%= snode['Service']['Port'] %>  <%=
+  snode['Service']['Tags'] %> status: <%
+  snode['Checks'].each do |c| %> <%= c['Status']
+  %><% end if snode['Checks'] %>
+<%     end
+     end
+   end %>
+
+===========
+
++ List all nodes for DC, sorted by name
+---------------------------------------
+<% nodes.sort {|a,b| a['Node'] <=> b['Node'] }.each do |snode|
+%>  * <%= snode['Address'].ljust(16) %> <%= snode['Node'] %>
+<% end %>
+
++ KV of Current DC
+------------------
+
+<% kv(keys:true).each do |key|
+%> * <%= key %>
+<% end %>