pliny 0.19.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d42dcfb555d6af54e5e87035c53d5fbb9de11cfe
-  data.tar.gz: 9b498dbf53638dbc04770f93df95614fffa59591
+  metadata.gz: 686ea485950159a4111ea7d2a0cf08d1a9945a57
+  data.tar.gz: 600951ff54aabd3e2cc39094b305daed9b1fb284
 SHA512:
-  metadata.gz: 9d85fa248efc6f4e4de6d93107a312c9a67200033f633133985246e43603a1e749eefc1175185ea4d4ea1df8ec516d14ce554ea952513192e61190b29615d1fb
-  data.tar.gz: 0f96306f19f94bff354d95b0e4adf8f512aff8577a29fadb786fee3fc31e9462fe6c4f46b0285d27c952e9df78f7a7256d0a24eb83bfdb1422e98ab85ea26982
+  metadata.gz: 8f8964c9b05a857ae80961fba8551eaa8634f864faad1dc7f3305e73fbc4aeb63663e1ded6fbe7ac585042542a50d92cb7ec62b836037586d0413b17de7d512e
+  data.tar.gz: 5cf995f52ea9273783ec42cc4f19cb57fa7e762a6ec24cab57ca98b5653f0fcdc404f83529bebde057e95d1040ff39a58ffe3aa07f22e45953fe8831b491201c

data/lib/pliny.rb

@@ -8,6 +8,7 @@ require_relative "pliny/helpers/encode"
 require_relative "pliny/helpers/params"
 require_relative "pliny/helpers/serialize"
 require_relative "pliny/log"
+require_relative "pliny/metrics/backends/logger"
 require_relative "pliny/metrics"
 require_relative "pliny/request_store"
 require_relative "pliny/rollbar_logger"

data/lib/pliny/config_helpers.rb

@@ -50,13 +50,23 @@ module Pliny
     end
 
     def rack_env
-      if pliny_env == "development" || pliny_env == "test"
+      if env == "development" || env == "test"
         "development"
       else
         "deployment"
       end
     end
 
+    # DEPRECATED: pliny_env is deprecated in favour of app_env.
+    #             See more at https://github.com/interagent/pliny/issues/277
+    #
+    # This method is kept temporary in case it is used somewhere in the app.
+    def pliny_env
+      warn "Config.pliny_env is deprecated and will be removed, " \
+           "use Config.app_env instead."
+      env
+    end
+
     private
 
     def cast(value, method)
@@ -70,6 +80,20 @@ module Pliny
         instance_eval "def #{name}?; !!@#{name} end", __FILE__, __LINE__
       end
     end
+
+    # This method helps with transition from PLINY_ENV to APP_ENV.
+    def env
+      legacy_env || app_env
+    end
+
+    # PLINY_ENV is deprecated, but it might be still used by someone.
+    def legacy_env
+      if ENV.key?('PLINY_ENV')
+        warn "PLINY_ENV is deprecated in favour of APP_ENV, " \
+             "update .env file or application configuration."
+        ENV['PLINY_ENV']
+      end
+    end
   end
 
   module ConfigHelpers

data/lib/pliny/metrics.rb

@@ -1,29 +1,44 @@
 module Pliny
   module Metrics
-    def self.count(*names, value: 1)
-      counts = Hash[names.map { |n| [metric_prefix(:count, n), value] }]
-      Pliny.log(counts)
+    extend self
+
+    attr_accessor :backends
+
+    @backends = [Backends::Logger]
+
+    def count(*names, value: 1)
+      counts = Hash[names.map { |n| ["#{Config.app_name}.#{n}", value] }]
+
+      backends.each do |backend|
+        report_and_catch { backend.report_counts(counts) }
+      end
+
+      counts
     end
 
-    def self.measure(*names, &block)
+    def measure(*names, &block)
       elapsed, return_value = time_elapsed(&block)
-      measures = Hash[names.map { |n| [metric_prefix(:measure, n), elapsed] }]
-      Pliny.log(measures)
+      measures = Hash[names.map { |n| ["#{Config.app_name}.#{n}", elapsed] }]
+
+      backends.each do |backend|
+        report_and_catch { backend.report_measures(measures) }
+      end
 
       return_value
     end
 
     private
 
-    def self.metric_prefix(type, name)
-      "#{type.to_s}##{Config.app_name}.#{name}"
-    end
-
-    def self.time_elapsed(&block)
+    def time_elapsed(&block)
       start = Time.now
       return_value = block.call
       [Time.now - start, return_value]
     end
+
+    def report_and_catch
+      yield
+    rescue => error
+      Pliny.log_exception(error)
+    end
   end
 end
-

data/lib/pliny/metrics/backends/logger.rb

@@ -0,0 +1,21 @@
+module Pliny
+  module Metrics
+    module Backends
+      class Logger
+        def self.report_counts(counts)
+          Pliny.log(add_prefix(:count, counts))
+        end
+
+        def self.report_measures(measures)
+          Pliny.log(add_prefix(:measure, measures))
+        end
+
+        private
+
+        def self.add_prefix(type, metrics)
+          metrics.map { |k, v| [ "#{type}##{k}", v ] }.to_h
+        end
+      end
+    end
+  end
+end

data/lib/pliny/version.rb

@@ -1,3 +1,3 @@
 module Pliny
-  VERSION = "0.19.0"
+  VERSION = "0.20.0"
 end

data/lib/template/.env.sample.erb

@@ -1,7 +1,7 @@
 APP_NAME=<%= app_name %>
 DATABASE_URL=postgres:///<%= app_name %>-development
 DEPLOYMENT=development
-PLINY_ENV=development
+APP_ENV=development
 TZ=UTC
 RAISE_ERRORS=true
 FORCE_SSL=false

data/lib/template/.env.test.erb

@@ -1,7 +1,7 @@
 APP_NAME=<%= app_name %>
 DATABASE_URL=postgres:///<%= app_name %>-test
 DEPLOYMENT=test
-PLINY_ENV=test
+APP_ENV=test
 TZ=UTC
 RAISE_ERRORS=true
 FORCE_SSL=false

data/lib/template/Gemfile

@@ -4,7 +4,7 @@ ruby "2.3.1"
 gem "multi_json"
 gem "oj"
 gem "pg"
-gem "pliny", "~> 0.19"
+gem "pliny", "~> 0.20"
 gem "pry"
 gem "puma", "~> 2.16"
 gem "rack-ssl"

data/lib/template/app.json.erb

@@ -5,7 +5,7 @@
   "env": {
     "APP_NAME": "<%= app_name %>",
     "DEPLOYMENT": "production",
-    "PLINY_ENV": "production"
+    "APP_ENV": "production"
   },
 
   "scripts": {

data/lib/template/config/config.rb

@@ -22,7 +22,7 @@ module Config
   override :db_pool,          5,            int
   override :deployment,       'production', string
   override :force_ssl,        true,         bool
-  override :pliny_env,        'production', string
+  override :app_env,          'production', string
   override :port,             5000,         int
   override :pretty_json,      false,        bool
   override :puma_max_threads, 16,           int

data/lib/template/config/initializers/metrics.rb

@@ -0,0 +1 @@
+Pliny::Metrics.backends = [Pliny::Metrics::Backends::Logger]

data/spec/config_helpers_spec.rb

@@ -4,49 +4,128 @@ require "pliny/config_helpers"
 describe Pliny::CastingConfigHelpers do
 
   describe "#rack_env" do
-    it "is development if pliny_env is development" do
+    it "is development if app_env is development" do
       config = Class.new do
         extend Pliny::CastingConfigHelpers
-        override :pliny_env, 'development', string
+        override :app_env, 'development', string
       end
 
       assert_equal "development", config.rack_env
     end
 
-    it "is development if pliny_env is test" do
+    it "is development if app_env is test" do
       config = Class.new do
         extend Pliny::CastingConfigHelpers
-        override :pliny_env, 'test', string
+        override :app_env, 'test', string
       end
 
       assert_equal "development", config.rack_env
     end
 
-    it "is deployment if pliny_env is production" do
+    it "is deployment if app_env is production" do
       config = Class.new do
         extend Pliny::CastingConfigHelpers
-        override :pliny_env, 'production', string
+        override :app_env, 'production', string
       end
 
       assert_equal "deployment", config.rack_env
     end
 
-    it "is deployment if pliny_env is nil" do
+    it "is deployment if app_env is nil" do
       config = Class.new do
         extend Pliny::CastingConfigHelpers
-        override :pliny_env, '', string
+        override :app_env, '', string
       end
 
       assert_equal "deployment", config.rack_env
     end
 
-    it "is deployment if pliny_env is another value" do
+    it "is deployment if app_env is another value" do
       config = Class.new do
         extend Pliny::CastingConfigHelpers
-        override :pliny_env, 'staging', string
+        override :app_env, 'staging', string
       end
 
       assert_equal "deployment", config.rack_env
     end
+
+    context "when legacy PLINY_ENV is still defined" do
+      before do
+        ENV['ORIGINAL_PLINY_ENV'] = ENV['PLINY_ENV']
+        ENV['PLINY_ENV'] = 'staging'
+      end
+
+      after do
+        ENV['PLINY_ENV'] = ENV.delete('ORIGINAL_PLINY_ENV')
+      end
+
+      it "uses PLINY_ENV value instead of APP_ENV" do
+        config = Class.new do
+          extend Pliny::CastingConfigHelpers
+          override :app_env, 'development', string
+        end
+
+        assert_equal "deployment", config.rack_env
+      end
+
+      it "displays deprecation warning" do
+        config = Class.new do
+          extend Pliny::CastingConfigHelpers
+          override :app_env, 'development', string
+        end
+
+        io = StringIO.new
+        $stderr = io
+        config.rack_env
+        $stderr = STDERR
+
+        assert_includes io.string, "PLINY_ENV is deprecated"
+      end
+    end
+  end
+
+  describe "#pliny_env" do
+    it "displays deprecation warning if pliny_env is used" do
+      config = Class.new do
+        extend Pliny::CastingConfigHelpers
+        override :app_env, 'development', string
+      end
+
+      io = StringIO.new
+      $stderr = io
+      config.pliny_env
+      $stderr = STDERR
+
+      assert_includes io.string, "Config.pliny_env is deprecated"
+    end
+
+    it "returns app_env value" do
+      config = Class.new do
+        extend Pliny::CastingConfigHelpers
+        override :app_env, 'foo', string
+      end
+
+      assert_equal "foo", config.pliny_env
+    end
+
+    context "when legacy PLINY_ENV is still defined" do
+      before do
+        ENV['ORIGINAL_PLINY_ENV'] = ENV['PLINY_ENV']
+        ENV['PLINY_ENV'] = 'staging'
+      end
+
+      after do
+        ENV['PLINY_ENV'] = ENV.delete('ORIGINAL_PLINY_ENV')
+      end
+
+      it "returns PLINY_ENV value" do
+        config = Class.new do
+          extend Pliny::CastingConfigHelpers
+          override :app_env, 'development', string
+        end
+
+        assert_equal "staging", config.pliny_env
+      end
+    end
   end
 end

data/spec/helpers/serialize_spec.rb

@@ -12,7 +12,7 @@ describe Pliny::Helpers::Serialize do
       end
     end
 
-    it "sets the Content-Type" do
+    it "raises a runtime error" do
       assert_raises(RuntimeError) do
         get "/"
       end

data/spec/metrics/backends/logger_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+
+describe Pliny::Metrics::Backends::Logger do
+  let(:io) { double }
+
+  subject(:backend) { Pliny::Metrics::Backends::Logger }
+
+  before do
+    @stdout = Pliny.stdout
+    Pliny.stdout = io
+
+    allow(io).to receive(:print)
+  end
+
+  after do
+    Pliny.stdout = @stdout
+  end
+
+  context "#count" do
+    it "logs a single key with a value" do
+      backend.report_counts('app.foo' => 1)
+      expect(io).to have_received(:print).with("count#app.foo=1\n")
+    end
+
+    it "logs multiple keys with values" do
+      backend.report_counts('app.foo' => 1, 'app.bar' => 2)
+      expect(io).to have_received(:print).with(
+        "count#app.foo=1 count#app.bar=2\n")
+    end
+  end
+
+  context "#measure" do
+    it "logs a single key with a value" do
+      backend.report_measures('pliny.foo' => 0.001)
+      expect(io).to have_received(:print).with("measure#pliny.foo=0.001\n")
+    end
+
+    it "logs multiple keys with values" do
+      backend.report_measures('pliny.foo' => 0.3, 'pliny.bar' => 0.5)
+      expect(io).to have_received(:print).with(
+        "measure#pliny.foo=0.300 measure#pliny.bar=0.500\n")
+    end
+  end
+end

data/spec/metrics_spec.rb

@@ -1,61 +1,80 @@
 require "spec_helper"
 
 describe Pliny::Metrics do
-  let(:io) { double }
-
   subject(:metrics) { Pliny::Metrics }
 
-  before do
-    @stdout = Pliny.stdout
-    Pliny.stdout = io
+  let(:test_backend) do
+    double(:test_backend, report_counts: nil, report_measures: nil)
+  end
 
-    allow(io).to receive(:print)
+  before do
     allow(Config).to receive(:app_name).and_return('pliny')
   end
 
-  after do
-    Pliny.stdout = @stdout
+  around do |example|
+    original_backends = Pliny::Metrics.backends
+    begin
+      example.run
+    ensure
+      Pliny::Metrics.backends = original_backends
+    end
+  end
+
+  it "uses the logger as the default backend" do
+    assert_equal(metrics.backends, [Pliny::Metrics::Backends::Logger])
   end
 
-  context "#count" do
-    it "counts a single key with a default value" do
+  describe "#count" do
+    before { Pliny::Metrics.backends = [test_backend] }
+
+    it "sends a hash to the backend with a default value" do
       metrics.count(:foo)
-      expect(io).to have_received(:print).with("count#pliny.foo=1\n")
+      expect(test_backend).to have_received(:report_counts).once.with("pliny.foo" => 1)
     end
 
-    it "counts a single key with a provided value" do
+    it "sends a hash to the backend with a provided value" do
       metrics.count(:foo, value: 2)
-      expect(io).to have_received(:print).with("count#pliny.foo=2\n")
+      expect(test_backend).to have_received(:report_counts).once.with("pliny.foo" => 2)
     end
 
-    it "counts multiple keys" do
+    it "sends a hash with multiple key counts to the backend" do
       metrics.count(:foo, :bar)
-      expect(io).to have_received(:print).with(
-        "count#pliny.foo=1 count#pliny.bar=1\n")
+      expect(test_backend).to have_received(:report_counts).once.with(
+        "pliny.foo" => 1,
+        "pliny.bar" => 1
+      )
     end
   end
 
-  context "#measure" do
+  describe "#measure" do
     before do
       Timecop.freeze(Time.now)
+      Pliny::Metrics.backends = [test_backend]
     end
 
     it "measures a single key" do
       metrics.measure(:foo) { }
-      expect(io).to have_received(:print).with("measure#pliny.foo=0.000\n")
+      expect(test_backend).to have_received(:report_measures).once.with(
+        "pliny.foo" => 0
+      )
     end
 
     it "measures a single key over a minute" do
       metrics.measure(:foo) do
         Timecop.travel(60)
       end
-      expect(io).to have_received(:print).with("measure#pliny.foo=60.000\n")
+
+      expect(test_backend).to have_received(:report_measures) do |opts|
+        assert(60 <= opts['pliny.foo'] && opts['pliny.foo'] <= 61)
+      end
     end
 
     it "measures multiple keys" do
       metrics.measure(:foo, :bar) { }
-      expect(io).to have_received(:print).with(
-        "measure#pliny.foo=0.000 measure#pliny.bar=0.000\n")
+      expect(test_backend).to have_received(:report_measures).once.with(
+        "pliny.foo" => 0,
+        "pliny.bar" => 0
+      )
     end
   end
 end

data/spec/middleware/cors_spec.rb

@@ -17,7 +17,7 @@ describe Pliny::Middleware::CORS do
     get "/"
     assert_equal 200, last_response.status
     assert_equal "hi", last_response.body
-    assert_equal nil, last_response.headers["Access-Control-Allow-Origin"]
+    assert_nil last_response.headers["Access-Control-Allow-Origin"]
   end
 
   it "intercepts OPTION requests to render a stub (preflight request)" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pliny
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Brandur Leach
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-12 00:00:00.000000000 Z
+date: 2016-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -362,6 +362,7 @@ files:
 - lib/pliny/helpers/serialize.rb
 - lib/pliny/log.rb
 - lib/pliny/metrics.rb
+- lib/pliny/metrics/backends/logger.rb
 - lib/pliny/middleware/cors.rb
 - lib/pliny/middleware/instruments.rb
 - lib/pliny/middleware/request_id.rb
@@ -408,6 +409,7 @@ files:
 - lib/template/config/config.rb
 - lib/template/config/initializers/database.rb
 - lib/template/config/initializers/log.rb
+- lib/template/config/initializers/metrics.rb
 - lib/template/config/initializers/rollbar.rb
 - lib/template/config/puma.rb
 - lib/template/db/schema.sql
@@ -448,6 +450,7 @@ files:
 - spec/helpers/serialize_spec.rb
 - spec/integration_spec.rb
 - spec/log_spec.rb
+- spec/metrics/backends/logger_spec.rb
 - spec/metrics_spec.rb
 - spec/middleware/cors_spec.rb
 - spec/middleware/instruments_spec.rb