zuora_observability 0.1.0.pre.a → 0.1.0.pre.b

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7e3a6c154d518f30f5a95e1be272b96b1853b46df0300d4fa45ca8e17f04451
-  data.tar.gz: 0c510e0da92d8b7139586e60bd048bc91f18cc61a9cfe8165f4f44676c223180
+  metadata.gz: f3c6f15e5345dd32d8ada993579cf90efa2a2382573fe86f608f598be3f69f9e
+  data.tar.gz: 38035565943c737e2f5ac59032780b6ce0c9e2eed0d039870d9b31b4780f7629
 SHA512:
-  metadata.gz: 3948b6dacece27853e9df426c81d6f475c1b8b5417131c4318eeac8b88c8ffa4c4f625036f95cc5b73ed78ed53352f182c2f7efb16800e313b797a7416372b3b
-  data.tar.gz: f67b67d6bbbf2ff33c30433f32f321bf28109540bbf54250764509332de9caba0dbcf94917439882ea7a0f8d6e1bc437eae221134ceb4adfac00933dddadd1f6
+  metadata.gz: c51373a4c25bebde5158c57e035a4363895f67c6f991fc7dbcd9a0741496e65ae07d7f6f65da86f8de14c4ef86ea509f0ba110d9fd7e3d29dcaa83e19117bbd6
+  data.tar.gz: ca248b0270c959804ded1396591e6bacde2abaa2f478ea3b12c2a8265716562ddf0f8f87ddbd90f1ba228657568c337258936faaccebb9540dcbdff59e2903f9

data/README.md

@@ -3,9 +3,27 @@
 A ruby gem to enable observability into rails applications
 
 ## Usage
-How to use my plugin.
+
+### Configuration
+
+Observability can be configured through an initializer as shown below.
+
+```ruby
+# config/initializers/zuora_observability.rb
+ZuoraObservability.configure do |config|
+  config.enable_metrics = true
+end
+```
+
+| Configuration Field | Default Value                                                    | Description                          |
+| ------------------- | ---------------------------------------------------------------- | ------------------------------------ |
+| `enable_metrics`    | `false`                                                          | Enables writing metrics to telegraf  |
+| `telegraf_endpoint` | `'udp://telegraf-app-metrics.monitoring.svc.cluster.local:8094'` | The URL to send telegraf metrics to  |
+| `telegraf_debug`    | `false`                                                          | Log info about data sent to telegraf |
+| `json_logging`      | `false` in development/test, `true` otherwise                    | Use structured JSON logging for ZuoraObservability::Logger. **This configuration option cannot be changed in an initializer, but can be set to `true` with the presence of `ZUORA_JSON_LOGGING` environment variable** |
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -13,14 +31,17 @@ gem 'zuora_observability'
 ```
 
 And then execute:
+
 ```bash
 $ bundle
 ```
 
 Or install it yourself as:
+
 ```bash
 $ gem install zuora_observability
 ```
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/config/initializers/loggers.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+if defined?(Resque.logger)
+  Resque.logger = ZuoraObservability::Logger.custom_logger(name: 'Resque', type: 'Monologger', level: MonoLogger::INFO)
+  if defined?(Resque::Scheduler)
+    Resque::Scheduler.logger = ZuoraObservability::Logger.custom_logger(name: 'ResqueScheduler')
+  end
+end
+
+if defined?(Delayed::Worker.logger)
+  Delayed::Worker.logger = ZuoraObservability::Logger.custom_logger(
+    name: 'DelayedJob', type: 'Monologger', level: MonoLogger::INFO
+  )
+end
+
+if defined?(Makara)
+  Makara::Logging::Logger.logger = ZuoraObservability::Logger.custom_logger(name: 'Makara')
+end
+
+if defined?(ElasticAPM) && ElasticAPM.running?
+  ElasticAPM.agent.config.logger = ZuoraObservability::Logger.custom_logger(name: 'ElasticAPM', level: MonoLogger::WARN)
+end
+
+if defined?(ActionMailer)
+  ActionMailer::Base.logger = ZuoraObservability::Logger.custom_logger(name: 'ActionMailer', type: 'Monologger')
+end

data/lib/zuora_observability/configuration.rb

@@ -10,7 +10,9 @@ module ZuoraObservability
       @enable_metrics = false
       @telegraf_endpoint = 'udp://telegraf-app-metrics.monitoring.svc.cluster.local:8094'
       @telegraf_debug = false
-      @json_logging = false
+      # NOTE(hartley): this checks the var for presence rather than value to
+      # align with how Rails does RAILS_LOG_TO_STDOUT
+      @json_logging = ENV['ZUORA_JSON_LOGGING'].present? ? true : !(Rails.env.development? || Rails.env.test?)
     end
   end
 end

data/lib/zuora_observability/engine.rb

@@ -1,19 +1,39 @@
 # frozen_string_literal: true
 
+require 'zuora_observability/metrics/page_request'
+
 module ZuoraObservability
   # The ZuoraObservability Engine is mounted to hook into Rails
   class Engine < ::Rails::Engine
     isolate_namespace ZuoraObservability
 
+    REQUEST_HEADERS_TO_IGNORE = %w[
+      RAW_POST_DATA
+      REQUEST_METHOD
+      REQUEST_URI
+      REQUEST_PATH
+      PATH_INFO
+      CONTENT_TYPE
+      ORIGINAL_FULLPATH
+      QUERY_STRING
+    ].freeze
+
     config.generators do |g|
       g.test_framework :rspec
     end
 
+    # hook to process_action
+    ActiveSupport::Notifications.subscribe(
+      'process_action.action_controller',
+      ZuoraObservability::Metrics::PageRequest.new
+    )
+
     initializer(:rails_stdout_logging, before: :initialize_logger) do
       require 'lograge'
 
       Rails.configuration.logger = ZuoraObservability::Logger.custom_logger(name: "Rails")
-      if !Rails.env.test? && !Rails.env.development?
+
+      if ZuoraObservability.configuration.json_logging
         Rails.configuration.lograge.enabled = true
         Rails.configuration.colorize_logging = false
       end

data/lib/zuora_observability/logger.rb

@@ -5,8 +5,11 @@ require 'mono_logger'
 module ZuoraObservability
   # A configurable logger that can be used for Rails and additional libraries
   module Logger
-    # NOTE(hartley): potentially change Logger module to delegate methods to
-    # value returned from custom_logger (so it ends up being a pure wrapper)
+    # NOTE(hartley): replace this with a subclass of Ougai Logger
+    # - enable silence method for Rails 5.2 asset requests
+    # https://github.com/tilfin/ougai/wiki/Use-as-Rails-logger
+    # - potentially integrate with MonoLogger so no conditional is needed
+    # https://github.com/tilfin/ougai/issues/74
     def self.custom_logger(name: "", level: Rails.logger.present? ? Rails.logger.level : MonoLogger::INFO, type: :ougai)
       #puts name + ' - ' + {Logger::WARN => 'Logger::WARN', Logger::ERROR => 'Logger::ERROR', Logger::DEBUG => 'Logger::DEBUG', Logger::INFO => 'Logger::INFO' }[level] + ' - '
       if type == :ougai

data/lib/zuora_observability/metrics/page_request.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ZuoraObservability
+  module Metrics
+    # Object of this class is passed to the ActiveSupport::Notification hook
+    class PageRequest
+      # This method is triggered when a non error page is loaded (not 404)
+      def call(_name, started, finished, unique_id, payload)
+        # If the url contains any css or JavaScript files then do not collect metrics for them
+        return nil if %w[css assets jpg png jpeg ico].any? { |word| payload[:path].include?(word) }
+
+        # Getting the endpoint and the content_type
+        content_hash = { :html => 'text/html', :js => 'application/javascript', :json => 'application/json', :csv => 'text/csv' }
+        content_type = content_hash.key?(payload[:format]) ? content_hash[payload[:format]] : payload[:format]
+        content_type = content_type.to_s.gsub('text/javascript', 'application/javascript')
+
+        # payloads with 500 requests do not have status as it is not set by the controller
+        # https://github.com/rails/rails/issues/33335
+        # status_code = payload[:status] ? payload[:status] : payload[:exception_object].present? ? 500 : ""
+        if payload[:exception].present?
+          status_code, exception = [500, payload[:exception].first]
+        else
+          status_code, exception = [payload[:status], nil]
+        end
+
+        tags = { method: payload[:method], status: status_code, error_type: exception, content_type: content_type, controller: payload[:controller], action: payload[:action] }.compact
+
+        values = { view_time: payload[:view_runtime], db_time: payload[:db_runtime], response_time: ((finished - started) * 1000) }.compact
+        values = values.map { |k, v| [k, v.round(2)] }.to_h
+
+        ZuoraObservability::Metrics.write_to_telegraf(direction: :inbound, tags: tags, values: values)
+      end
+    end
+  end
+end

data/lib/zuora_observability/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ZuoraObservability
-  VERSION = '0.1.0-a'
+  VERSION = '0.1.0-b'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zuora_observability
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.a
+  version: 0.1.0.pre.b
 platform: ruby
 authors:
 - Hartley McGuire
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-25 00:00:00.000000000 Z
+date: 2020-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lograge
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mono_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: ougai
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +66,6 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: mono_logger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -253,6 +253,7 @@ files:
 - app/mailers/zuora_observability/application_mailer.rb
 - app/models/zuora_observability/application_record.rb
 - app/views/layouts/zuora_observability/application.html.erb
+- config/initializers/loggers.rb
 - config/routes.rb
 - lib/tasks/zuora_observability_tasks.rake
 - lib/zuora_observability.rb
@@ -262,6 +263,7 @@ files:
 - lib/zuora_observability/logger.rb
 - lib/zuora_observability/logging/formatter.rb
 - lib/zuora_observability/metrics.rb
+- lib/zuora_observability/metrics/page_request.rb
 - lib/zuora_observability/metrics/point_value.rb
 - lib/zuora_observability/metrics/telegraf.rb
 - lib/zuora_observability/version.rb