comap 1.0.0.pre.a → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 345671b15e5f677976017cfce2b49e64656e615ef7e322c93c379910e1e5f2a3
-  data.tar.gz: e68376648d58e13b9c2853cb84988b2239d74ad061e6a93f466c0f092b37eb11
+  metadata.gz: 8b23f9e291fe03872cb3ef03ff0f00f659d80aee08457bb1fdcd9cb4e7c0260a
+  data.tar.gz: 7b959111f7c9eef215b443cd67b3496e9a16527d7cbc64eddbf37cc66a71f3dd
 SHA512:
-  metadata.gz: eaf027710fde4a00a1a90ad69baae5d3cbd75f3213bd43200c7767c709aa9d823a5cbcd29ac7013530287709d4b9404d1d607aad7a9bdf888415232805f76aac
-  data.tar.gz: '05980b38c30f048e76775eb6367dd018ca8774b68705c57e6dcc6f42e0753e7f7eddf70d4ed01e1dd44be2544c910dc46f27e748c2b1ff93958e0c8782b60903'
+  metadata.gz: dcc368e24710b48e06ee5b7e66f478b45c84d604ce2e86b3b071847484d52d905968ce9719b9d43b2f4bd88c86cbf5bcd9ce80c1ebdccdc0738936e672d1cb9f
+  data.tar.gz: 7581d6850ee0b40422698b9e9a4b6278c5fe60cdd8489742d2cc3137ded4b06cac28c1353086b01ee91f0edb14ef67681a05cd473276b376de257bc933550629

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+Changelog
+=========
+
+1.0.0
+-----
+
+- Initial version with Docker Swarm support

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    comap (1.0.0.pre.pre)
+    comap (1.0.0)
       faraday (~> 0.13)
       json (~> 2.0)
       thin (~> 1.7)

data/README.md

@@ -1,7 +1,21 @@
 COMAP
 =====
 
-Container Orchestrator Metrics Aggregator for Prometheus
+Container Orchestrator Metrics Aggregator for Prometheus.
+
+COMAP aggregates prometheus-formatted metrics from different instances of a
+service in a Docker containers cluster environment (swarm mode) using Docker
+API for service containers discovery.
+
+By design, a single COMAP instance should monitor a single service.
+
+It is best used within a container belonging to the same network as the
+services it follows.
+
+A *container* label is added to each metric with the original container name.
+
+Aggregated metrics intended to be fetched as a target by Prometheus are exposed
+on port 9417.
 
 Installation
 ------------
@@ -23,6 +37,76 @@ Or install it yourself as:
 Usage
 -----
 
+Launch COMAP as a Swarm service, specifying the service (specified by
+service\_name and its internal port) to follow.
+
+It need to access the docker socket of a manager. For a small cluster
+containing managers only, it is possible to mount the docker socket as volume.
+In other (most) case, it is recommended to use tls connection.
+
+```bash
+sdir=/run/secrets docker service create \
+  --network your_network \
+  --publish '9397:9397'  \
+  --secret cert.pem --secret key.pem --secret ca.pem \
+  makeorg/comap          \
+  -H manager -p 2376     \
+  -s client_cert=$sdir/cert.pem,client_key=$sdir/key.pem,ca_file=$sdir/ca.pem \
+  -n your_network service_name:port
+```
+
+If standalone or within your docker image:
+```bash
+Usage: comap [options] swarm_service
+    -H, --docker_host HOST         Docker Engine API Host
+                                   (default: http://127.0.0.1)
+    -p, --docker_port PORT         Docker Engine API Port (default: 2375)
+    -s, --docker_ssl k1=v1,k2=v2   Docker Engine API SSL (default: none)
+    -n, --docker_network NETWORK   Docker swarm service network (default: none)
+    -m, --metrics_path             Metrics path (default: none)
+    -h, --help                     Display this screen
+```
+
+Quickstart
+-------------
+
+[Kitchen](https://kitchen.ci/) is currently used during development for test
+purpose. However, the kitchen test suite can be set up if you just want to
+quickly see COMAP running :
+
+    $ kitchen converge
+
+That should brings up a functional docker-in-docker swarm environment with a
+manager/worker and a stand-alone consul. Configuration is automatically
+handled with Chef and some
+[Chef Platform cookbooks](https://gitlab.com/chef-platform/).
+
+    $ kitchen login comap-swarm-manager-centos-7
+
+You can now play with the services running in the swarm :
+
+
+A metrics service with two replicas exposing prometheus-formatted metrics
+on 5678 port
+
+
+      [root@comap-swarm-manager-centos-7 /]# curl localhost:5678
+      # TYPE metrics_sample_seconds gauge
+      metrics_sample_seconds 42
+      # TYPE metrics_sample_2_seconds gauge
+      metrics_sample_2_seconds 24
+
+A single COMAP service exposing aggregated metrics from previous service
+on 9397 port
+
+      [root@comap-swarm-manager-centos-7 /]# curl localhost:9397
+      # TYPE metrics_sample_seconds gauge
+      metrics_sample_seconds{container="metrics.1"} 42
+      metrics_sample_seconds{container="metrics.2"} 42
+      # TYPE metrics_sample_2_seconds gauge
+      metrics_sample_2_seconds{container="metrics.1"} 24
+      metrics_sample_2_seconds{container="metrics.2"} 24
+
 Development
 -----------
 

data/Rakefile

@@ -26,7 +26,11 @@ task default: :spec
 desc 'Prepare files directory for kitchen tests'
 task kitchen: :build do
   mkdir_p('files')
-  cp("pkg/comap-#{COMAP::VERSION}.gem", 'files/comap.gem', preserve: false)
+  version = if COMAP::VERSION.include?('-')
+              COMAP::VERSION.split('-').insert(1, 'pre').join('.')
+            else COMAP::VERSION
+            end
+  cp("pkg/comap-#{version}.gem", 'files/comap.gem', preserve: false)
   cp('Dockerfile', 'files/.', preserve: false)
 end
 CLEAN.include('files', 'pkg')

data/lib/comap.rb

@@ -43,20 +43,20 @@ module COMAP
     end
 
     def add_docker_ssl_option(opts)
-      desc = "Docker Engine API SSL (default: #{@config[:docker_ssl]})"
+      desc = 'Docker Engine API SSL (default: none)'
       help = '--docker_ssl k1=v1,k2=v2'
       opts.on('-s', help, desc) { |v| @config[:docker_ssl] = v }
     end
 
     def add_network_option(opts)
-      desc = "Docker swarm service network (default: #{@config[:network]})"
+      desc = 'Docker swarm service network (default: none)'
       help = '--docker_network NETWORK'
       opts.on('-n', help, desc) { |v| @config[:network] = v }
     end
 
     def add_metrics_path_option(opts)
       desc = "Metrics path (default: #{@config[:metrics_path]})"
-      help = '--metrics_path'
+      help = '--metrics_path METRICS_PATH'
       opts.on('-m', help, desc) { |v| @config[:metrics_path] = v }
     end
 
@@ -93,7 +93,7 @@ module COMAP
       }
       parse_opts
       app = COMAP::App.new(@config)
-      Rack::Server.start(app: app, Host: '0.0.0.0', Port: 9100)
+      Rack::Server.start(app: app, Host: '0.0.0.0', Port: 9397)
     end
   end
   # rubocop:enable  Metrics/MethodLength

data/lib/comap/app.rb

@@ -71,7 +71,7 @@ module COMAP
       data.lines.each_with_object({}) do |value, hash|
         next hash[value] = nil if value.start_with?('#')
         (hash[hash.keys.last] ||= []) << add_label(value, "#{service}.#{slot}")
-      end
+      end.compact
     end
 
     def scrape_metrics(url, service)
@@ -85,7 +85,7 @@ module COMAP
 
     def add_label(line, label)
       replace = %(container="#{label}")
-      line.gsub(/ /, "{#{replace}} ").gsub(/}{/, ',')
+      line.sub(/ /, "{#{replace}} ").sub(/}{/, ',')
     end
 
     def containers(service)
@@ -103,7 +103,7 @@ module COMAP
         'desired-state' => { 'running' => true }
       }
       @client.call('tasks', filters).keep_if do |task|
-        task['Status']['State'] == 'running'
+        task['Status']['State'] == 'running' if task.is_a?(Hash)
       end
     end
 

data/lib/comap/version.rb

@@ -17,5 +17,5 @@
 
 # Define version
 module COMAP
-  VERSION = '1.0.0-a'
+  VERSION = '1.0.0'
 end

data/recipes/build_comap.rb

@@ -29,7 +29,7 @@ cookbook_file '/root/pkg/comap.gem' do
 end
 
 execute 'docker build comap' do
-  command 'docker build . -t makeorg/comap'
+  command 'docker build . -t makeorg/comap-for-kitchen-test'
   cwd '/root'
   action :nothing
 end

data/recipes/launch_comap.rb

@@ -44,23 +44,20 @@ end
 
 server = 'https://comap-swarm-manager-centos-7'
 ssl = {
-  'verify' => false, # https://github.com/berkshelf/berkshelf/issues/1458
   'client_cert' => '/run/secrets/cert.pem',
   'client_key' => '/run/secrets/key.pem',
   'ca_file' => '/run/secrets/ca.pem'
 }
 ssl_opt = ssl.map { |k, v| "#{k}=#{v}" }.join(',')
-puts "-H #{server} -p 2376 -s #{ssl_opt} -n kitchen metrics:5678"
 
-# TODO: give options as an array in docker-platform
 docker_platform_service 'comap' do
   options(
     mode: 'replicated',
     network: 'kitchen',
-    publish: '9100:9100',
+    publish: '9397:9397',
     secret: %w[cert.pem key.pem ca.pem]
   )
-  image 'makeorg/comap'
+  image 'makeorg/comap-for-kitchen-test'
   command "-H #{server} -p 2376 -s #{ssl_opt} -n kitchen metrics:5678"
   action :create
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: comap
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.a
+  version: 1.0.0
 platform: ruby
 authors:
 - Sylvain Arrambourg
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-09 00:00:00.000000000 Z
+date: 2018-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -138,6 +138,7 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - Berksfile
+- CHANGELOG.md
 - CONTRIBUTING.md
 - Dockerfile
 - Gemfile
@@ -171,9 +172,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.3