zuora_observability 0.1.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b737913bb82aaa9107e1b6e143c488f40e284f392b50db8c7ebe295c29182d3
-  data.tar.gz: a69de61e998011b53a88c9a1c1b1b742336b9f47c85b67bea3b60e05ef278e25
+  metadata.gz: 31ace19d3c6b8092e6faaf50da3bc94e53383bb9fa34dafaee16bfa5d5d6e555
+  data.tar.gz: 0f1761ca1c3c27fa4e42e626e689b2af9acb9b574bd6a0ce35f7b373f5f67f60
 SHA512:
-  metadata.gz: dcd410016cab08896b3c687e52f7d2e7f9e987c9eaa402ffac539c1c3c6cdd61df13b7a7b758c55d165b4502d894adf43f3087d88999868a3a13c70ec51e5a0d
-  data.tar.gz: b326d582ea811996cebb8a35430146141f8992fbeb83675bfda5067a4b08cb59714938d6fd0c98fa7f1ea1d8a0e63fbcb843e64c1dcf2da7d8ace5bdda2350b4
+  metadata.gz: e03d3fbabf4b6547844b28be303feeae46ea0966b793824b7fcafd4371551de5b436490abdf192f4046ac7ff38450e51b87b401de9e160e450d734510dba87b5
+  data.tar.gz: c36453840bd493eb29a6f1220a3ab234079b2795d97f32a201ddda9d445fd37c6e640fc147b53e6cc303dac72112b3ac2326daa8005a6ba20a4711c85ef86ca3

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

@@ -11,7 +11,7 @@ module ZuoraObservability
 
     initializer(:rails_stdout_logging, before: :initialize_logger) do
       Rails.application.configure do
-        config.logger = ZuoraObservability::Logger.custom_logger(name: 'Rails')
+        config.logger = ActiveSupport::TaggedLogging.new(ZuoraObservability::Logger.custom_logger(name: 'Rails'))
 
         next unless ZuoraObservability.configuration.json_logging
 

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

@@ -50,18 +50,21 @@ module ZuoraObservability
           ecs: { version: ECS_VERSION },
           log: { level: severity, logger: progname || @app_name },
           service: { name: Env.name, version: Env.version },
-          trace: { id: data[:trace_id] }
+          trace: { id: data[:trace_id] },
+          tags: ['zecs']
         }
       end
 
-      # error
+      # errors
       def error_fields(data)
-        return {} unless data[:error]
+        return {} unless data[:error] || data[:err]
+
+        error = data[:err] || serialize_exc(data[:error])
 
         {
-          message: data[:error].message,
-          stack_trace: data[:error].backtrace.join("\n"),
-          type: data[:error].class
+          message: error[:message],
+          stack_trace: error[:stack],
+          type: error[:name]
         }.compact
       end
 
@@ -72,16 +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]
+          status_code: response[:status],
+          body: ({ content: response[:params] } if response.key? :params),
         }.compact
       end
 
@@ -100,6 +108,7 @@ module ZuoraObservability
       # url
       def url_fields(data)
         {
+          full: data.dig(:url, :full),
           path: data[:path]
         }.compact
       end
@@ -145,7 +154,6 @@ module ZuoraObservability
 
         def base_fields(data)
           {
-            apartment_id: data[:app_instance_id],
             cp_id: data[:zuora_track_id],
             environment: data[:environment],
             tenant_id: data[:tenant_ids],
@@ -155,16 +163,27 @@ 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
 
         # Service's Custom Fields
         def service_fields(data)
-          data[:zecs_service].presence || {}
+          {
+            app_instance_id: data[:app_instance_id]
+          }.merge(data.fetch(:zecs_service, {})).compact
         end
       end
     end

data/lib/zuora_observability/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zuora_observability
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Hartley McGuire
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-17 00:00:00.000000000 Z
+date: 2021-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lograge
@@ -244,8 +244,6 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/config/zuora_observability_manifest.js
-- app/assets/stylesheets/zuora_observability/application.css
 - app/controllers/zuora_observability/application_controller.rb
 - app/controllers/zuora_observability/metrics_controller.rb
 - app/helpers/zuora_observability/application_helper.rb
@@ -254,6 +252,7 @@ files:
 - 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
@@ -284,7 +283,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Summary of ZuoraObservability.

data/app/assets/config/zuora_observability_manifest.js

@@ -1 +0,0 @@
-//= link_directory ../stylesheets/zuora_observability .css

data/app/assets/stylesheets/zuora_observability/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
- *= require_self
- */