zuora_connect 2.1.1 → 3.0.0.pre.a

data/lib/zuora_connect/engine.rb

@@ -10,9 +10,10 @@ module ZuoraConnect
 
     initializer "connect", before: :load_config_initializers do |app|
       Rails.application.routes.prepend do
+        get '/connect/internal/data' => 'zuora_observability/metrics#metrics'
         mount ZuoraConnect::Engine, at: "/connect"
         match '/api/connect/health', via: :all, to: 'zuora_connect/static#health'
-        match '/api/connect/internal/data', via: :all, to: 'zuora_connect/static#metrics'
+        match '/api/connect/internal/data', via: :all, to: 'zuora_observability/metrics#metrics'
       end
     end
 

data/lib/zuora_connect/railtie.rb

@@ -28,11 +28,6 @@ module ZuoraConnect
       ::Rails.configuration.action_dispatch.x_sendfile_header = nil
     end
 
-    if defined? Prometheus
-      initializer "prometheus.configure_rails_initialization" do |app|
-        app.middleware.use Prometheus::Middleware::Exporter,(options ={:path => '/connect/internal/metrics'})
-      end
-    end
     initializer "zuora_connect.configure_rails_initialization" do |app|
       app.middleware.insert_after Rack::Sendfile, ZuoraConnect::MetricsMiddleware
       app.middleware.insert_after ActionDispatch::RequestId, ZuoraConnect::RequestIdMiddleware
@@ -40,55 +35,16 @@ module ZuoraConnect
       app.config.middleware.use ZuoraConnect::JsonParseErrors
     end
 
-    # hook to process_action
-    ActiveSupport::Notifications.subscribe('process_action.action_controller', ZuoraConnect::PageRequest.new)
-
-    initializer(:rails_stdout_logging, before: :initialize_logger) do
-      require 'lograge'
-      
-      Rails.configuration.logger = ZuoraConnect.custom_logger(name: "Rails") 
-      if !Rails.env.test? && !Rails.env.development?
-        Rails.configuration.lograge.enabled = true
-        Rails.configuration.colorize_logging = false
-      end
-
-      if Rails.configuration.lograge.enabled
-        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 }
-            end
-          end
-        end
-        #Rails.configuration.lograge.formatter = Lograge::Formatters::Json.new
-        Rails.configuration.lograge.custom_options = lambda do |event|
-          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
-          }
-          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?
-
-          if event.payload[:headers].present?
-            # By convertion, headers usually do not have dots. Nginx even rejects headers with dots
-            # All Rails headers are namespaced, like 'rack.input'.
-            # Thus, we can obtain the client headers by rejecting dots
-            request_headers =
-              event.payload[:headers].env.
-                reject { |key| key.to_s.include?('.') || REQUEST_HEADERS_TO_IGNORE.include?(key.to_s) }
-            items.merge!({ headers: request_headers.to_s })
-          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
-          return items        
-        end
+    if defined? Prometheus
+      require 'rack'
+      require 'prometheus/middleware/exporter'
+      initializer "prometheus.configure_rails_initialization" do |app|
+        app.middleware.insert_after ZuoraConnect::MetricsMiddleware, Prometheus::Middleware::Exporter, path: '/connect/internal/metrics'
+        app.config.middleware.use Rack::Deflater, if: ->(env, *) { env['PATH_INFO'] == '/connect/internal/metrics' }
       end
     end
+
+    # hook to process_action
+    ActiveSupport::Notifications.subscribe('process_action.action_controller', ZuoraConnect::PageRequest.new)
   end
 end

data/lib/zuora_connect/version.rb

@@ -1,3 +1,3 @@
 module ZuoraConnect
-  VERSION = "2.1.1"
+  VERSION = "3.0.0-a"
 end

data/lib/zuora_connect/zuora_audit.rb

@@ -0,0 +1,31 @@
+# Added by @Vina
+# Description: This automatically stamp user created/updated the record for DataQuery Audit
+# Usage: add 'zuora_audit' to your model.rb that you would like to track
+
+module ZuoraConnect
+  module ZuoraAudit
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def zuora_audit
+        include ZuoraConnect::ZuoraAudit::ZuoraAuditInstanceMethods
+        before_create :set_created_by_id
+        before_update :set_updated_by_id
+      end
+    end
+
+    module ZuoraAuditInstanceMethods
+      def set_created_by_id
+        self.created_by_id = current_user_id if defined?(self.created_by_id)
+      end
+
+      def set_updated_by_id
+        self.updated_by_id = current_user_id if defined?(self.updated_by_id)
+      end
+
+      def current_user_id
+        return ZuoraConnect::ZuoraUser.current_user_id
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zuora_connect
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 3.0.0.pre.a
 platform: ruby
 authors:
 - Connect Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-18 00:00:00.000000000 Z
+date: 2020-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apartment
@@ -182,6 +182,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: zuora_observability
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -318,7 +332,6 @@ files:
 - app/models/zuora_connect/app_instance.rb
 - app/models/zuora_connect/app_instance_base.rb
 - app/models/zuora_connect/login.rb
-- app/models/zuora_connect/telegraf.rb
 - app/models/zuora_connect/zuora_user.rb
 - app/views/layouts/zuora_connect/application.html.erb
 - app/views/sql/refresh_aggregate_table.txt
@@ -353,8 +366,6 @@ files:
 - db/migrate/20190520232222_add_unique_index.rb
 - db/migrate/20190520232223_add_provisioning_fields.rb
 - db/migrate/20190520232224_add_environment_fields.rb
-- lib/logging/connect_formatter.rb
-- lib/metrics/influx/point_value.rb
 - lib/metrics/net.rb
 - lib/middleware/bad_multipart_form_data_sanitizer.rb
 - lib/middleware/json_parse_errors.rb
@@ -374,6 +385,7 @@ files:
 - lib/zuora_connect/exceptions.rb
 - lib/zuora_connect/railtie.rb
 - lib/zuora_connect/version.rb
+- lib/zuora_connect/zuora_audit.rb
 - test/controllers/zuora_connect/api/v1/app_instance_controller_test.rb
 - test/dummy/README.rdoc
 - test/dummy/Rakefile
@@ -429,9 +441,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: 

data/app/models/zuora_connect/telegraf.rb

@@ -1,97 +0,0 @@
-module ZuoraConnect
-  class Telegraf
-    attr_accessor :host
-
-    OUTBOUND_METRICS = true      
-    OUTBOUND_METRICS_NAME = "request-outbound"      
-    INBOUND_METRICS = true      
-    INBOUND_METRICS_NAME = "request-inbound"      
-
-    def initialize 
-      self.connect
-    end
-
-    def connect
-      ZuoraConnect.logger.debug(self.format_metric_log('Telegraf','Need new connection')) if ZuoraConnect.configuration.telegraf_debug
-      uri = URI.parse(ZuoraConnect.configuration.telegraf_endpoint)
-      self.host = UDPSocket.new.tap do |socket|
-        socket.connect uri.host, uri.port
-      end
-    rescue => ex
-      self.host = nil
-      ZuoraConnect.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 |bench|
-        # 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: self.class.app_name, process_type: self.class.process_type, app_instance: app_instance, pod_name: self.class.pod_name}.merge(tags)
-
-          if direction == :inbound
-            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
-            self.write_udp(series: OUTBOUND_METRICS_NAME, tags: tags, values: values) if OUTBOUND_METRICS
-          else
-            self.write_udp(series: direction, tags: tags, values: values)
-          end
-        end
-      end
-      if ZuoraConnect.configuration.telegraf_debug
-        ZuoraConnect.logger.debug(self.format_metric_log('Telegraf', tags.to_s))
-        ZuoraConnect.logger.debug(self.format_metric_log('Telegraf', values.to_s))
-        ZuoraConnect.logger.debug(self.format_metric_log('Telegraf', "Writing '#{direction.capitalize}': #{time.real.round(5)} ms"))
-      end
-    end
-
-
-    def write_udp(series: '', tags: {}, values: {})
-      return if !values.present?
-      self.host.write InfluxDB::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, dump_color = "1;91", "0;1"
-      log_entry = "  \e[#{message_color}m#{message}\e[0m   "
-      log_entry << "\e[#{dump_color}m%#{String === dump ? 's' : 'p'}\e[0m" % dump if dump
-      if Rails.env == :development
-        log_entry
-      else
-        [message, dump].compact.join(' - ')
-      end
-    end
-
-    def self.app_name
-      return ENV['DEIS_APP'].present? ? ENV['DEIS_APP'] : Rails.application.class.parent_name
-    end
-
-    def self.pod_name
-      return ENV['HOSTNAME'].present? ? ENV['HOSTNAME'] :  Socket.gethostname
-    end
-
-    def self.full_process_name(process_name: nil, function: nil)
-      keys = [self.pod_name, process_name.present? ? process_name : self.process_type, Process.pid, function]
-      return keys.compact.join('][').prepend('[').concat(']')
-    end
-
-    # Returns the process type if any
-    def self.process_type(default: 'Unknown')
-      p_type = default
-      if ENV['HOSTNAME'] && ENV['DEIS_APP']
-        temp = ENV['HOSTNAME'].split(ENV['DEIS_APP'])[1]
-        temp = temp.split(/(-[0-9a-zA-Z]{5})$/)[0] # remove the 5 char hash
-        p_type = temp[1, temp.rindex("-")-1]
-      end
-      return p_type
-    end
-  end
-end

data/lib/logging/connect_formatter.rb

@@ -1,44 +0,0 @@
-require 'ougai/formatters/base'
-require 'ougai/formatters/for_json'
-
-module Ougai
-  module Formatters
-    # A JSON formatter compatible with node-bunyan
-    class ConnectFormatter < Base
-      include ForJson
-
-      # Intialize a formatter
-      # @param [String] app_name application name (execution program name if nil)
-      # @param [String] hostname hostname (hostname if nil)
-      # @param [Hash] opts the initial values of attributes
-      # @option opts [String] :trace_indent (2) the value of trace_indent attribute
-      # @option opts [String] :trace_max_lines (100) the value of trace_max_lines attribute
-      # @option opts [String] :serialize_backtrace (true) the value of serialize_backtrace attribute
-      # @option opts [String] :jsonize (true) the value of jsonize attribute
-      # @option opts [String] :with_newline (true) the value of with_newline attribute
-      def initialize(app_name = nil, hostname = nil, opts = {})
-        aname, hname, opts = Base.parse_new_params([app_name, hostname, opts])
-        super(aname, hname, opts)
-        init_opts_for_json(opts)
-      end
-
-      def _call(severity, time, progname, data)
-        data.merge!({message: data.delete(:msg)})
-        if data[:timestamp].present?
-          time = data[:timestamp]
-          data.delete(:timestamp)
-        end
-        dump({
-          name: progname || @app_name,
-          pid: $$,
-          level: severity,
-          timestamp: time.utc.strftime('%FT%T.%6NZ'),
-        }.merge(data))
-      end
-
-      def convert_time(data)
-        #data[:timestamp] = format_datetime(data[:time])
-      end
-    end
-  end
-end

data/lib/metrics/influx/point_value.rb

@@ -1,79 +0,0 @@
-module InfluxDB
-  # 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