zuora_observability 0.1.0.pre.d → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4a7c9aeb569ef2885c3f8b298771323d5a2619340b47e390d790966794b67df
-  data.tar.gz: 417163de43f269d1c5f82e2bf1c09c5066a5f752bc8e4d77d6bf27435de1d137
+  metadata.gz: 1a94e262b55a7a805865de68758223aa220ac3a5629e9cd40e80c02866b88b47
+  data.tar.gz: e96b42e4ecd613654b5a459081804b06e8e88c4140a37170f5c52fce29eaed31
 SHA512:
-  metadata.gz: e8435b4a4aa06bebf6d0924c8f39d71da9b96debf12582e0b92d147389e8072c8bcc40c13e2978a81cc7c8b0da9efcb540e3fa864a91e90f0b001b76d0c45667
-  data.tar.gz: a2adea8aef5fc82317077e4f68eb7061c66ca53991a545642deac1f5367cf35dfbae329fe83ee6feb3aa727e958cc0c6d7cae27c9062852affe29f8048ca6227
+  metadata.gz: a77e6d19eb74c9b0bfd16459e71eefc15ebadd70f32a0e7d88280644db96ac6ba716100007380d883f7431bd90d430a1670aa1f2c312cf86c188fcf8f1ad04eb
+  data.tar.gz: 826a76a11e9b47b6a7bf79e91c013f493cb038ffbe3a217f3fa78f7a3740ffa94c625778cb859a675bcbb678865b92153eaadc651802b251b4d03f7d06fadb71

data/README.md

@@ -2,24 +2,10 @@
 
 A ruby gem to enable observability into rails applications
 
-## Usage
-
-- [Logging](doc/logging.md)
-
-### 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
-```
+## Prerequisites
 
-| Configuration Field | Default Value                                                    | Description                          |
-| ------------------- | ---------------------------------------------------------------- | ------------------------------------ |
-| `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** |
+- Ruby 2.5+
+- Rails 5.0+
 
 ## Installation
 
@@ -41,6 +27,10 @@ Or install it yourself as:
 $ gem install zuora_observability
 ```
 
+## Usage
+
+- [Logging](doc/logging.md)
+
 ## 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

@@ -1,16 +1,14 @@
 # frozen_string_literal: true
 
 if defined?(Resque.logger)
-  Resque.logger = ZuoraObservability::Logger.custom_logger(name: 'Resque', type: 'Monologger', level: MonoLogger::INFO)
+  Resque.logger = ZuoraObservability::Logger.custom_logger(name: 'Resque')
   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
-  )
+  Delayed::Worker.logger = ZuoraObservability::Logger.custom_logger(name: 'DelayedJob', level: Logger::INFO)
 end
 
 if defined?(Makara)
@@ -18,9 +16,9 @@ if defined?(Makara)
 end
 
 if defined?(ElasticAPM) && ElasticAPM.running?
-  ElasticAPM.agent.config.logger = ZuoraObservability::Logger.custom_logger(name: 'ElasticAPM', level: MonoLogger::WARN)
+  ElasticAPM.agent.config.logger = ZuoraObservability::Logger.custom_logger(name: 'ElasticAPM', level: Logger::WARN)
 end
 
 if defined?(ActionMailer)
-  ActionMailer::Base.logger = ZuoraObservability::Logger.custom_logger(name: 'ActionMailer', type: 'Monologger')
+  ActionMailer::Base.logger = ZuoraObservability::Logger.custom_logger(name: 'ActionMailer')
 end

data/lib/zuora_observability/env.rb

@@ -17,8 +17,7 @@ module ZuoraObservability
       end
 
       def app_name
-        # parent_name is deprecated in Rails 6.0, removed in 6.1
-        ENV['DEIS_APP'].presence || Rails.application.class.parent_name
+        ENV['DEIS_APP'].presence || app_parent_name
       end
 
       def pod_name
@@ -40,6 +39,16 @@ module ZuoraObservability
         end
         return p_type
       end
+
+      private
+
+      def app_parent_name
+        if Rails::VERSION::MAJOR >= 6 && Rails::VERSION::MINOR >= 1
+          Rails.application.class.module_parent_name
+        else
+          Rails.application.class.parent_name
+        end
+      end
     end
   end
 end

data/lib/zuora_observability/logging/custom_options.rb

@@ -13,6 +13,7 @@ module ZuoraObservability
         CONTENT_TYPE
         ORIGINAL_FULLPATH
         QUERY_STRING
+        HTTP_COOKIE
       ].freeze
 
       IGNORE_PARAMS = %w[controller action format].freeze
@@ -37,13 +38,6 @@ module ZuoraObservability
             items.merge!({ headers: filtered_headers })
           end
 
-          if Thread.current[:appinstance].present?
-            items.merge!({connect_user: Thread.current[:appinstance].connect_user, new_session: Thread.current[:appinstance].new_session_message})
-            if Thread.current[:appinstance].logitems.present? && Thread.current[:appinstance].logitems.class == Hash
-              items.merge!(Thread.current[:appinstance].logitems)
-            end
-          end
-
           items
         end
 

data/lib/zuora_observability/logging/formatter.rb

@@ -50,7 +50,8 @@ 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
 
@@ -107,6 +108,7 @@ module ZuoraObservability
       # user
       def user_fields(data)
         {
+          id: data[:user_id],
           email: data[:email]
         }.compact
       end
@@ -124,7 +126,7 @@ module ZuoraObservability
 
     # The Zuora Extension to ECS defined by ZECS
     module ZuoraFields
-      ZECS_VERSION = '1.0'
+      ZECS_VERSION = '1.1'
 
       class << self
         # zuora top level field
@@ -145,6 +147,7 @@ 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],
             trace_id: data[:zuora_trace_id]

data/lib/zuora_observability/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zuora_observability
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.d
+  version: 0.2.0
 platform: ruby
 authors:
 - Hartley McGuire
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-12 00:00:00.000000000 Z
+date: 2021-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lograge
@@ -140,16 +140,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
@@ -168,16 +168,16 @@ dependencies:
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0.pre
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0.pre
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -280,11 +280,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Summary of ZuoraObservability.