falcore 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba2b736dbebc64f028d7fccc61a1f7d964a1dc0b
-  data.tar.gz: d072fc223b6ac83e19ca3570b73b95cad33b9067
+  metadata.gz: ebc83f332274914a6d13586077516e385a0699cf
+  data.tar.gz: 0bf7525e7a91aaa74a40cfc086abd2ef8db434e6
 SHA512:
-  metadata.gz: 43086275160a917b36e946dfce95e420ff8b2ad2cb43800b9cf82cc68299ee883475538a3dd5dc1a7e605c6bbbb0e5a53bd4760aea0a959c32aad70c994aed64
-  data.tar.gz: ab1392a98ecf7530419468979998abd107bd6134840ddc4d91c180db6d50821f9977183490b82b9616edd132378bbc2935a6171f15970834a0adc5c983faad4d
+  metadata.gz: c8c761b694a8207112f06e86a4511666b3bc3b155a0ebb5a2ff41c93b3ef7b31caff66110792c4073a686753db9bd02b53b066458d625921b82e295544dd938b
+  data.tar.gz: cc5304c2238066debecc98685e7e316e1983f8413ed6cc16765ff1ba8a613a00af30d03e574c4d3e9925076f27af5ca410d80a562ccc9e39119961214957ef67

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 Falcore CHANGELOG
 =================
 
+v0.2.0
+------
+- Add a special dumper for DogStatsd
+
 v0.1.1
 ------
 - Convert `--sleep` values to floats

data/README.md

@@ -76,6 +76,43 @@ varies by dumper, so consult the documentation accordingly:
   falcore --config /path/to/your/config.falcore --daemon
   ```
 
+Dumpers
+-------
+### Statsd
+The Statsd dumper is a generic Statsd dumper that namespaces data by hostname.
+
+```text
+[statsd]
+  host = 127.0.0.1
+  port = 8125
+```
+
+This will dump information to a local Statsd on port 8125. The information is
+namespaced by the Jenkins master, and slaves are nested under their appropiate
+master. For example:
+
+```text
+jenkins.master.disk_space
+jenkins.master.slave-12345.disk_space
+```
+
+### DogStatsd
+The DogStatsd dumper is a [DataDog](http://datadoghq.com)-specific dumper that
+adds additional sugar when pushing the data to DataDog. The format for the
+configuration is almost identical to Statsd, but with a different config header.
+
+```text
+[dogstatsd]
+  host = 127.0.0.1
+  port = 8125
+```
+
+This will dump information to a local DogStatsd server running on port 8125.
+Unlike the Statsd dumper, the information is **not** namespaced. Instead, each
+node (master or slave) is tagged with a `name` that corresponds to the Jenkins
+`displayName` attribute. You can then filter or aggregate by `name` to separate
+information on the graphs.
+
 
 License & Authors
 -----------------

data/bin/falcore

@@ -74,5 +74,9 @@ loop do
     Falcore::Dumper::Statsd.new(config, master).run
   end
 
+  unless config.dogstatsd.nil?
+    Falcore::Dumper::DogStatsd.new(config, master).run
+  end
+
   sleep(options[:sleep]/1_000)
 end

data/falcore.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'statsd-ruby', '~> 1.2'
+  spec.add_runtime_dependency 'dogstatsd-ruby', '~> 1.3'
 
   spec.add_development_dependency 'bundler', '~> 1.5'
   spec.add_development_dependency 'rspec',   '~> 2.14'

data/lib/falcore.rb

@@ -26,8 +26,9 @@ module Falcore
   autoload :Util,       'falcore/util'
 
   module Dumper
-    autoload :Base,   'falcore/dumpers/base'
-    autoload :Statsd, 'falcore/dumpers/statsd'
+    autoload :Base,      'falcore/dumpers/base'
+    autoload :DogStatsd, 'falcore/dumpers/dogstatsd'
+    autoload :Statsd,    'falcore/dumpers/statsd'
   end
 
   module Node

data/lib/falcore/dumpers/dogstatsd.rb

@@ -0,0 +1,80 @@
+#
+# Author: Seth Vargo <sethvargo@gmail.com>
+#
+# Copyright 2014 Chef Software, Inc.
+#
+# 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 'statsd'
+
+module Falcore
+  class Dumper::DogStatsd < Dumper::Base
+    validate do
+      presence!('DogStatsd host') { config.dogstatsd.host }
+      presence!('DogStatsd port') { config.dogstatsd.port }
+    end
+
+    run do
+      stat(master)
+      master.slaves.each(&method(:stat))
+    end
+
+    private
+
+    def statsd
+      @statsd ||= Statsd.new(config.dogstatsd.host, config.dogstatsd.port)
+    end
+
+    #
+    # @private
+    #
+    # Push stats to statsd for this particular +node+.
+    #
+    # @param [Node::Base] node
+    #   the node to examine
+    #
+    def stat(node)
+      options = {
+        tags: ["name:#{node.display_name}"]
+      }
+
+      # Up/down
+      statsd.gauge('jenkins.node.offline', node.offline? ? 1 : 0, options)
+
+      # Idle
+      statsd.gauge('jenkins.node.idle', node.idle? ? 1 : 0, options)
+
+      # Response time
+      statsd.timing('jenkins.node.response_time', node.response_time, options)
+
+      # Temporary space
+      statsd.gauge('jenkins.node.temporary_space', node.temporary_space, options)
+
+      # Disk space
+      statsd.gauge('jenkins.node.disk_space', node.disk_space, options)
+
+      # Free memory
+      statsd.gauge('jenkins.node.free_memory', node.free_memory, options)
+
+      # Total memory
+      statsd.gauge('jenkins.node.total_memory', node.total_memory, options)
+
+      # Free swap
+      statsd.gauge('jenkins.node.free_swap', node.free_swap, options)
+
+      # Total swap
+      statsd.gauge('jenkins.node.total_swap', node.total_swap, options)
+    end
+  end
+end

data/lib/falcore/version.rb

@@ -17,5 +17,5 @@
 #
 
 module Falcore
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/spec/functional/dumpers/dogstatsd_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+module Falcore
+  describe Dumper::DogStatsd, :integration do
+    let(:config) do
+      Config.parse <<-EOH.gsub(/^ {8}/, '')
+        [jenkins]
+          endpoint = http://master.jenkins.example.com
+
+        [dogstatsd]
+          host = 127.0.0.1
+          port = 12345
+      EOH
+    end
+
+    let(:aggregator) { Aggregator.new(config) }
+    let(:master) { aggregator.run }
+
+    subject { Dumper::DogStatsd.new(config, master) }
+
+    it 'validates config.dogstatsd.host is present' do
+      config.dogstatsd.host = nil
+
+      expect {
+        subject.run
+      }.to raise_error(RuntimeError, "Expected 'DogStatsd host' to be set!")
+    end
+
+    it 'validates config.dogstatsd.port is present' do
+      config.dogstatsd.port = nil
+
+      expect {
+        subject.run
+      }.to raise_error(RuntimeError, "Expected 'DogStatsd port' to be set!")
+    end
+  end
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: falcore
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Seth Vargo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-08 00:00:00.000000000 Z
+date: 2014-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: statsd-ruby
+  name: dogstatsd-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -117,6 +117,7 @@ files:
 - lib/falcore/aggregator.rb
 - lib/falcore/config.rb
 - lib/falcore/dumpers/base.rb
+- lib/falcore/dumpers/dogstatsd.rb
 - lib/falcore/dumpers/statsd.rb
 - lib/falcore/fetcher.rb
 - lib/falcore/nodes/base.rb
@@ -126,6 +127,7 @@ files:
 - lib/falcore/util.rb
 - lib/falcore/version.rb
 - spec/fixtures/computer.json
+- spec/functional/dumpers/dogstatsd_spec.rb
 - spec/functional/dumpers/statsd_spec.rb
 - spec/functional/fetcher_spec.rb
 - spec/spec_helper.rb
@@ -164,6 +166,7 @@ summary: A Ruby application for collecting Jenkins node slave status and aggrega
   to multiple output formats.
 test_files:
 - spec/fixtures/computer.json
+- spec/functional/dumpers/dogstatsd_spec.rb
 - spec/functional/dumpers/statsd_spec.rb
 - spec/functional/fetcher_spec.rb
 - spec/spec_helper.rb