zuora_connect 2.0.59a → 2.0.60d

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a40ca87d7094e3f69418c9e339a61f3d89be11ca4e4d4c20df1cdca3c7a9af14
-  data.tar.gz: a30171ac13b845b3b9c2871af570564e5d1d0ae57e625809b4217d2dc0a4a2a5
+  metadata.gz: f68ca8630651e624313553f6799344c23c5e63b05ed6345a4fc1cc082ea62491
+  data.tar.gz: d3da0f0dfaadda7cd0ee62abfd413ceaa64c5e3869f9b131e543d86d538a1efc
 SHA512:
-  metadata.gz: 9cbfc416d448d4d800f4704361306e80d3033bc38e6128227725eb49c3d67ac27e05ef672fdf591b5919e3c27348f65ff6e1d05c5f38f8c27f42d68c7a2103a0
-  data.tar.gz: 6aa04b8bea5686529095e693db98be19839f36a48cab820f61145d6649571c212a1e10a659efc08cab61ee92053607ba003810c7e74ddb5ab9bebc5c0af3d87a
+  metadata.gz: '00539cc692ffa61e7b13c5dbbd7cc7b9a204f3fc8ebcec71247f56b46d8915a116f47c987d2cfa36102911bf2aeb6b9dff0034565c459b414a332521f6fd6bd9'
+  data.tar.gz: 1ed5cab4fdcf39c80981cfab2c75d071e9c4371ae74a82ef25e90721020667e8e5129f51760c5a92a530f630bb8e57b255d0caa18b39123a1a0bd5fe93acacd3

data/app/controllers/zuora_connect/static_controller.rb

@@ -1,11 +1,11 @@
 module ZuoraConnect
   class StaticController < ApplicationController
-    before_action :authenticate_connect_app_request, :except => [:metrics, :health, :initialize_app, :provision]
-    before_action :clear_connect_app_session,        :only =>   [:metrics, :health, :initialize_app, :provision]
-    after_action :persist_connect_app_session,       :except => [:metrics, :health, :initialize_app, :provision]
+    before_action :authenticate_connect_app_request, :except => [:metrics, :health, :initialize_app, :provision, :instance_user]
+    before_action :clear_connect_app_session,        :only =>   [:metrics, :health, :initialize_app, :provision, :instance_user]
+    after_action :persist_connect_app_session,       :except => [:metrics, :health, :initialize_app, :provision, :instance_user]
 
     skip_before_action :verify_authenticity_token, :only => [:initialize_app, :provision]
-    http_basic_authenticate_with name: ENV['PROVISION_USER'], password: ENV['PROVISION_SECRET'], :only => [:provision]
+    http_basic_authenticate_with name: ENV['PROVISION_USER'], password: ENV['PROVISION_SECRET'], :only => [:provision, :instance_user]
 
     def metrics
       type = params[:type].present? ? params[:type] : "versions"
@@ -14,11 +14,11 @@ module ZuoraConnect
 
     def health
       if params[:error].present?
-        begin 
+        begin
           raise ZuoraConnect::Exceptions::Error.new('This is an error')
         rescue => ex
           case params[:error]
-          when 'Log'  
+          when 'Log'
             Rails.logger.error("Error in Health", ex)
           when 'Exception'
             raise
@@ -77,6 +77,52 @@ module ZuoraConnect
       end
     end
 
+    def instance_user
+      ZuoraConnect::AppInstance.read_master_db do
+        ZuoraConnect.logger.with_fields = {} if ZuoraConnect.logger.is_a?(Ougai::Logger)
+        Rails.logger.with_fields = {} if Rails.logger.is_a?(Ougai::Logger)
+
+        if defined?(ElasticAPM) && ElasticAPM.running? && ElasticAPM.respond_to?(:set_label)
+          ElasticAPM.set_label(:trace_id, request.uuid)
+        end
+
+        unless params[:id].present?
+          render json: {
+            status: 400,
+            message: 'No app instance id provided'
+          }, status: :bad_request
+          return
+        end
+
+        @appinstance = ZuoraConnect::AppInstance.find(params[:id]).new_session
+      end
+
+      zuora_client = @appinstance.send(ZuoraConnect::AppInstance::LOGIN_TENANT_DESTINATION).client
+      client_describe, = zuora_client.rest_call(
+        url: zuora_client.rest_endpoint('genesis/user/info').gsub('v1/', ''),
+        session_type: zuora_client.class == ZuoraAPI::Oauth ? :bearer : :basic
+      )
+
+      render json: {
+        status: 200,
+        message: 'Success',
+        user_id: client_describe['coreUserId'],
+        username: client_describe['username'],
+        email: client_describe['workEmail']
+      }, status: 200
+    rescue ActiveRecord::RecordNotFound
+      render json: {
+        status: 400,
+        message: 'No app instance found'
+      }, status: :bad_request
+    rescue StandardError => e
+      Rails.logger.error('Error occurred getting user details', e)
+      render json: {
+        status: 500,
+        message: 'Failed to get user details'
+      }, status: 500
+    end
+
     private
 
     def clear_connect_app_session

data/app/models/zuora_connect/app_instance_base.rb

@@ -402,7 +402,7 @@ module ZuoraConnect
       end
 
       def self.write_to_telegraf(*args)
-        if ZuoraConnect.configuration.enable_metrics
+        if ZuoraConnect.configuration.enable_metrics && !defined?(Prometheus)
           @@telegraf_host = ZuoraConnect::Telegraf.new() if @@telegraf_host == nil
           unicorn_stats = self.unicorn_listener_stats() if defined?(Unicorn) && Unicorn.respond_to?(:listener_names)
           @@telegraf_host.write(direction: 'Raindrops', tags: {}, values: unicorn_stats)  unless unicorn_stats.blank?

data/config/initializers/prometheus.rb

@@ -3,38 +3,93 @@ if defined? Prometheus
     require "zuora_connect/version"
     require "zuora_api/version"
 
+    resque_path = "#{ENV['RESQUE_EXPORTER_PATH'] || Rails.root.join('tmp/resque_exporter')}/*.prom"
+    prometheus_path = Rails.root.join("tmp/prometheus")
+
+    Dir[resque_path, "#{prometheus_path}/*.bin"].each do |file_path|
+      File.unlink(file_path)
+    end
+
+    require 'prometheus/client/data_stores/direct_file_store'
+    Prometheus::Client.config.data_store = Prometheus::Client::DataStores::DirectFileStore.new(
+      dir: prometheus_path
+    )
+
+    class ResqueExporter
+      require 'prometheus/client/formats/text'
+      require 'fileutils'
+
+      def initialize
+        @lock = Monitor.new
+        @registry = Prometheus::Client.registry
+        @path = ENV['RESQUE_EXPORTER_PATH'] || Rails.root.join('tmp/resque_exporter')
+        FileUtils.mkdir_p(@path)
+      end
+
+      def export
+        filename = File.join(@path, 'resque_export.prom')
+        @lock.synchronize do
+          File.open(filename, 'w+') do |file|
+            file.write(Prometheus::Client::Formats::Text.marshal(@registry))
+          end
+        end
+      end
+    end
+
+    most_recent_aggregation = {}
+    sum_aggregation = {}
+    if defined?(Unicorn)
+      most_recent_aggregation[:aggregation] = :most_recent
+      sum_aggregation[:aggregation] = :sum
+    end
+
     # Create a default Prometheus registry for our metrics.
     prometheus = Prometheus::Client.registry
 
     # Create your metrics.
-    ZUORA_VERSION = Prometheus::Client::Gauge.new(:zuora_version, 'The current Zuora Gem version.')
-    CONNECT_VERSION = Prometheus::Client::Gauge.new(:gem_version, 'The current Connect Gem version.')
-    RAILS_VERSION = Prometheus::Client::Gauge.new(:rails_version, 'The current Rails version.')
-    RUBY_V = Prometheus::Client::Gauge.new(:ruby_version, 'The current Ruby version.')
+    ZUORA_VERSION = prometheus.gauge(:zuora_version, docstring: 'The current Zuora Gem version.', labels: %i(version name),  preset_labels: { version: ZuoraAPI::VERSION, name: ZuoraConnect::Telegraf.app_name }, store_settings: most_recent_aggregation)
+    CONNECT_VERSION = prometheus.gauge(:gem_version, docstring: 'The current Connect Gem version.', labels: %i(version name), preset_labels: { version: ZuoraConnect::VERSION, name: ZuoraConnect::Telegraf.app_name }, store_settings: most_recent_aggregation)
+    RAILS_VERSION = prometheus.gauge(:rails_version, docstring: 'The current Rails version.', labels: %i(version name), preset_labels: { version: Rails.version, name: ZuoraConnect::Telegraf.app_name }, store_settings: most_recent_aggregation)
+    RUBY_V = prometheus.gauge(:ruby_version, docstring: 'The current Ruby version.', labels: %i(version name), preset_labels: { version: RUBY_VERSION, name: ZuoraConnect::Telegraf.app_name }, store_settings: most_recent_aggregation)
 
-    # Register your metrics with the registry we previously created.
-    prometheus.register(ZUORA_VERSION);ZUORA_VERSION.set({version: ZuoraAPI::VERSION, name: ZuoraConnect::Telegraf.app_name},0)
-    prometheus.register(CONNECT_VERSION);CONNECT_VERSION.set({version: ZuoraConnect::VERSION, name: ZuoraConnect::Telegraf.app_name},0)
-    prometheus.register(RAILS_VERSION);RAILS_VERSION.set({version: Rails.version, name: ZuoraConnect::Telegraf.app_name},0)
-    prometheus.register(RUBY_V);RUBY_V.set({version: RUBY_VERSION, name: ZuoraConnect::Telegraf.app_name},0)
+    ZUORA_VERSION.set(0)
+    CONNECT_VERSION.set(0)
+    RAILS_VERSION.set(0)
+    RUBY_V.set(0)
 
     # Do they have resque jobs?
     if defined? Resque.redis
-      REDIS_CONNECTION = Prometheus::Client::Gauge.new(:redis_connection, 'The status of the redis connection, 0 or 1')
-      FINISHED_JOBS = Prometheus::Client::Gauge.new(:finished_jobs, 'Done resque jobs')
-      WORKERS = Prometheus::Client::Gauge.new(:workers, 'Total resque workers')
-      ACTIVE_WORKERS = Prometheus::Client::Gauge.new(:active_workers, 'Active resque workers')
-      FAILED_JOBS = Prometheus::Client::Gauge.new(:failed_jobs, 'Failed resque jobs')
-      PENDING_JOBS = Prometheus::Client::Gauge.new(:pending_jobs, 'Pending resque jobs')
-
-      prometheus.register(REDIS_CONNECTION)
-      prometheus.register(FINISHED_JOBS)
-      prometheus.register(ACTIVE_WORKERS)
-      prometheus.register(WORKERS)
-      prometheus.register(FAILED_JOBS)
-      prometheus.register(PENDING_JOBS)
-
+      REDIS_CONNECTION = prometheus.gauge(:redis_connection, docstring: 'The status of the redis connection, 0 or 1', labels: %i(connection name), preset_labels: {connection:'redis', name: ZuoraConnect::Telegraf.app_name}, store_settings: most_recent_aggregation)
+      JOBS_FINISHED = prometheus.gauge(:jobs_finished, docstring: 'Done resque jobs', labels: %i(type name), preset_labels: {type:'resque', name: ZuoraConnect::Telegraf.app_name}, store_settings: most_recent_aggregation)
+      WORKERS_TOTAL = prometheus.gauge(:workers_total, docstring: 'Total resque workers', labels: %i(type name), preset_labels: {type:'resque', name: ZuoraConnect::Telegraf.app_name}, store_settings: most_recent_aggregation)
+      WORKERS_ACTIVE = prometheus.gauge(:workers_active, docstring: 'Active resque workers', labels: %i(type name), preset_labels: {type:'resque', name: ZuoraConnect::Telegraf.app_name}, store_settings: most_recent_aggregation)
+      JOBS_FAILED = prometheus.gauge(:jobs_failed, docstring: 'Failed resque jobs', labels: %i(type name), preset_labels: {type:'resque', name: ZuoraConnect::Telegraf.app_name}, store_settings: most_recent_aggregation)
+      JOBS_PENDING = prometheus.gauge(:jobs_pending, docstring: 'Pending resque jobs', labels: %i(type name), preset_labels: {type:'resque', name: ZuoraConnect::Telegraf.app_name}, store_settings: most_recent_aggregation)
     end
 
+    if defined?(Unicorn) && Unicorn.respond_to?(:listener_names)
+      UNICORN_KILLS = prometheus.gauge(
+        :unicorn_kills,
+        docstring: 'Unicorn Kills',
+        labels: %i(type name),
+        preset_labels: {type:'Unicorn-Killer', name: ZuoraConnect::Telegraf.app_name},
+        store_settings: sum_aggregation
+      )
+
+      ZuoraConnect::AppInstanceBase.unicorn_listener_stats.each do |key, _|
+        gauge_name = "unicorn_#{key}".gsub(/[^a-zA-Z0-9_]/, '_')
+        gauge = prometheus.gauge(
+          gauge_name.to_sym,
+          docstring: 'Unicorn Stats',
+          labels: %i(type name),
+          preset_labels: { type: 'unicorn', name: ZuoraConnect::Telegraf.app_name },
+          store_settings: most_recent_aggregation
+        )
+        Prometheus.const_set(
+          gauge_name.upcase,
+          gauge
+        )
+      end
+    end
   end
 end

data/config/initializers/resque.rb

@@ -5,6 +5,20 @@ if defined?(Resque::Worker)
   Resque::Job.send(:include, Resque::SelfLookup)
 end
 
+if defined?(Resque::Job) && defined?(Prometheus)
+  module ResquePrometheusExtensions
+    EXPORTER = Prometheus::ResqueExporter.new
+    def perform
+      super
+      EXPORTER.export
+    end
+  end
+
+  class Resque::Job
+    prepend ResquePrometheusExtensions
+  end
+end
+
 Resque.module_eval do
   # Returns a hash, mapping queue names to queue sizes
   def queue_sizes

data/config/initializers/unicorn.rb

@@ -3,7 +3,35 @@ if defined?(Unicorn::WorkerKiller)
     self.singleton_class.send(:alias_method, :kill_self_old, :kill_self)
     def self.kill_self(logger, start_time)
       self.kill_self_old(logger, start_time)
-      ZuoraConnect::AppInstance.write_to_telegraf(direction: 'Unicorn-Killer', tags: {app_instance: 0}, values: {kill: 1})
+      if defined?(Prometheus)
+        Prometheus::UNICORN_KILLS.set(1)
+      else
+        ZuoraConnect::AppInstance.write_to_telegraf(direction: 'Unicorn-Killer', tags: {app_instance: 0}, values: {kill: 1})
+      end
     end
   end
+end
+
+if defined?(Unicorn::HttpServer) && defined?(Prometheus)
+  module HttpServerExtensions
+    def kill_worker(signal, wpid)
+      Prometheus::UNICORN_KILLS.increment
+      super
+    end
+  end
+
+  module WorkerExtensions
+    def soft_kill(sig)
+      Prometheus::UNICORN_KILLS.increment
+      super
+    end
+  end
+
+  class Unicorn::HttpServer
+    prepend HttpServerExtensions
+  end
+
+  class Unicorn::Worker
+    prepend WorkerExtensions
+  end
 end

data/config/routes.rb

@@ -5,6 +5,7 @@ ZuoraConnect::Engine.routes.draw do
 
   if ENV['PROVISION_USER'].present? && ENV['PROVISION_SECRET'].present?
     post '/provision' => 'static#provision'
+    get '/instance/:id/user' => 'static#instance_user'
   end
 
   namespace :api do

data/lib/middleware/json_parse_errors.rb

@@ -7,7 +7,7 @@ module ZuoraConnect
     def call(env)
       begin
         @app.call(env)
-      rescue ActionDispatch::ParamsParser::ParseError => error
+      rescue DynamicRailsError => error
         if env['HTTP_ACCEPT'] =~ /application\/json/ || env['CONTENT_TYPE'] =~ /application\/json/
           return [
             400, { "Content-Type" => "application/json" },
@@ -18,5 +18,16 @@ module ZuoraConnect
         end
       end
     end
+
+    # Note(hartley): remove once the minimum supported version of Rails is 5.2
+    class DynamicRailsError < StandardError
+      def self.===(exception)
+        if Rails.version >= "5.2"
+          exception.is_a?(ActionDispatch::Http::Parameters::ParseError)
+        else
+          exception.is_a?(ActionDispatch::ParamsParser::ParseError)
+        end
+      end
+    end
   end
-end
+end

data/lib/middleware/metrics_middleware.rb

@@ -64,6 +64,22 @@ module ZuoraConnect
         #Remove bad headers
         @bad_headers.each { |header| env.delete(header) }
 
+        if defined?(Prometheus) && env['PATH_INFO'] == '/connect/internal/metrics'
+          # Prometheus Stuff
+          metrics = ZuoraConnect::AppInstance.get_metrics('stats')
+          redis_up = metrics.present? && metrics.dig(:Resque, :Workers_Total).present? ? 1 : 0
+          Prometheus::REDIS_CONNECTION.set(redis_up)
+
+          process_prometheus_metric(metrics: metrics)
+
+          if defined?(Unicorn) && Unicorn.respond_to?(:listener_names)
+            ZuoraConnect::AppInstanceBase.unicorn_listener_stats.each do |key, value|
+              gauge = Prometheus.const_get("unicorn_#{key}".gsub(/[^a-zA-Z0-9_]/, '_').upcase)
+              gauge.set(value) if gauge.present?
+            end
+          end
+        end
+
         #Thread.current[:appinstance] = nil
         start_time = Time.now
         begin
@@ -77,35 +93,6 @@ module ZuoraConnect
             ZuoraConnect::AppInstanceBase.write_to_telegraf(direction: 'request-inbound-assets', tags: tags, values: values)
           end
 
-          if defined? Prometheus
-            #Prometheus Stuff
-            if env['PATH_INFO'] == '/connect/internal/metrics'
-
-              #Do something before each scrape
-              if defined? Resque.redis
-                begin
-
-                  Resque.redis.ping
-
-                  Prometheus::REDIS_CONNECTION.set({connection:'redis',name: ZuoraConnect::Telegraf.app_name},1)
-                  Prometheus::FINISHED_JOBS.set({type:'resque',name: ZuoraConnect::Telegraf.app_name},Resque.info[:processed])
-                  Prometheus::PENDING_JOBS.set({type:'resque',name: ZuoraConnect::Telegraf.app_name},Resque.info[:pending])
-                  Prometheus::ACTIVE_WORKERS.set({type:'resque',name: ZuoraConnect::Telegraf.app_name},Resque.info[:working])
-                  Prometheus::WORKERS.set({type:'resque',name: ZuoraConnect::Telegraf.app_name},Resque.info[:workers])
-                  Prometheus::FAILED_JOBS.set({type:'resque',name: ZuoraConnect::Telegraf.app_name},Resque.info[:failed])
-
-                rescue Redis::CannotConnectError
-                    Prometheus::REDIS_CONNECTION.set({connection:'redis',name: ZuoraConnect::Telegraf.app_name},0)
-                end
-
-                if ZuoraConnect.configuration.custom_prometheus_update_block != nil
-                  ZuoraConnect.configuration.custom_prometheus_update_block.call()
-                end
-              end
-
-            end
-          end
-
           # Uncomment following block of code for handling engine requests/requests without controller
           # else
           #   # Handling requests which do not have controllers (engines)
@@ -119,10 +106,10 @@ module ZuoraConnect
               content_type = @headers['Content-Type'].split(';')[0] if @headers['Content-Type']
               content_type = content_type.gsub('text/javascript', 'application/javascript')
               tags = {status: @status, content_type: content_type}
-           
+
               tags = tags.merge({controller: 'ActionController'})
               tags = tags.merge({action: 'RoutingError' }) if @status == 404
-              
+
               values = {response_time: ((Time.now - start_time)*1000).round(2) }
 
               ZuoraConnect::AppInstanceBase.write_to_telegraf(direction: :inbound, tags: tags, values: values)
@@ -133,5 +120,32 @@ module ZuoraConnect
         [@status, @headers, @response]
       end
     end
+
+    def process_prometheus_metric(type: 'none', metrics: {})
+      return if metrics.blank?
+
+      prometheus = Prometheus::Client.registry
+      most_recent_aggregation = {}
+      if Prometheus::Client.config.data_store.is_a?(Prometheus::Client::DataStores::DirectFileStore)
+        most_recent_aggregation[:aggregation] = :most_recent
+      end
+      metrics.each do |key, value|
+        next if %w[app_name url].include?(key.to_s)
+
+        if value.is_a?(Hash)
+          process_prometheus_metric(type: key.to_s, metrics: value)
+        else
+          gauge_name = key.to_s.downcase.gsub(/[^a-z0-9_]/, '_')
+          gauge = prometheus.get(gauge_name.to_sym) || prometheus.gauge(
+            gauge_name.to_sym,
+            docstring: "#{key} metric",
+            labels: %i(type name),
+            preset_labels: { type: type, name: ZuoraConnect::Telegraf.app_name },
+            store_settings: most_recent_aggregation
+          )
+          gauge.set(value)
+        end
+      end
+    end
   end
 end

data/lib/resque/plugins/app_instance_job.rb

@@ -47,7 +47,7 @@ module Resque
             raise
           end
         rescue PG::ConnectionBad => exception
-          Rails.logger.info("Bad Connection Restart")
+          Rails.logger.warn("Bad Connection Restart", exception)
           Resque.enqueue_to(self.job.queue, self.job.payload['class'], args)
           return
         rescue ZuoraConnect::Exceptions::ConnectCommunicationError => exception

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,6 +35,15 @@ module ZuoraConnect
       app.config.middleware.use ZuoraConnect::JsonParseErrors
     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)
 

data/lib/zuora_connect/version.rb

@@ -1,3 +1,3 @@
 module ZuoraConnect
-  VERSION = "2.0.59a"
+  VERSION = "2.0.60d"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zuora_connect
 version: !ruby/object:Gem::Version
-  version: 2.0.59a
+  version: 2.0.60d
 platform: ruby
 authors:
 - Connect Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2020-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apartment