zuora_observability 0.2.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6d0f3a139bf8fb34c6d9eb5cda9f00e70454dca7eca5d5d805a1c5e3fd63db8
-  data.tar.gz: 0deaaad02637351504969a88c05156944aff6121f06af6ea092662591828911c
+  metadata.gz: 4c138e8fa24ec1a1bc4f348c5b03d9290d5ba1c82a23d31ee3893d2cd1ea3d99
+  data.tar.gz: 3d877492d7a316f48f7874429c23699a293cff8be5c2d72c07cf4342afb9ec77
 SHA512:
-  metadata.gz: 37bd27174e6e17457f24bdbecda6684de98a33a959403943ee02731cf763519b4cae6daa06ae1c58ca8f0ddb02924e1178c191a5170577f70e0112700a18cab9
-  data.tar.gz: 6c75b2300f11d99fc8f94e88cb618e6da59ee686c51fed7b78a1a8e0b12972a613422cba1ae21ed26d686279d9c7f0802fa52a6c53955172aca651cfe4794851
+  metadata.gz: e70ddf07824d1a18edf90306696e27b686b48a1af4cb50a4f42ba3ee0fa1c43d5a55553a1e2d5bad1deca9b88e9fc94320fc37e6157f64aded958293988923a5
+  data.tar.gz: 71c1eb29ea25f069495c69165b090b6650a615668219dc732b7421a4873ee659ca75331b8aa68bc679b6d1a00dc41e687e62f06e8fa75cd197803edefc3feb88

data/config/initializers/tagged_logging.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module ActiveSupport
+  module TaggedLogging
+    # Patch to apply structured tags to Tagged Logs
+    module Formatter
+      def call(severity, timestamp, progname, data)
+        super(severity, timestamp, progname, merged_tags.merge(data))
+      end
+
+      private
+
+      def merged_tags
+        current_tags.reduce(:merge) || {}
+      end
+    end
+  end
+end
+
+module Rails
+  module Rack
+    # Patch to compute structured tags for Tagged Logging
+    class Logger
+      private
+
+      def compute_tags(request)
+        {
+          trace_id: request.uuid
+        }
+      end
+    end
+  end
+end

data/lib/zuora_observability/engine.rb

@@ -15,6 +15,8 @@ module ZuoraObservability
 
         next unless ZuoraObservability.configuration.json_logging
 
+        config.logger = ActiveSupport::TaggedLogging.new(config.logger)
+
         require 'lograge'
         require 'zuora_observability/logging/custom_options'
 

data/lib/zuora_observability/env.rb

@@ -43,7 +43,7 @@ module ZuoraObservability
       private
 
       def app_parent_name
-        if Rails::VERSION::MAJOR >= 6 && Rails::VERSION::MINOR >= 1
+        if Rails::VERSION::MAJOR >= 6
           Rails.application.class.module_parent_name
         else
           Rails.application.class.parent_name

data/lib/zuora_observability/logger.rb

@@ -59,6 +59,11 @@ module ZuoraObservability
       if type == :ougai
         logger = new($stdout, level: level, progname: name)
       else
+        ActiveSupport::Deprecation.warn(<<-MSG.squish)
+          Creating a non-ougai custom_logger is deprecated and will be removed
+          in a future version of zuora_observability.
+        MSG
+
         require 'mono_logger'
         logger = MonoLogger.new(STDOUT)
         logger.level = level

data/lib/zuora_observability/logging/custom_options.rb

@@ -25,7 +25,6 @@ module ZuoraObservability
           items = {
             msg: 'Rails Request',
             params: event.payload[:params].as_json(except: IGNORE_PARAMS).to_s,
-            trace_id: event.payload[:headers]['action_dispatch.request_id'],
             zuora_trace_id: event.payload[:headers]['HTTP_ZUORA_REQUEST_ID'],
             error: event.payload[:exception_object]
           }

data/lib/zuora_observability/logging/formatter.rb

@@ -59,19 +59,13 @@ module ZuoraObservability
       def error_fields(data)
         return {} unless data[:error] || data[:err]
 
-        if data[:error]
-          {
-            message: data[:error].message,
-            stack_trace: data[:error].backtrace.join("\n"),
-            type: data[:error].class
-          }.compact
-        else
-          {
-            message: data.dig(:err, :message),
-            stack_trace: data.dig(:err, :stack),
-            type: data.dig(:err, :name)
-          }.compact
-        end
+        error = data[:err] || serialize_exc(data[:error])
+
+        {
+          message: error[:message],
+          stack_trace: error[:stack],
+          type: error[:name]
+        }.compact
       end
 
       # http
@@ -81,17 +75,21 @@ module ZuoraObservability
 
       # http.request
       def request_fields(data)
+        request = data.slice(:method, :params).merge(data.fetch(:request, {}))
+
         {
-          method: data[:method],
-          body: ({ content: data[:params] } if data.key? :params)
+          method: request[:method],
+          body: ({ content: request[:params] } if request.key? :params)
         }.compact
       end
 
       # http.response
       def response_fields(data)
+        response = data.slice(:status).merge(data.fetch(:response, {}))
+
         {
-          status_code: data[:status],
-          body: data[:response_body]
+          status_code: response[:status],
+          body: ({ content: response[:params] } if response.key? :params),
         }.compact
       end
 
@@ -110,6 +108,7 @@ module ZuoraObservability
       # url
       def url_fields(data)
         {
+          full: data.dig(:url, :full),
           path: data[:path]
         }.compact
       end
@@ -156,6 +155,7 @@ module ZuoraObservability
         def base_fields(data)
           {
             cp_id: data[:zuora_track_id],
+            entity_ids: data[:entity_ids],
             environment: data[:environment],
             tenant_id: data[:tenant_ids],
             trace_id: data[:zuora_trace_id]
@@ -164,10 +164,19 @@ module ZuoraObservability
 
         # zuora.http
         def http_fields(data)
-          z_http_request = { headers: data[:headers] }.compact
+          z_http_request = {
+            headers: data[:headers] || data.dig(:request, :headers),
+            headers_blob: data.dig(:request, :headers_blob)
+          }.compact
+
+          z_http_response = {
+            headers: data.dig(:response, :headers),
+            headers_blob: data.dig(:response, :headers_blob)
+          }.compact
 
           {
-            request: (z_http_request unless z_http_request.empty?)
+            request: (z_http_request unless z_http_request.empty?),
+            response: (z_http_response unless z_http_response.empty?)
           }.compact
         end
 

data/lib/zuora_observability/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ZuoraObservability
-  VERSION = '0.2.2'
+  VERSION = '0.3.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zuora_observability
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Hartley McGuire
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-16 00:00:00.000000000 Z
+date: 2021-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lograge
@@ -247,11 +247,9 @@ files:
 - app/controllers/zuora_observability/application_controller.rb
 - app/controllers/zuora_observability/metrics_controller.rb
 - app/helpers/zuora_observability/application_helper.rb
-- app/jobs/zuora_observability/application_job.rb
-- 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/initializers/tagged_logging.rb
 - config/routes.rb
 - lib/tasks/zuora_observability_tasks.rake
 - lib/zuora_observability.rb
@@ -282,7 +280,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Summary of ZuoraObservability.

data/app/jobs/zuora_observability/application_job.rb

@@ -1,4 +0,0 @@
-module ZuoraObservability
-  class ApplicationJob < ActiveJob::Base
-  end
-end

data/app/mailers/zuora_observability/application_mailer.rb

@@ -1,6 +0,0 @@
-module ZuoraObservability
-  class ApplicationMailer < ActionMailer::Base
-    default from: 'from@example.com'
-    layout 'mailer'
-  end
-end

data/app/models/zuora_observability/application_record.rb

@@ -1,5 +0,0 @@
-module ZuoraObservability
-  class ApplicationRecord < ActiveRecord::Base
-    self.abstract_class = true
-  end
-end