telltale 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3f430fa5cc97024ccd48df79272a985e7ac38c0
-  data.tar.gz: 6f4f841816fd08dbfc41686c4cce8a259178a85a
+  metadata.gz: 4304b4c63a305124212552fb5fd320ff24e57c86
+  data.tar.gz: 507d4254e2adf0d1c8678ba01a838b40d9c1ae7a
 SHA512:
-  metadata.gz: 14829cad71505623efd5689258094d6129e532d4318c387729787e077d9a828c4312e065a781e63587f72ac6522bb47639dd42c9c7520c93a5730b745678e4ea
-  data.tar.gz: 3ee53c67ee0dcba82576ce5ce35c38c184989e54948c9ce029bdc4e5e5c4506e695ff50c214b67c0de643bc8f19f8bd441ca7193cf5fe4477c8b43fbf6609516
+  metadata.gz: bce6a6c780f9bb5a05f783518dd5bcfee5306c50ab1052e5969feaa11ae7a6eac4fc9f133c07928a3e6934131ef8c76fac03aeefca250d3550cba322cddb4921
+  data.tar.gz: df4e8574926ae457f84b6daf6dd18e8d99aea13df403be12bc5b75e57c205355ec1e7ce02eb947d10e8d62399da6c98f08960ce0ada9cfb33d82e3afc737eefa

data/.gitignore

@@ -0,0 +1,38 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+/spec/examples.txt

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master
 
+## v0.2
+
+* Request Count Metric
+
 ## v0.1.1
 
 * Reporting disabled for test environment.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    telltale (0.1.1)
+      opentsdb (~> 0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    opentsdb (0.2.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.2)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+  telltale!
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -2,6 +2,9 @@
 
 Report Rails application metrics to OpenTSDB.
 
+[![Build Status](https://travis-ci.org/ninech/telltale.svg?branch=master)](https://travis-ci.org/ninech/telltale)
+[![Code Climate](https://codeclimate.com/github/ninech/telltale/badges/gpa.svg)](https://codeclimate.com/github/ninech/telltale)
+
 ## Instructions
 
 Add the following line to your `Gemfile` and run `bundle install`.
@@ -24,6 +27,7 @@ environment variables.
 These numbers are currently reported:
 
 * `<prefix>.rails.total_time`: Total request time in seconds
+* `<prefix>.rails.request_count`: A counter for requests (always 1)
 
 The default `prefix` is "telltale" and can be configured with the environment variable `TELLTALE_PREFIX`.
 

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/telltale.rb

@@ -1,4 +1,5 @@
 require 'opentsdb'
+require 'telltale/data'
 
 module Telltale
   class << self
@@ -14,13 +15,7 @@ module Telltale
     def configure_request_instrumentation
       ActiveSupport::Notifications.subscribe 'process_action.action_controller' do |_name, started, finished, _unique_id, payload|
         next unless report?
-        data = {
-          metric: "#{metric_prefix}.rails.total_time",
-          value: ((finished - started) * 1000).ceil,
-          timestamp: Time.now.to_i,
-          tags: tags(payload),
-        }
-        client.put(data)
+        client.put Telltale::Data.compile(started, finished, payload)
       end
     end
 
@@ -28,17 +23,6 @@ module Telltale
       opentsdb_host.present? && !Rails.env.test?
     end
 
-    def tags(payload)
-      {
-        http_status: http_status_from_payload(payload),
-        controller: payload[:controller],
-        action: [payload[:controller], payload[:action]].join('.'),
-        host: Socket.gethostname,
-        environment: Rails.env,
-        app: Rails.application.class.parent_name.downcase,
-      }
-    end
-
     def opentsdb_port
       ENV['TELLTALE_OPENTSDB_PORT'] || 4242
     end
@@ -47,18 +31,9 @@ module Telltale
       ENV['TELLTALE_OPENTSDB_HOST']
     end
 
-    def metric_prefix
-      ENV['TELLTALE_PREFIX'] || 'telltale'
-    end
-
     def client
       OpenTSDB::Client.new(hostname: opentsdb_host, port: opentsdb_port)
     end
-
-    def http_status_from_payload(payload)
-      return payload[:status] if payload[:status]
-      return 500 if payload[:exception].present?
-    end
   end
 end
 

data/lib/telltale/data.rb

@@ -0,0 +1,59 @@
+module Telltale
+  class Data
+    attr_reader :started, :finished, :payload
+
+    def self.compile(started, finished, payload)
+      new(started, finished, payload).all
+    end
+
+    def initialize(started, finished, payload)
+      @started = started
+      @finished = finished
+      @payload = payload
+    end
+
+    def all
+      [total_time, request_count]
+    end
+
+    def total_time
+      {
+        metric: "#{metric_prefix}.rails.total_time",
+        value: ((finished - started) * 1000).ceil,
+        timestamp: Time.now.to_i,
+        tags: tags,
+      }
+    end
+
+    def request_count
+      {
+        metric: "#{metric_prefix}.rails.request_count",
+        value: 1,
+        timestamp: Time.now.to_i,
+        tags: tags,
+      }
+    end
+
+    private
+
+    def metric_prefix
+      ENV['TELLTALE_PREFIX'] || 'telltale'
+    end
+
+    def tags
+      {
+        http_status: http_status,
+        controller: payload[:controller],
+        action: [payload[:controller], payload[:action]].join('.'),
+        host: Socket.gethostname,
+        environment: Rails.env,
+        app: Rails.application.class.parent_name.downcase,
+      }
+    end
+
+    def http_status
+      return payload[:status] if payload[:status]
+      return 500 if payload[:exception].present?
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  config.example_status_persistence_file_path = 'spec/examples.txt'
+  config.disable_monkey_patching!
+  config.warnings = true
+  config.order = :random
+
+  Kernel.srand config.seed
+end

data/spec/telltate/data_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+require 'telltale/data'
+
+RSpec.describe Telltale::Data do
+  Rails = Class.new do
+    def self.application; end
+    def self.env; end
+  end
+
+  let(:started) { Time.at 1 }
+  let(:finished) { Time.at 10 }
+  let(:payload) { { controller: 'contacts', action: 'show', status: 200 } }
+  let(:data) { Telltale::Data.new started, finished, payload }
+
+  before do
+    allow(Rails).to receive_message_chain(:application, :class, :parent_name).and_return('MyApp')
+    allow(Rails).to receive(:env).and_return('staging')
+  end
+
+  describe '.compile' do
+    it 'compiles the data for the total request time metric' do
+      expect(described_class.compile(started, finished, payload)).to match_array [Hash, Hash]
+    end
+  end
+
+  describe '#all' do
+    it 'compiles the data all metrics' do
+      expect(data.all).to match_array [Hash, Hash]
+    end
+  end
+
+  describe '#total_time' do
+    it 'compiles the data for the total request time metric' do
+      expect(data.total_time).to eq(
+        metric: 'telltale.rails.total_time',
+        value: 9000,
+        timestamp: Time.now.to_i,
+        tags: {
+          http_status: 200,
+          controller: 'contacts',
+          action: 'contacts.show',
+          host: 'odin',
+          environment: 'staging',
+          app: 'myapp',
+        },
+      )
+    end
+  end
+
+  describe '#request_count' do
+    it 'compiles the data for the request count metric' do
+      expect(data.request_count).to eq(
+        metric: 'telltale.rails.request_count',
+        value: 1,
+        timestamp: Time.now.to_i,
+        tags: {
+          http_status: 200,
+          controller: 'contacts',
+          action: 'contacts.show',
+          host: 'odin',
+          environment: 'staging',
+          app: 'myapp',
+        },
+      )
+    end
+  end
+end

data/telltale.gemspec

@@ -18,4 +18,5 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.add_runtime_dependency 'opentsdb', '~> 0.2.0'
+  s.add_development_dependency 'rspec'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telltale
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Philippe Hassig
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-19 00:00:00.000000000 Z
+date: 2016-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentsdb
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Report Rails application metrics to OpenTSDB
 email:
 - phil@nine.ch
@@ -31,11 +45,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
 - CHANGELOG.md
+- Gemfile
+- Gemfile.lock
 - README.md
 - VERSION
 - lib/telltale.rb
+- lib/telltale/data.rb
 - lib/telltale/railtie.rb
+- spec/spec_helper.rb
+- spec/telltate/data_spec.rb
 - telltale.gemspec
 homepage: http://github.com/ninech/
 licenses:
@@ -57,8 +78,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Report Rails application metrics to OpenTSDB
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/telltate/data_spec.rb