zuora_observability 0.1.0.pre.b → 0.1.0.pre.c

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3c6f15e5345dd32d8ada993579cf90efa2a2382573fe86f608f598be3f69f9e
-  data.tar.gz: 38035565943c737e2f5ac59032780b6ce0c9e2eed0d039870d9b31b4780f7629
+  metadata.gz: be19d78e7a52c884e0bd5cc705a3725ea9616cd96491116d6ac047abbe8018b3
+  data.tar.gz: 446dc9c840d1d00cf66c0316d2fca0b38718d2b4ac32bcda718069515283c3f9
 SHA512:
-  metadata.gz: c51373a4c25bebde5158c57e035a4363895f67c6f991fc7dbcd9a0741496e65ae07d7f6f65da86f8de14c4ef86ea509f0ba110d9fd7e3d29dcaa83e19117bbd6
-  data.tar.gz: ca248b0270c959804ded1396591e6bacde2abaa2f478ea3b12c2a8265716562ddf0f8f87ddbd90f1ba228657568c337258936faaccebb9540dcbdff59e2903f9
+  metadata.gz: a70635409b8672344d7efd3c4025507ca0f450fc64aa78d5d81de9558926d1e5a59716832e7408a83abf24ed6492e4470a80fbb8bf1f84ad6391d1e188eaf94f
+  data.tar.gz: 7718bfc8650dc24092149163861a6f55ae7164cecda3f91534ee98c92645462195b9be625d0f212df974d2b87d4cc767ef9721d6f45581d47dfa0c878a53fccb

data/README.md

@@ -17,9 +17,6 @@ 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

data/lib/zuora_observability.rb

@@ -7,8 +7,6 @@ require 'zuora_observability/metrics'
 require 'zuora_observability/logger'
 
 require 'zuora_observability/logging/formatter'
-require 'zuora_observability/metrics/telegraf'
-require 'zuora_observability/metrics/point_value'
 
 # Provides Rails application with tools for observabilty
 module ZuoraObservability

data/lib/zuora_observability/configuration.rb

@@ -3,13 +3,9 @@
 module ZuoraObservability
   # Global configuration that can be set in a Rails initializer
   class Configuration
-    attr_accessor :enable_metrics, :telegraf_endpoint, :telegraf_debug,
-                  :json_logging
+    attr_accessor :json_logging
 
     def initialize
-      @enable_metrics = false
-      @telegraf_endpoint = 'udp://telegraf-app-metrics.monitoring.svc.cluster.local:8094'
-      @telegraf_debug = 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?)

data/lib/zuora_observability/engine.rb

@@ -1,7 +1,5 @@
 # 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
@@ -22,12 +20,6 @@ module ZuoraObservability
       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'
 
@@ -42,7 +34,12 @@ module ZuoraObservability
         if Rails.configuration.logger.class.to_s == 'Ougai::Logger'
           Rails.configuration.lograge.formatter = Class.new do |fmt|
             def fmt.call(data)
-              { msg: 'Rails Request', request: data }
+              {
+                msg: 'Rails Request',
+                trace_id: data.delete(:trace_id),
+                zuora_trace_id: data.delete(:zuora_trace_id),
+                request: data
+              }.compact
             end
           end
         end
@@ -51,7 +48,9 @@ module ZuoraObservability
           exceptions = %w(controller action format)
           items = {
             #time: event.time.strftime('%FT%T.%6N'),
-            params: event.payload[:params].as_json(except: exceptions).to_json.to_s
+            params: event.payload[:params].as_json(except: exceptions).to_json.to_s,
+            trace_id: event.payload[:headers]['action_dispatch.request_id'],
+            zuora_trace_id: event.payload[:headers]['HTTP_ZUORA_REQUEST_ID']
           }
           items.merge!({exception_object: event.payload[:exception_object]}) if event.payload[:exception_object].present?
           items.merge!({exception: event.payload[:exception]}) if event.payload[:exception].present?

data/lib/zuora_observability/logger.rb

@@ -21,11 +21,6 @@ module ZuoraObservability
         if ZuoraObservability.configuration.json_logging
           require 'zuora_observability/logging/formatter'
           logger.formatter = ZuoraObservability::Logging::Formatter.new(name)
-          logger.before_log = lambda do |data|
-            data[:trace_id] = ZuoraConnect::RequestIdMiddleware.request_id if ZuoraConnect::RequestIdMiddleware.request_id.present?
-            data[:zuora_trace_id] = ZuoraConnect::RequestIdMiddleware.zuora_request_id if ZuoraConnect::RequestIdMiddleware.zuora_request_id.present?
-            #data[:traces] = {amazon_id: data[:trace_id], zuora_id: data[:zuora_trace_id]}
-          end
         else
           logger.formatter = Ougai::Formatters::Customizable.new(
             format_err: proc do |data|

data/lib/zuora_observability/metrics.rb

@@ -3,18 +3,7 @@
 module ZuoraObservability
   # Methods to gather and format metrics
   module Metrics
-    @@telegraf_host = nil
-
     class << self
-      def write_to_telegraf(*args)
-        if ZuoraObservability.configuration.enable_metrics && !defined?(Prometheus)
-          @@telegraf_host = Metrics::Telegraf.new() if @@telegraf_host == nil
-          unicorn_stats = Metrics.unicorn_listener if defined?(Unicorn) && Unicorn.respond_to?(:listener_names)
-          @@telegraf_host.write(direction: 'Raindrops', tags: {}, values: unicorn_stats)  unless unicorn_stats.blank?
-          return @@telegraf_host.write(*args)
-        end
-      end
-
       def resque
         Resque.redis.ping
 

data/lib/zuora_observability/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zuora_observability
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.b
+  version: 0.1.0.pre.c
 platform: ruby
 authors:
 - Hartley McGuire
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-03 00:00:00.000000000 Z
+date: 2021-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lograge
@@ -263,9 +263,6 @@ 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
 homepage: 
 licenses:

data/lib/zuora_observability/metrics/page_request.rb

@@ -1,35 +0,0 @@
-# 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/metrics/point_value.rb

@@ -1,84 +0,0 @@
-# this looks copied from https://github.com/influxdata/influxdb-ruby, it may be
-# worth just using the gem instead of vendoring the file
-# module InfluxDB
-module ZuoraObservability
-  module Metrics
-    # Convert data point to string using Line protocol
-    class PointValue
-      attr_reader :series, :values, :tags, :timestamp
-
-      def initialize(data)
-        @series    = escape data[:series], :measurement
-        @values    = escape_values data[:values]
-        @tags      = escape_tags data[:tags]
-        @timestamp = data[:timestamp]
-      end
-
-      def dump
-        dump =  @series.dup
-        dump << ",#{@tags}" if @tags
-        dump << " #{@values}"
-        dump << " #{@timestamp}" if @timestamp
-        dump
-      end
-
-      private
-
-      ESCAPES = {
-        measurement:  [' '.freeze, ','.freeze],
-        tag_key:      ['='.freeze, ' '.freeze, ','.freeze],
-        tag_value:    ['='.freeze, ' '.freeze, ','.freeze],
-        field_key:    ['='.freeze, ' '.freeze, ','.freeze, '"'.freeze],
-        field_value:  ["\\".freeze, '"'.freeze],
-      }.freeze
-
-      private_constant :ESCAPES
-
-      def escape(str, type)
-        # rubocop:disable Layout/AlignParameters
-        str = str.encode "UTF-8".freeze, "UTF-8".freeze,
-          invalid: :replace,
-          undef: :replace,
-          replace: "".freeze
-        # rubocop:enable Layout/AlignParameters
-
-        ESCAPES[type].each do |ch|
-          str = str.gsub(ch) { "\\#{ch}" }
-        end
-        str
-      end
-
-      def escape_values(values)
-        return if values.nil?
-        values.map do |k, v|
-          key = escape(k.to_s, :field_key)
-          val = escape_value(v)
-          "#{key}=#{val}"
-        end.join(",".freeze)
-      end
-
-      def escape_value(value)
-        if value.is_a?(String)
-          '"'.freeze + escape(value, :field_value) + '"'.freeze
-        elsif value.is_a?(Integer)
-          "#{value}i"
-        else
-          value.to_s
-        end
-      end
-
-      def escape_tags(tags)
-        return if tags.nil?
-
-        tags = tags.map do |k, v|
-          key = escape(k.to_s, :tag_key)
-          val = escape(v.to_s, :tag_value)
-
-          "#{key}=#{val}" unless key == "".freeze || val == "".freeze
-        end.compact
-
-        tags.join(",") unless tags.empty?
-      end
-    end
-  end
-end

data/lib/zuora_observability/metrics/telegraf.rb

@@ -1,98 +0,0 @@
-# frozen_string_literal: true
-
-module ZuoraObservability
-  module Metrics
-    # Functionality for sending metrics to a Telegraf endpoint
-    #
-    # it looks like https://github.com/influxdata/influxdb-ruby may provide some
-    # more high level abstractions instead of using a UDPSocket directly
-    class Telegraf
-      attr_accessor :host
-
-      OUTBOUND_METRICS = true
-      OUTBOUND_METRICS_NAME = 'request-outbound'
-      INBOUND_METRICS = true
-      INBOUND_METRICS_NAME = 'request-inbound'
-
-      def initialize
-        connect
-      end
-
-      def connect
-        # TODO(hartley): this Rails logger was originally ZuoraConnect.logger
-        Rails.logger.debug(format_metric_log('Telegraf', 'Need new connection')) if ZuoraObservability.configuration.telegraf_debug
-        uri = URI.parse(ZuoraObservability.configuration.telegraf_endpoint)
-        self.host = UDPSocket.new.tap do |socket|
-          socket.connect uri.host, uri.port
-        end
-      rescue => ex
-        self.host = nil
-        # TODO(hartley): this Rails logger was originally ZuoraConnect.logger
-        Rails.logger.warn(self.format_metric_log('Telegraf', "Failed to connect: #{ex.class}")) if Rails.env.to_s != 'production'
-      end
-
-      def write(direction: 'Unknown', tags: {}, values: {})
-        time = Benchmark.measure do
-          # To avoid writing metrics from rspec tests
-          if Rails.env.to_sym != :test
-            app_instance = Thread.current[:appinstance].present? ? Thread.current[:appinstance].id : 0
-            tags = {
-              app_name: Env.app_name, process_type: Env.process_type,
-              app_instance: app_instance, pod_name: Env.pod_name
-            }.merge(tags)
-
-            if direction == :inbound
-              # This condition relies on a monkey patch in the connect gem that
-              # adds a to_bool method for Nil, True, and False that are not
-              # present by default
-              if INBOUND_METRICS && !Thread.current[:inbound_metric].to_bool
-                self.write_udp(series: INBOUND_METRICS_NAME, tags: tags, values: values)
-                Thread.current[:inbound_metric] = true
-              else
-                return
-              end
-            elsif direction == :outbound
-              write_udp(series: OUTBOUND_METRICS_NAME, tags: tags, values: values) if OUTBOUND_METRICS
-            else
-              write_udp(series: direction, tags: tags, values: values)
-            end
-          end
-        end
-
-        return unless ZuoraObservability.configuration.telegraf_debug
-
-        # TODO(hartley): these Rails loggers were originally ZuoraConnect.logger
-        Rails.logger.debug(format_metric_log('Telegraf', tags.to_s))
-        Rails.logger.debug(format_metric_log('Telegraf', values.to_s))
-        Rails.logger.debug(
-          format_metric_log(
-            'Telegraf',
-            "Writing '#{direction.capitalize}': #{time.real.round(5)} ms"
-          )
-        )
-      end
-
-      def write_udp(series: '', tags: {}, values: {})
-        return if values.blank?
-
-        host.write PointValue.new({ series: series, tags: tags, values: values }).dump
-      rescue => ex
-        self.connect
-        ZuoraConnect.logger.warn(self.format_metric_log('Telegraf', "Failed to write udp: #{ex.class}")) if Rails.env.to_s != 'production'
-      end
-
-      def format_metric_log(message, dump = nil)
-        message_color = '1;91'
-        dump_color = '0;1'
-        log_entry = "  \e[#{message_color}m#{message}\e[0m   #{
-          "\e[#{dump_color}m#{dump}\e[0m" if dump
-        }"
-        if Rails.env.development?
-          log_entry
-        else
-          [message, dump].compact.join(' - ')
-        end
-      end
-    end
-  end
-end