dry-monitor 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79d679b29fb37de532a1855d9d9225bb1337f9675c93ec509b6ea2f70f2123d7
-  data.tar.gz: 3308df70e50a3d4bf2c95a772846e3c6229ef764d6ec679e5a3760249f48afb6
+  metadata.gz: 973eacb62c325645cdf9f3b01b5c39512e4b8f461b99ffcd7993edbd0d6e813f
+  data.tar.gz: 3b7687f24f0a6498516a7fe5e9a36c4c1b4bb988a64e708a9bf5b4f2c52a17ad
 SHA512:
-  metadata.gz: 2bb851503a4caa35361e751bb68367d71b04d3c005f08d47090cb5646b7756be257ecc7bbaff5b22aff18e7cf34770af3b39b196886bb35d221002c4b6996d31
-  data.tar.gz: e2247a4b41a7430b1a609556aab0dbfca7c0bf7fe115ef19a91c772e3f47707d57aa80bb024ad9bfc222d73d50ddba5904ab08c08ef66505208bcaaf20e43316
+  metadata.gz: 8feea8bd4a5b2a38ab32b1565620b8e4c6696c5960e2abbcf4c4b9875a183a9fbef76361e794aeb17a18e41781669988f41367b6cdf3eb49d5ad8761ea71da17
+  data.tar.gz: 80bf24f9be77459e782a417c9e8ca4a106ab4e07e0ef1b89174bab41205d13658723736064bcdc0cdbe60b3a50277b20b38bd037632a37845a147bda3bb14e98

data/CHANGELOG.md

@@ -1,62 +1,129 @@
-# v0.3.0 2019-01-29
+<!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
+
+## 0.5.0 2021-09-12
+
+
+### Changed
+
+- [internal] Upgraded to new `setting` API provided in dry-configurable 0.13.0 (@timriley in #43)
+
+[Compare v0.4.0...v0.5.0](https://github.com/dry-rb/dry-monitor/compare/v0.4.0...v0.5.0)
+
+## 0.4.0 2021-04-09
+
+
+### Fixed
+
+- Compatibility with MRI 3.0 (@alex-damian-negru)
+
+
+[Compare v0.3.2...v0.4.0](https://github.com/dry-rb/dry-monitor/compare/v0.3.2...v0.4.0)
+
+## 0.3.2 2020-04-09
+
+
+### Fixed
+
+- Ensure `Dry::Monitor::Rack::Middleware` is compatible with `Rack::Builder#use` (@jodosha)
+
+### Changed
+
+- Performance improvements (@davydovanton)
+
+[Compare v0.3.1...v0.3.2](https://github.com/dry-rb/dry-monitor/compare/v0.3.1...v0.3.2)
+
+## 0.3.1 2019-06-18
+
+
+### Fixed
+
+- Uninitialized constant `Dry::Monitor::Notifications::EMPTY_HASH` when no payload given (@mensfeld)
+
+
+[Compare v0.3.0...v0.3.1](https://github.com/dry-rb/dry-monitor/compare/v0.3.0...v0.3.1)
+
+## 0.3.0 2019-01-29
+
 
 ### Fixed
 
-* cannot load such file -- rack/utils (mensfeld)
+- cannot load such file -- rack/utils (mensfeld)
 
 ### Changed
 
-* Make `rack` logger into a plugin (mensfeld)
-* Make `sql` logger into a plugin (mensfeld)
+- Make `rack` logger into a plugin (mensfeld)
+- Make `sql` logger into a plugin (mensfeld)
+
+[Compare v0.2.0...v0.3.0](https://github.com/dry-rb/dry-monitor/compare/v0.2.0...v0.3.0)
+
+## 0.2.0 2018-01-21
 
-# v0.2.0 2018-01-21
 
 ### Changed
 
-* Make `rouge` an optional dependency (davydovanton & mensfeld)
+- Make `rouge` an optional dependency (davydovanton & mensfeld)
+
+[Compare v0.1.2...v0.2.0](https://github.com/dry-rb/dry-monitor/compare/v0.1.2...v0.2.0)
+
+## 0.1.2 2018-01-04
 
-# v0.1.2 2018-01-04
 
 ### Fixed
 
-* Rack logger no longer prevents arbitrary payload in `:error` events (solnic)
+- Rack logger no longer prevents arbitrary payload in `:error` events (solnic)
+
+
+[Compare v0.1.1...v0.1.2](https://github.com/dry-rb/dry-monitor/compare/v0.1.1...v0.1.2)
+
+## 0.1.1 2018-01-03
 
-# v0.1.1 2018-01-03
 
 ### Fixed
 
-* Query params containing arrays of primitives (e.g. `?ids[]=1&ids[]=2`) no longer crash the logger (timriley)
+- Query params containing arrays of primitives (e.g. `?ids[]=1&ids[]=2`) no longer crash the logger (timriley)
+
+
+[Compare v0.1.0...v0.1.1](https://github.com/dry-rb/dry-monitor/compare/v0.1.0...v0.1.1)
+
+## 0.1.0 2018-01-02
 
-# v0.1.0 2018-01-02
 
 ### Fixed
 
-* Query params are logged correctly via rack middleware (solnic)
+- Query params are logged correctly via rack middleware (solnic)
 
 ### Changed
 
-* Uses `dry-events` for notifications (solnic)
+- Uses `dry-events` for notifications (solnic)
+
+[Compare v0.0.3...v0.1.0](https://github.com/dry-rb/dry-monitor/compare/v0.0.3...v0.1.0)
+
+## 0.0.3 2017-08-28
 
-# v0.0.3 2017-08-28
 
 ### Changed
 
-* Update default theme setting for compatibility with latest version of rouge (alexandru-calinoiu)
-* Require latest version of rouge gem (timriley)
+- Update default theme setting for compatibility with latest version of rouge (alexandru-calinoiu)
+- Require latest version of rouge gem (timriley)
+
+[Compare v0.0.2...v0.0.3](https://github.com/dry-rb/dry-monitor/compare/v0.0.2...v0.0.3)
+
+## 0.0.2 2017-02-02
 
-# v0.0.2 2017-02-02
 
 ### Added
 
-* `Dry::Monitor::Rack::Middleware#on` shortcut (solnic)
-* `Dry::Monitor::Rack::Middleware#instrument` shortcut (solnic)
-* `Dry::Monitor::SQL::Logger` can be configured with a custom message template (solnic)
+- `Dry::Monitor::Rack::Middleware#on` shortcut (solnic)
+- `Dry::Monitor::Rack::Middleware#instrument` shortcut (solnic)
+- `Dry::Monitor::SQL::Logger` can be configured with a custom message template (solnic)
 
 ### Changed
 
-* `Dry::Monitor::Rack::Logger#{subscribe=>attach}` and now it accepts a rack middleware instance (solnic)
-* `Dry::Monitor::Rack::Logger` appends new lines when logging `:rack.request.stop` events (solnic)
+- `Dry::Monitor::Rack::Logger#{subscribe=>attach}` and now it accepts a rack middleware instance (solnic)
+- `Dry::Monitor::Rack::Logger` appends new lines when logging `:rack.request.stop` events (solnic)
+
+[Compare v0.0.1...v0.0.2](https://github.com/dry-rb/dry-monitor/compare/v0.0.1...v0.0.2)
 
-# v0.0.1 2017-02-01
+## 0.0.1 2017-02-01
 
 First public release

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 Ruby Object Mapper
+Copyright (c) 2015-2021 dry-rb team
 
 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

data/README.md

@@ -1,25 +1,29 @@
+<!--- this file is synced from dry-rb/template-gem project -->
 [gem]: https://rubygems.org/gems/dry-monitor
-[travis]: https://travis-ci.org/dry-rb/dry-monitor
-[gemnasium]: https://gemnasium.com/dry-rb/dry-monitor
-[codeclimate]: https://codeclimate.com/github/dry-rb/dry-monitor
-[coveralls]: https://coveralls.io/r/dry-rb/dry-monitor
+[actions]: https://github.com/dry-rb/dry-monitor/actions
+[codacy]: https://www.codacy.com/gh/dry-rb/dry-monitor
+[chat]: https://dry-rb.zulipchat.com
 [inchpages]: http://inch-ci.org/github/dry-rb/dry-monitor
 
-# dry-monitor [![Join the chat at https://gitter.im/dry-rb/chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dry-rb/chat)
+# dry-monitor [![Join the chat at https://dry-rb.zulipchat.com](https://img.shields.io/badge/dry--rb-join%20chat-%23346b7a.svg)][chat]
 
 [![Gem Version](https://badge.fury.io/rb/dry-monitor.svg)][gem]
-[![Build Status](https://travis-ci.org/dry-rb/dry-monitor.svg?branch=master)][travis]
-[![Dependency Status](https://gemnasium.com/dry-rb/dry-monitor.svg)][gemnasium]
-[![Code Climate](https://codeclimate.com/github/dry-rb/dry-monitor/badges/gpa.svg)][codeclimate]
-[![Test Coverage](https://codeclimate.com/github/dry-rb/dry-monitor/badges/coverage.svg)][codeclimate]
+[![CI Status](https://github.com/dry-rb/dry-monitor/workflows/CI/badge.svg)][actions]
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/984c4274e56d423a818e7a1bf5e963d0)][codacy]
+[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/984c4274e56d423a818e7a1bf5e963d0)][codacy]
 [![Inline docs](http://inch-ci.org/github/dry-rb/dry-monitor.svg?branch=master)][inchpages]
 
-Monitoring and instrumentation APIs.
+## Links
 
-## Synopsis
+* [User documentation](https://dry-rb.org/gems/dry-monitor)
+* [API documentation](http://rubydoc.info/gems/dry-monitor)
 
-``` ruby
-```
+## Supported Ruby versions
+
+This library officially supports the following Ruby versions:
+
+* MRI `>= 2.6.0`
+* ~~jruby~~ `>= 9.3` (we are waiting for [2.6 support](https://github.com/jruby/jruby/issues/6161))
 
 ## License
 

data/dry-monitor.gemspec

@@ -1,27 +1,40 @@
-# coding: utf-8
-require File.expand_path('../lib/dry/monitor/version', __FILE__)
+# frozen_string_literal: true
+
+# this file is synced from dry-rb/template-gem project
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dry/monitor/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'dry-monitor'
-  spec.version       = Dry::Monitor::VERSION
-  spec.authors       = ['Piotr Solnica']
-  spec.email         = ['piotr.solnica@gmail.com']
-  spec.summary       = 'Monitoring and instrumentation APIs'
-  spec.homepage      = 'https://github.com/dry-rb/dry-monitor'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
-
-  spec.add_runtime_dependency 'dry-equalizer', '~> 0.2'
-  spec.add_runtime_dependency 'dry-configurable', '~> 0.5'
-  spec.add_runtime_dependency 'dry-events', '~> 0.1'
-  spec.add_runtime_dependency 'dry-core', '~> 0.4'
-
-  spec.add_development_dependency 'rouge', '~> 2.0', '>= 2.2.1'
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
+  spec.name          = "dry-monitor"
+  spec.authors       = ["Piotr Solnica"]
+  spec.email         = ["piotr.solnica@gmail.com"]
+  spec.license       = "MIT"
+  spec.version       = Dry::Monitor::VERSION.dup
+
+  spec.summary       = "Monitoring and instrumentation APIs"
+  spec.description   = spec.summary
+  spec.homepage      = "https://dry-rb.org/gems/dry-monitor"
+  spec.files         = Dir["CHANGELOG.md", "LICENSE", "README.md", "dry-monitor.gemspec", "lib/**/*"]
+  spec.bindir        = "bin"
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["changelog_uri"]     = "https://github.com/dry-rb/dry-monitor/blob/master/CHANGELOG.md"
+  spec.metadata["source_code_uri"]   = "https://github.com/dry-rb/dry-monitor"
+  spec.metadata["bug_tracker_uri"]   = "https://github.com/dry-rb/dry-monitor/issues"
+
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # to update dependencies edit project.yml
+  spec.add_runtime_dependency "dry-configurable", "~> 0.13", ">= 0.13.0"
+  spec.add_runtime_dependency "dry-core", "~> 0.5", ">= 0.5"
+  spec.add_runtime_dependency "dry-events", "~> 0.2"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rouge", "~> 2.0", ">= 2.2.1"
+  spec.add_development_dependency "rspec"
 end

data/lib/dry/monitor/constants.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "dry/core/constants"
+
+module Dry
+  module Monitor
+    include Dry::Core::Constants
+  end
+end

data/lib/dry/monitor/logger.rb

@@ -1,13 +1,17 @@
-require 'logger'
+# frozen_string_literal: true
+
+require "logger"
 
 module Dry
   module Monitor
     class Logger < ::Logger
+      DEFAULT_FORMATTER = proc do |_severity, _datetime, _progname, msg|
+        "#{msg}\n"
+      end
+
       def initialize(*args)
         super
-        self.formatter = proc do |severity, datetime, progname, msg|
-          "#{msg}\n"
-        end
+        self.formatter = DEFAULT_FORMATTER
       end
     end
   end

data/lib/dry/monitor/notifications.rb

@@ -1,4 +1,7 @@
-require 'dry/events/publisher'
+# frozen_string_literal: true
+
+require "dry/events/publisher"
+require "dry/monitor/constants"
 
 module Dry
   module Monitor
@@ -17,11 +20,9 @@ module Dry
     CLOCK = Clock.new
 
     class Notifications
-      include Events::Publisher['Dry::Monitor::Notifications']
-
-      attr_reader :id
+      include Events::Publisher["Dry::Monitor::Notifications"]
 
-      attr_reader :clock
+      attr_reader :id, :clock
 
       def initialize(id)
         @id = id
@@ -36,10 +37,8 @@ module Dry
         instrument(event_id, payload)
       end
 
-      def instrument(event_id, payload = EMPTY_HASH)
-        if block_given?
-          result, time = @clock.measure { yield }
-        end
+      def instrument(event_id, payload = EMPTY_HASH, &block)
+        result, time = @clock.measure(&block) if block_given?
 
         process(event_id, payload) do |event, listener|
           if time

data/lib/dry/monitor/rack/logger.rb

@@ -1,5 +1,7 @@
-require 'dry/configurable'
-require 'dry/monitor/rack/middleware'
+# frozen_string_literal: true
+
+require "dry/configurable"
+require "dry/monitor/rack/middleware"
 
 module Dry
   module Monitor
@@ -7,21 +9,19 @@ module Dry
       class Logger
         extend Dry::Configurable
 
-        setting :filtered_params, %w[_csrf password]
-
-        REQUEST_METHOD = 'REQUEST_METHOD'.freeze
-        PATH_INFO = 'PATH_INFO'.freeze
-        REMOTE_ADDR = 'REMOTE_ADDR'.freeze
-        QUERY_STRING = 'QUERY_STRING'.freeze
+        setting :filtered_params, default: %w[_csrf password]
 
-        START_MSG = %(Started %s "%s" for %s at %s).freeze
-        STOP_MSG = %(Finished %s "%s" for %s in %sms [Status: %s]\n).freeze
-        QUERY_MSG = %(  Query parameters %s).freeze
-        FILTERED = '[FILTERED]'.freeze
+        REQUEST_METHOD = "REQUEST_METHOD"
+        PATH_INFO = "PATH_INFO"
+        REMOTE_ADDR = "REMOTE_ADDR"
+        QUERY_STRING = "QUERY_STRING"
 
-        attr_reader :logger
+        START_MSG = %(Started %s "%s" for %s at %s)
+        STOP_MSG = %(Finished %s "%s" for %s in %sms [Status: %s]\n)
+        QUERY_MSG = %(  Query parameters )
+        FILTERED = "[FILTERED]"
 
-        attr_reader :config
+        attr_reader :logger, :config
 
         def initialize(logger, config = self.class.config)
           @logger = logger
@@ -29,47 +29,39 @@ module Dry
         end
 
         def attach(rack_monitor)
-          rack_monitor.on(:start) do |env:|
-            log_start_request(env)
-          end
-
-          rack_monitor.on(:stop) do |env:, status:, time:|
-            log_stop_request(env, status, time)
-          end
-
-          rack_monitor.on(:error) do |event|
-            log_exception(event[:exception])
-          end
+          rack_monitor.on(:start) { |params| log_start_request(params[:env]) }
+          rack_monitor.on(:stop) { |params| log_stop_request(**params) }
+          rack_monitor.on(:error) { |event| log_exception(event[:exception]) }
         end
 
-        def log_exception(e)
-          logger.error e.message
-          logger.error filter_backtrace(e.backtrace).join("\n")
+        def log_exception(err)
+          logger.error err.message
+          logger.error filter_backtrace(err.backtrace).join("\n")
         end
 
         def log_start_request(request)
-          info START_MSG % [
-                 request[REQUEST_METHOD],
-                 request[PATH_INFO],
-                 request[REMOTE_ADDR],
-                 Time.now
-               ]
+          logger.info START_MSG % [
+            request[REQUEST_METHOD],
+            request[PATH_INFO],
+            request[REMOTE_ADDR],
+            Time.now
+          ]
           log_request_params(request)
         end
 
-        def log_stop_request(request, status, time)
-          info STOP_MSG % [
-                 request[REQUEST_METHOD],
-                 request[PATH_INFO],
-                 request[REMOTE_ADDR],
-                 time,
-                 status
-               ]
+        def log_stop_request(env:, status:, time:)
+          logger.info STOP_MSG % [
+            env[REQUEST_METHOD],
+            env[PATH_INFO],
+            env[REMOTE_ADDR],
+            time,
+            status
+          ]
         end
 
         def log_request_params(request)
           with_http_params(request[QUERY_STRING]) do |params|
-            info QUERY_MSG % [params.inspect]
+            logger.info QUERY_MSG + params.inspect
           end
         end
 
@@ -80,28 +72,26 @@ module Dry
         def with_http_params(params)
           params = ::Rack::Utils.parse_nested_query(params)
 
-          if params.size > 0
-            yield(filter_params(params))
-          end
+          yield(filter_params(params)) unless params.empty?
         end
 
         def filter_backtrace(backtrace)
           # TODO: what do we want to do with this?
-          backtrace.reject { |l| l.include?('gems') }
+          backtrace.reject { |l| l.include?("gems") }
         end
 
         def filter_params(params)
-          params.each_with_object({}) do |(k, v), h|
+          params.each do |k, v|
             if config.filtered_params.include?(k)
-              h.update(k => FILTERED)
+              params[k] = FILTERED
             elsif v.is_a?(Hash)
-              h.update(k => filter_params(v))
+              filter_params(v)
             elsif v.is_a?(Array)
-              h.update(k => v.map { |m| m.is_a?(Hash) ? filter_params(m) : m })
-            else
-              h[k] = v
+              v.map! { |m| m.is_a?(Hash) ? filter_params(m) : m }
             end
           end
+
+          params
         end
       end
     end