travis-metrics 2.0.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 202ba9076da5cb2ecedfd3bfc0af052b96eaeac5
+  data.tar.gz: ffaa169c567cce2e4445b168da8fbd5bd345b9ab
+SHA512:
+  metadata.gz: ab7dd5d25bc4775a3e9d1f81ec7e91113fc0bb6b7ceba2cf89093d42403e1b4d044319ee863c1593f5bfee0bda0723f514c8ba187ac9447a5d5a2d46fed2fd27
+  data.tar.gz: 598eacf6c8a7a497a0e08eb5fdc2e3f01543fae208902f2e292d1206319c3dc588db30a94dabd2f2d26df239c5aeeb1ef9dc4f4f5048ee718d6d925af4a7573b

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    travis-metrics (0.0.1)
+      metriks-librato_metrics (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    atomic (1.1.99)
+    avl_tree (1.2.1)
+      atomic (~> 1.1)
+    diff-lcs (1.2.5)
+    hitimes (1.2.3)
+    metriks (0.9.9.7)
+      atomic (~> 1.0)
+      avl_tree (~> 1.2.0)
+      hitimes (~> 1.1)
+    metriks-librato_metrics (1.0.3)
+      metriks (>= 0.9.9.6)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+  travis-metrics!
+
+BUNDLED WITH
+   1.12.5

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+MIT LICENSE
+
+Copyright (c) 2015 Travis CI GmbH <contact@travis-ci.org>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1 @@
+# travis-metrics

data/lib/travis/metrics/reporter/graphite.rb

@@ -0,0 +1,38 @@
+require 'metriks/reporter/graphite'
+
+module Travis
+  class Metrics
+    module Reporter
+      class Graphite < Struct.new(:config, :logger)
+        MSGS = {
+          setup: 'Using Graphite metrics reporter (host: %s, port: %s)',
+          error: 'Graphite error: %s (%s)'
+        }
+
+        def setup
+          return unless host
+          logger.info MSGS[:setup] % [host, port]
+          Metriks::Reporter::Graphite.new(host, port, interval: interval, on_error: method(:on_error))
+        end
+
+        private
+
+          def host
+            config[:host]
+          end
+
+          def port
+            config[:port]
+          end
+
+          def interval
+            config[:interval]
+          end
+
+          def on_error(e)
+            logger.error MSGS[:error] % [e.message, e.respond_to?(:response) ? e.response.body : '?']
+          end
+      end
+    end
+  end
+end

data/lib/travis/metrics/reporter/librato.rb

@@ -0,0 +1,44 @@
+require 'metriks/librato_metrics_reporter'
+
+module Travis
+  class Metrics
+    module Reporter
+      class Librato < Struct.new(:config, :logger)
+        MSGS = {
+          setup: 'Using Librato metrics reporter (source: %s, account: %s)',
+          error: 'Librato error: %s (%s)'
+        }
+
+        def setup
+          return unless email && token
+          logger.info MSGS[:setup] % [source, email]
+          Metriks::LibratoMetricsReporter.new(email, token, source: source, on_error: method(:on_error))
+        end
+
+        private
+
+          def email
+            config[:email]
+          end
+
+          def token
+            config[:token]
+          end
+
+          def source
+            source = config[:source]
+            source = "#{source}.#{dyno}" if dyno
+            source
+          end
+
+          def dyno
+            ENV['DYNO']
+          end
+
+          def on_error(e)
+            logger.error MSGS[:error] % [e.message, e.response.body]
+          end
+      end
+    end
+  end
+end

data/lib/travis/metrics/sidekiq.rb

@@ -0,0 +1,14 @@
+require 'metriks'
+
+module Travis
+  class Metrics
+    class Sidekiq
+      def call(worker, message, queue, &block)
+        ::Metriks.timer("sidekiq.jobs.#{queue}.perform").time(&block)
+      rescue Exception
+        ::Metriks.meter("sidekiq.jobs.#{queue}.failure").mark
+        raise
+      end
+    end
+  end
+end

data/lib/travis/metrics/version.rb

@@ -0,0 +1,5 @@
+module Travis
+  class Metrics
+    VERSION = "2.0.0.rc1"
+  end
+end

data/lib/travis/metrics.rb

@@ -0,0 +1,50 @@
+require 'metriks'
+require 'travis/metrics/reporter/librato'
+require 'travis/metrics/reporter/graphite'
+
+module Travis
+  class Metrics
+    class << self
+      attr_reader :reporter
+
+      MSGS = {
+        no_reporter: 'No metrics reporter configured.',
+        error:       '"Exception while starting metrics reporter: %s"'
+      }
+
+      def setup(config, logger)
+        config[:reporter] ? start(config, logger) : logger.info(MSGS[:no_reporter])
+        new
+      rescue Exception => e
+        logger.error [e.message, e.backtrace].join("\n")
+      end
+
+      def start(config, logger)
+        adapter   = config[:reporter]
+        config    = config[adapter.to_sym] || {}
+        @reporter = Reporter.send(adapter, config, logger)
+        reporter.start
+      end
+
+      def started?
+        !!reporter
+      end
+    end
+
+    def count(key)
+      Metriks.counter(key).increment
+    end
+
+    def meter(key)
+      Metriks.meter(key).mark
+    end
+
+    def time(key, &block)
+      Metriks.timer(key).time(&block)
+    end
+
+    def gauge(key, value)
+      Metriks.gauge(key).set(value)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'travis/metrics'
+require 'support/logger'
+
+RSpec.configure do |c|
+  c.include Support::Logger
+end

data/spec/support/logger.rb

@@ -0,0 +1,13 @@
+require 'logger'
+
+module Support
+  module Logger
+    def self.included(other)
+      other.class_eval do
+        let(:stdout) { StringIO.new }
+        let(:log)    { stdout.string }
+        let(:logger) { ::Logger.new(stdout) }
+      end
+    end
+  end
+end

data/spec/travis/metrics/instrument_spec.rb

@@ -0,0 +1,43 @@
+describe Travis::Metrics do
+  let(:metrics) { described_class.new }
+  let(:key)     { :foo }
+  let(:obj)     { double }
+
+  describe 'count' do
+
+    it 'increments a counter' do
+      expect(Metriks).to receive(:counter).with(key).and_return(obj)
+      expect(obj).to receive(:increment)
+      metrics.count(key)
+    end
+  end
+
+  describe 'meter' do
+    it 'meters an instrument' do
+      expect(Metriks).to receive(:meter).with(key).and_return(obj)
+      expect(obj).to receive(:mark)
+      metrics.meter(key)
+    end
+  end
+
+  describe 'time' do
+    it 'times a block' do
+      called = false
+      block = -> { called = true }
+      expect(Metriks).to receive(:timer).with(key).and_return(obj)
+      expect(obj).to receive(:time).and_yield
+      metrics.time(key, &block)
+      expect(called).to be true
+    end
+  end
+
+  describe 'gauge' do
+    let(:value) { 1 }
+
+    it 'gauges a value' do
+      expect(Metriks).to receive(:gauge).with(key).and_return(obj)
+      expect(obj).to receive(:set).with(value)
+      metrics.gauge(key, value)
+    end
+  end
+end

data/spec/travis/metrics/reporter/graphite_spec.rb

@@ -0,0 +1,37 @@
+describe Travis::Metrics::Reporter::Graphite do
+  let(:config)   { { host: host, port: 1234, interval: 0 } }
+  let(:host)     { 'https://example.com' }
+  let(:reporter) { described_class.new(config, logger) }
+  subject        { reporter.setup }
+
+  def log
+    reporter.setup
+    super
+  end
+
+  describe 'setup' do
+    describe 'returns nil if host is missing' do
+      let(:host) { nil }
+      it { expect(subject).to be_nil }
+    end
+
+    describe 'returns a graphite reporter' do
+      it { expect(subject).to be_kind_of(Metriks::Reporter::Graphite) }
+      it { expect(log).to include "Using Graphite metrics reporter (host: #{host}, port: 1234)" }
+    end
+
+    describe 'on_error' do
+      let(:error) { StandardError.new('message') }
+      before { allow(error).to receive(:response).and_return(double(body: 'body')) }
+      before { allow_any_instance_of(Metriks::Reporter::Graphite).to receive(:write).and_raise(error) }
+
+      before do
+        subject.start
+        sleep 0.1 # ugh.
+        subject.stop
+      end
+
+      it { expect(stdout.string).to include 'Graphite error: message (body)' }
+    end
+  end
+end

data/spec/travis/metrics/reporter/librato_spec.rb

@@ -0,0 +1,37 @@
+describe Travis::Metrics::Reporter::Librato do
+  let(:config)   { { email: email, token: token, source: 'source' } }
+  let(:email)    { 'anja@travis-ci.org' }
+  let(:token)    { 'token' }
+  let(:reporter) { described_class.new(config, logger) }
+  subject        { reporter.setup }
+
+  def log
+    reporter.setup
+    super
+  end
+
+  describe 'setup' do
+    describe 'returns nil if email is missing' do
+      let(:email) { nil }
+      it { expect(subject).to be_nil }
+    end
+
+    describe 'returns nil if token is missing' do
+      let(:token) { nil }
+      it { expect(subject).to be_nil }
+    end
+
+    describe 'returns a librato reporter' do
+      it { expect(subject).to be_kind_of(Metriks::LibratoMetricsReporter) }
+      it { expect(log).to include 'Using Librato metrics reporter (source: source, account: anja@travis-ci.org)' }
+    end
+
+    describe 'on_error' do
+      let(:error) { StandardError.new('message') }
+      before { allow(error).to receive(:response).and_return(double(body: 'body')) }
+      before { allow_any_instance_of(Metriks::LibratoMetricsReporter).to receive(:write).and_raise(error) }
+      before { subject.flush }
+      it { expect(stdout.string).to include 'Librato error: message (body)' }
+    end
+  end
+end

data/travis-metrics.gemspec

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'travis/metrics/version'
+
+Gem::Specification.new do |s|
+  s.name          = "travis-metrics"
+  s.version       = Travis::Metrics::VERSION
+  s.authors       = ['Travis CI']
+  s.email         = 'contact@travis-ci.org'
+  s.homepage      = 'https://github.com/travis-ci/travis-instrumentation'
+  s.summary       = 'Instrumentation for Travis CI'
+  s.description   = "#{s.summary}."
+
+  s.files         = Dir['{lib/**/*,spec/**/*,[A-Z]*}']
+  s.platform      = Gem::Platform::RUBY
+  s.require_paths = ['lib']
+  s.rubyforge_project = '[none]'
+
+  s.add_dependency 'metriks-librato_metrics', '~> 1.0'
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: travis-metrics
+version: !ruby/object:Gem::Version
+  version: 2.0.0.rc1
+platform: ruby
+authors:
+- Travis CI
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: metriks-librato_metrics
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Instrumentation for Travis CI.
+email: contact@travis-ci.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- lib/travis/metrics.rb
+- lib/travis/metrics/reporter/graphite.rb
+- lib/travis/metrics/reporter/librato.rb
+- lib/travis/metrics/sidekiq.rb
+- lib/travis/metrics/version.rb
+- spec/spec_helper.rb
+- spec/support/logger.rb
+- spec/travis/metrics/instrument_spec.rb
+- spec/travis/metrics/reporter/graphite_spec.rb
+- spec/travis/metrics/reporter/librato_spec.rb
+- travis-metrics.gemspec
+homepage: https://github.com/travis-ci/travis-instrumentation
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: "[none]"
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Instrumentation for Travis CI
+test_files: []
+has_rdoc: