vault-tools 0.3.10 → 0.3.11

data/lib/vault-tools/config.rb

@@ -28,7 +28,11 @@ module Vault
     end
 
     def app_name
-      env("APP_NAME")
+      env!("APP_NAME")
+    end
+
+    def app_deploy
+      env!("APP_DEPLOY")
     end
 
     def port

data/lib/vault-tools/log.rb

@@ -3,9 +3,10 @@ module Vault
     # Log a count metric.
     #
     # @param name [String] The name of the metric.
-    def self.count(name)
-      name = "#{Config.app_name}.#{name}" if Config.app_name
-      log("count##{name}" => 1)
+    # @param value [Integer] The number of items counted. Can be suffixed with a unit.
+    # @param extra_data [Hash] Optional extra data to log.
+    def self.count(name, value = 1, extra_data = {})
+      log(extra_data.merge("count##{Config.app_name}.#{name}" => value))
     end
 
     # Log an HTTP status code.  Two log metrics are written each time this
@@ -20,24 +21,32 @@ module Vault
     #
     # @param status [Fixnum] The HTTP status code to record.
     def self.count_status(status)
-      count("http_#{status}")
+      count("http.#{status}")
       if status_prefix = status.to_s.match(/\d/)[0]
-        count("http_#{status_prefix}xx")
+        count("http.#{status_prefix}xx")
       end
     end
 
+    # Log a measurement.
+    #
+    # @param name [String] The name of the metric.
+    # @param value [Float] Value for the metric. A unit may be appended.
+    # @param extra_data [Hash] Optional extra data to log.
+    def self.measure(name, value, extra_data = {})
+      log(extra_data.merge("measure##{Config.app_name}.#{name}" => value))
+    end
+
     # Log a timing metric.
     #
     # @param name [String] A Sinatra-formatted route URL.
-    # @param duration [Fixnum] The duration to record, in seconds or
-    #   milliseconds.
+    # @param duration [Fixnum] The duration to record, in milliseconds.
     def self.time(name, duration)
       if name
         name.gsub(/\/:\w+/, '').           # Remove param names from path.
-             gsub("/", "_").               # Replace slash with underscore.
+             gsub("/", "-").               # Replace slash with dash.
              gsub(/[^A-Za-z0-9\-\_]/, ''). # Only keep subset of chars.
-             slice(1..-1).                 # Strip the leading underscore.
-             tap { |name| log("measure##{name}" => "#{duration}ms") }
+             sub(/^-/, "").                # Strip the leading dash.
+             tap { |name| measure(name, "#{duration}ms") }
       end
     end
 
@@ -48,6 +57,7 @@ module Vault
     # @param block [Proc] Optionally, a block of code to run before writing
     #   the log message.
     def self.log(data, &block)
+      data['source'] ||= Config.app_deploy if Config.app_deploy
       Scrolls.log(data, &block)
     end
   end

data/lib/vault-tools/version.rb

@@ -1,5 +1,5 @@
 module Vault
   module Tools
-    VERSION = '0.3.10'
+    VERSION = '0.3.11'
   end
 end

data/lib/vault-tools/web.rb

@@ -37,7 +37,7 @@ module Vault
     # Log details about the request including how long it took.
     after do
       Log.count_status(response.status)
-      Log.time(@action, Time.now - @start_request)
+      Log.time("http.#{@action}", (Time.now - @start_request) * 1000)
     end
 
     # Make sure error handler blocks are invoked in tests.

data/test/config_test.rb

@@ -39,11 +39,15 @@ class ConfigTest < Vault::TestCase
   # Vault::Config.app_name returns the value of the APP_NAME environment
   # variable.
   def test_app_name
-    Vault::Config.app_name.must_equal nil
     set_env 'APP_NAME', "my-app"
     Vault::Config.app_name.must_equal 'my-app'
   end
 
+  def test_app_deploy
+    set_env 'APP_DEPLOY', "test"
+    Vault::Config.app_deploy.must_equal 'test'
+  end
+
   def test_port_raises
     assert_raises RuntimeError do
       Vault::Config.port

data/test/helper.rb

@@ -5,4 +5,8 @@ Vault.setup
 
 class Vault::TestCase
   include Vault::Test::EnvironmentHelpers
+
+  def logged_data
+    Hash[Scrolls.stream.string.split(/\s+/).map {|p| p.split('=') }]
+  end
 end

data/test/log_test.rb

@@ -1,59 +1,79 @@
 require 'helper'
 
 class LogTest < Vault::TestCase
+  def setup
+    super
+    set_env('APP_NAME', 'test-app')
+    set_env('APP_DEPLOY', 'test-deploy')
+  end
+
   # Vault::Log.count emits a metric, using the specified name, that represents
   # a countable event.
   def test_count
-    set_env('APP_NAME', nil)
     Vault::Log.count('countable')
-    assert_match(/count#countable=1/, Scrolls.stream.string)
+    assert_equal '1', logged_data['count#test-app.countable']
+    assert_equal 'test-deploy', logged_data['source']
   end
 
-  # Vault::Log.count emits a metric that represents a countable event.  If an
-  # APP_NAME environment variable is available it will be prepended to the
-  # measurement name.
-  def test_count_with_app_name
-    set_env('APP_NAME', 'vault_app')
-    Vault::Log.count('countable')
-    assert_match(/count#vault_app.countable=1/, Scrolls.stream.string)
+  def test_count_with_specified_value
+    Vault::Log.count('countable', 5)
+    assert_equal '5', logged_data['count#test-app.countable']
+    assert_equal 'test-deploy', logged_data['source']
   end
 
-  # Vault::Log.count_status emits metrics to measure HTTP responses.  The
-  # exact HTTP status, and the status family, are recorded.
+  def test_count_with_extra_data
+    Vault::Log.count('countable', 1, 'request_id' => 'abc')
+    assert_equal '1', logged_data['count#test-app.countable']
+    assert_equal 'abc', logged_data['request_id']
+  end
+
+  # Vault::Log.count_status emits metrics to measure HTTP responses.
   def test_count_status
-    set_env('APP_NAME', nil)
     Vault::Log.count_status(201)
-    assert_match(/count#http_201=1/, Scrolls.stream.string)
-    assert_match(/count#http_2xx=1/, Scrolls.stream.string)
+    assert_equal '1', logged_data['count#test-app.http.201']
+    assert_equal '1', logged_data['count#test-app.http.2xx']
+    assert_equal 'test-deploy', logged_data['source']
   end
 
-  # Vault::Log.count_status emits metrics to measure HTTP responses.  If an
-  # APP_NAME environment variable is available it will be prepended to the
-  # measurement name.
-  def test_count_status_with_app_name
-    set_env('APP_NAME', 'vault_app')
-    Vault::Log.count_status(201)
-    assert_match(/count#vault_app.http_201=1/, Scrolls.stream.string)
-    assert_match(/count#vault_app.http_2xx=1/, Scrolls.stream.string)
+  def test_measure
+    Vault::Log.measure('thinking', 123.4)
+    assert_equal '123.400', logged_data['measure#test-app.thinking']
+    assert_equal 'test-deploy', logged_data['source']
+  end
+
+  def test_measure_with_units
+    Vault::Log.measure('thinking', '123.4ms')
+    assert_equal '123.4ms', logged_data['measure#test-app.thinking']
+  end
+
+  def test_measure_with_extra_data
+    Vault::Log.measure('thinking', '123.4', 'request_id' => 'abc')
+    assert_equal '123.4', logged_data['measure#test-app.thinking']
+    assert_equal 'abc', logged_data['request_id']
+  end
+
+  def test_time
+    Vault::Log.time('thinking', 123.4)
+    assert_equal '123.4ms', logged_data['measure#test-app.thinking']
   end
 
   # Vault::Log.time emits a metric to measure the duration of an HTTP request.
   # It converts slashes to underscores.
-  def test_time_replaces_slash_with_underscore
+  def test_time_replaces_slash_with_dash
     Vault::Log.time('/some/web/path', 123.4)
-    assert_match(/measure#some_web_path=123.4ms/, Scrolls.stream.string)
+    assert_equal '123.4ms', logged_data['measure#test-app.some-web-path']
   end
 
   # Vault::Log.time removes parameters.
   def test_time_removes_parameters
     Vault::Log.time('/some/:web/path', 123.4)
-    assert_match(/measure#some_path=123.4ms/, Scrolls.stream.string)
+    assert_equal '123.4ms', logged_data['measure#test-app.some-path']
   end
 
   # Vault::Log.time removes non-alphanumeric characters.
   def test_time_removes_non_alphanumeric_characters
     Vault::Log.time('/some/web+path', 123.4)
-    assert_match(/measure#some_webpath=123.4ms/, Scrolls.stream.string)
+    assert_equal '123.4ms', logged_data['measure#test-app.some-webpath']
   end
 
   # Vault::Log.time is a no-op if a nil name is provided.
@@ -66,8 +86,12 @@ class LogTest < Vault::TestCase
   # specified hash.
   def test_log
     Vault::Log.log(integer: 123, float: 123.4, string: 'string', bool: false)
-    assert_match(/integer=123 float=123.400 string=string bool=false/,
-                 Scrolls.stream.string)
+    assert_equal 'test-deploy', logged_data['source']
+    assert_equal '123',     logged_data['integer']
+    assert_equal '123.400', logged_data['float']
+    assert_equal 'string',  logged_data['string']
+    assert_equal 'false',   logged_data['bool']
+    assert_equal '123.400', logged_data['float']
   end
 
   # Vault::Log.log can be used to measure the time spent in a block.
@@ -75,7 +99,9 @@ class LogTest < Vault::TestCase
     Vault::Log.log(A: true) do
       Vault::Log.log(B: true)
     end
-    assert_match(/A=true at=start\nB=true\nA=true at=finish elapsed=0/,
-                 Scrolls.stream.string)
+    assert_equal 'true', logged_data['A']
+    assert_equal 'true', logged_data['B']
+    assert_equal 'test-deploy', logged_data['source']
+    assert_match /\d/, logged_data['elapsed']
   end
 end

data/test/web_test.rb

@@ -11,6 +11,8 @@ class WebTest < Vault::TestCase
   # Always reload the web class to eliminate test leakage
   def setup
     super
+    set_env('APP_NAME', 'test-app')
+    set_env('APP_DEPLOY', 'testing')
     reload_web!
   end
 
@@ -42,8 +44,8 @@ class WebTest < Vault::TestCase
   # requests.
   def test_head_status_check
     head '/'
-    assert_match(/count#http_200=1/, Scrolls.stream.string)
-    assert_match(/count#http_2xx=1/, Scrolls.stream.string)
+    assert_equal '1', logged_data['count#test-app.http.200']
+    assert_equal '1', logged_data['count#test-app.http.2xx']
     assert_equal(200, last_response.status)
   end
 
@@ -51,8 +53,8 @@ class WebTest < Vault::TestCase
   # response body.
   def test_get_health_check
     get '/health'
-    assert_match(/count#http_200=1/, Scrolls.stream.string)
-    assert_match(/count#http_2xx=1/, Scrolls.stream.string)
+    assert_equal '1', logged_data['count#test-app.http.200']
+    assert_equal '1', logged_data['count#test-app.http.2xx']
     assert_equal(200, last_response.status)
     assert_equal('OK', last_response.body)
   end
@@ -61,8 +63,8 @@ class WebTest < Vault::TestCase
   # match a known resource.
   def test_head_with_unknown_endpoint
     head '/unknown'
-    assert_match(/count#http_404=1/, Scrolls.stream.string)
-    assert_match(/count#http_4xx=1/, Scrolls.stream.string)
+    assert_equal '1', logged_data['count#test-app.http.404']
+    assert_equal '1', logged_data['count#test-app.http.4xx']
     assert_equal(404, last_response.status)
   end
 
@@ -70,8 +72,8 @@ class WebTest < Vault::TestCase
   # traceback is also written to the response body to ease debugging.
   def test_error_logs_500
     get '/boom'
-    assert_match(/count#http_500=1/, Scrolls.stream.string)
-    assert_match(/count#http_5xx=1/, Scrolls.stream.string)
+    assert_equal '1', logged_data['count#test-app.http.500']
+    assert_equal '1', logged_data['count#test-app.http.5xx']
     assert_match(/^RuntimeError: An expected error occurred.$/m,
                  last_response.body)
     assert_equal(500, last_response.status)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vault-tools
 version: !ruby/object:Gem::Version
-  version: 0.3.10
+  version: 0.3.11
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-15 00:00:00.000000000 Z
+date: 2013-10-24 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: scrolls
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2156169280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,15 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *2156169280
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2156168860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -38,15 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *2156168860
 - !ruby/object:Gem::Dependency
   name: uuidtools
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2156168440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,15 +44,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *2156168440
 - !ruby/object:Gem::Dependency
   name: rack-ssl-enforcer
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2156168020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -70,15 +55,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *2156168020
 - !ruby/object:Gem::Dependency
   name: heroku-api
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2156167600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -86,28 +66,18 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *2156167600
 - !ruby/object:Gem::Dependency
   name: fernet
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2156167100 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - =
       - !ruby/object:Gem::Version
         version: 2.0.rc2
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.0.rc2
+  version_requirements: *2156167100
 description: Basic tools for Heroku Vault's Ruby projects
 email:
 - christopher.continanza@gmail.com
@@ -164,21 +134,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3536867358711533404
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3536867358711533404
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.9
 signing_key: 
 specification_version: 3
 summary: Test classes, base web classes, and helpers - oh my!