telltale 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b7021ce6b44df68ba8aac0c3072106ac3a73ffd
+  data.tar.gz: c95c0a9856f51a4e5c017662a85917f45bac8432
+SHA512:
+  metadata.gz: d67a8ddc2d486db0321163d20d8b24eb916a22ce5f0621be0ede7bf28c4428b26ca84212775fda4bad94587f2159c34816d5aac209d402bc6a6e5fab164f12a6
+  data.tar.gz: e9b646fda19c3a43404062c080f37bf06c983b75a7955a125c34feae903a3f198d73217776ba85ecc3dbc64548b257dd94944254b806342c5743ead4c613a465

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Telltale Changelog
+
+## master
+
+## v0.1
+
+* Initial implementation

data/README.md

@@ -0,0 +1,30 @@
+# Telltale
+
+Report Rails application metrics to OpenTSDB.
+
+## Metrics
+
+These numbers are currently reported:
+
+* `<prefix>.rails.total_time`: Total request time in seconds
+
+The default `prefix` is "telltale" and can be configured with the environment variable `TELLTALE_PREFIX`.
+
+## Tags
+
+The following tags are available for all metrics:
+
+* `http_status`: HTTP Status code
+* `controller`: Name of the controller
+* `action`: Name of the action in the form `controller_name.action_name`
+* `host`: Name of the host the Rails app is running on
+* `environment`: The Rails app environment
+* `app`: The application's name
+
+## Configuration
+
+Telltale uses the following environment variables for configuration:
+
+* `TELLTALE_OPENTSDB_HOST`: The host to report to
+* `TELLTALE_OPENTSDB_PORT`: The port opentsdb listens on. Default is 4242
+* `TELLTALE_PREFIX`: Some prefix for the metric name. Default is `telltale`

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/telltale.rb

@@ -0,0 +1,65 @@
+require 'opentsdb'
+
+module Telltale
+  class << self
+    def setup!
+      if report?
+        configure_request_instrumentation
+        Rails.logger.info "Telltale started, will report to #{opentsdb_host} on port #{opentsdb_port}"
+      else
+        Rails.logger.error 'TELLTALE_OPENTSDB_HOST not set. Telltale will not report to OpenTSDB.'
+      end
+    end
+
+    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)
+      end
+    end
+
+    def report?
+      opentsdb_host.present?
+    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
+
+    def opentsdb_host
+      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
+
+require 'telltale/railtie'

data/lib/telltale/railtie.rb

@@ -0,0 +1,7 @@
+module Telltale
+  class Railtie < Rails::Railtie
+    initializer 'telltale.initialize' do
+      Telltale.setup!
+    end
+  end
+end

data/telltale.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+#
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'telltale'
+  s.version     = File.read(File.expand_path('../VERSION', __FILE__)).strip
+  s.authors     = ['Philippe Hassig']
+  s.email       = ['phil@nine.ch']
+  s.homepage    = 'http://github.com/ninech/'
+  s.license     = 'MIT'
+  s.summary     = 'Report Rails application metrics to OpenTSDB'
+  s.description = 'Report Rails application metrics to OpenTSDB'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'opentsdb', '~> 0.2.0'
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: telltale
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Philippe Hassig
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opentsdb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: Report Rails application metrics to OpenTSDB
+email:
+- phil@nine.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- VERSION
+- lib/telltale.rb
+- lib/telltale/railtie.rb
+- telltale.gemspec
+homepage: http://github.com/ninech/
+licenses:
+- MIT
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Report Rails application metrics to OpenTSDB
+test_files: []