zuora_connect 1.5.40a → 1.5.40b

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e915f67ad5993527d65b4e4c115ea8dc6f34894
-  data.tar.gz: b6b098aa03fb13fbe8a05da49bdf97446f82b15b
+  metadata.gz: e18846dd3a100492259458122d7a58e1f62ad595
+  data.tar.gz: ea40c59fc3814fef76e4279c76ea9a0fbe651fcb
 SHA512:
-  metadata.gz: 697525f9ca8900e9248af96adbfd3829d5dd1ccec432178a0efb38ff0381f6f4dec20dd7e3b28ba26a389bec3d8df7f3df77faa192d96c5ade7b3321156644e4
-  data.tar.gz: 9457e97af890e84d393e6b18d554601ec5325df5ab4ba18d1398ad596742f2e62ec909299087316569d987bbeb3636f90a601ec70d7862e6d032154816d30418
+  metadata.gz: 6432f6f921abfa602136fd176af03fb750cc611538881ca3cb241568103a00e7ad3b3498bf66edae33d5616f85bc376824fa51d1482c3c90ce43669e88c01ceb
+  data.tar.gz: f537619bd058bfe29040d7bfbf7ef89e95eea34dc640ac929d95722909b3df632a017d0a0ea2be66889115a39bddfe156403267e74f993a3a8f0764d04b04a27

data/app/controllers/zuora_connect/static_controller.rb

@@ -2,6 +2,7 @@ module ZuoraConnect
   class StaticController < ApplicationController
     before_filter :authenticate_connect_app_request, :except => [:health, :session_error, :invalid_app_instance_error]
     after_filter :persist_connect_app_session,  :except => [:health, :session_error, :invalid_app_instance_error]
+    
     def session_error
       respond_to do |format|
         format.html
@@ -22,5 +23,6 @@ module ZuoraConnect
         status: 200
       }, status: 200
     end
+
   end
 end

data/app/models/zuora_connect/app_instance_base.rb

@@ -24,6 +24,21 @@ module ZuoraConnect
       self.apartment_switch(nil, true)
     end
 
+
+    # method for writing outbound metrics
+
+    def telegraf_time(endpoint_name: nil, &block)
+
+      response_time = Benchmark.realtime(&block)
+      p_type = Middleware::get_process_type
+
+      ZuoraConnect.configuration.telegraf_client.write(ZuoraConnect.configuration.app_name_outbound,
+          tags: {endpoint: endpoint_name, instance_id: self.id, process_type: p_type},
+          values: {response_time: response_time, caller: block.source_location[0]})
+    end
+
+
+
     def apartment_switch(method = nil, migrate = false)
       begin
         Apartment::Tenant.switch!(self.id) if self.persisted?
@@ -744,6 +759,7 @@ module ZuoraConnect
       super
     end
 
+
     method_hook :refresh, :updateOption, :update_logins, :before => :check_oauth_state
     method_hook :new_session, :refresh, :build_task, :after => :apartment_switch
   end

data/config/initializers/prometheus.rb

@@ -0,0 +1,39 @@
+module Prometheus
+  require "zuora_connect/version"
+  require "zuora_api/version"
+
+  app_name = ENV['DEIS_APP'].present? ? "#{ENV['DEIS_APP']}" : "#{Rails.application.class.parent_name}"
+  # 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.')
+
+  # Register your metrics with the registry we previously created.
+  prometheus.register(ZUORA_VERSION);ZUORA_VERSION.set({version:ZuoraAPI::VERSION,name:app_name},0)
+  prometheus.register(CONNECT_VERSION);CONNECT_VERSION.set({version:ZuoraConnect::VERSION,name:app_name},0)
+  prometheus.register(RAILS_VERSION);RAILS_VERSION.set({version:Rails.version,name:app_name},0)
+  prometheus.register(RUBY_V);RUBY_V.set({version:RUBY_VERSION,name:app_name},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)
+
+  end
+
+end

data/lib/middleware/metrics_middleware.rb

@@ -0,0 +1,130 @@
+module Middleware
+  require 'uri'
+
+  # Returns the process type if any
+  def self.get_process_type
+    p_type = nil
+    if ENV['HOSTNAME']
+      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
+
+
+  # Write to telegraf
+  def self.write_to_telegraf(endpoint_name: nil, method_name: nil, status_code: nil, response_time: nil, db_runtime: nil, view_runtime: nil, content_type: nil)
+
+    # Getting the process type
+    p_type = Middleware::get_process_type
+
+    # Separately handling 200 and non 200 as influx does not accept nil as a value
+    if db_runtime && view_runtime
+      # 200 requests
+      ZuoraConnect.configuration.telegraf_client.write(ZuoraConnect.configuration.app_name_inbound,
+          tags: {endpoint: endpoint_name, "content-type": content_type, method: method_name, status: status_code, process_type: p_type},
+          values: {response_time: response_time, db_time: db_runtime, view_time: view_runtime})
+    else
+      # non 200 requests
+      ZuoraConnect.configuration.telegraf_client.write(ZuoraConnect.configuration.app_name_inbound,
+          tags: {endpoint: endpoint_name, "content-type": content_type, method: method_name, status: status_code, process_type: p_type},
+          values: {response_time: response_time})
+    end
+    
+  end
+
+
+  # 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, 500)
+    def call(name, started, finished, unique_id, payload)
+
+      # If the url contains any css or JavaScript files then do not collect metrics for them
+      block_words = ["css", "assets", "jpg", "png", "jpeg", "ico"]
+      if block_words.any? { |word| payload[:path].include?(word) }
+        return nil
+      end
+
+      # Getting the endpoint and the content_type
+      request_path = URI(payload[:headers]['REQUEST_URI']).path.split(".")[0]
+      content_type = ((payload[:headers]["action_controller.instance"].instance_variable_get :@_response).instance_variable_get :@header)["Content-Type"]
+      content_type = content_type.split(";")[0]
+
+      response_time = finished-started
+
+      # Write to telegraf
+      Middleware.write_to_telegraf("endpoint_name": request_path, "method_name": payload[:method], "status_code": payload[:status], "response_time": response_time, "db_runtime": payload[:db_runtime], "view_runtime": payload[:view_runtime], "content_type": content_type)
+
+    end
+  end
+
+
+  class MetricsMiddleware
+
+    require "zuora_connect/version"
+    require "zuora_api/version"
+    require "telegraf"
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      start_time = Time.now
+      @status, @headers, @response = @app.call(env)
+
+      # If the url contains any CSS or JavaScript files then do not collect metrics for them
+      block_words = ["css", "assets", "jpg", "png", "jpeg", "ico"]
+      if block_words.any? { |word| env['PATH_INFO'].include?(word) }
+        return [@status, @headers, @response]
+      end
+
+      end_time = Time.now
+      response_time = end_time - start_time
+
+      #Prometheus Stuff
+      if env['PATH_INFO'] == '/connect/internal/metrics'
+
+        #Do something before each scrape
+        if defined? Resque.redis
+
+          app_name = ENV['DEIS_APP'].present? ? "#{ENV['DEIS_APP']}" : "#{Rails.application.class.parent_name}"
+          begin
+
+            Resque.redis.ping
+
+            Prometheus::REDIS_CONNECTION.set({connection:'redis',name:app_name},1)
+            Prometheus::FINISHED_JOBS.set({type:'resque',name:app_name},Resque.info[:processed])
+            Prometheus::PENDING_JOBS.set({type:'resque',name:app_name},Resque.info[:pending])
+            Prometheus::ACTIVE_WORKERS.set({type:'resque',name:app_name},Resque.info[:working])
+            Prometheus::WORKERS.set({type:'resque',name:app_name},Resque.info[:workers])
+            Prometheus::FAILED_JOBS.set({type:'resque',name:app_name},Resque.info[:failed])
+
+          rescue Redis::CannotConnectError
+              Prometheus::REDIS_CONNECTION.set({connection:'redis',name:app_name},0)
+          end
+
+          if ZuoraConnect.configuration.custom_prometheus_update_block != nil
+            ZuoraConnect.configuration.custom_prometheus_update_block.call()
+          end
+        end
+
+      end
+
+      # Writing to telegraf: Handle 404 and 500 requests
+      if @status != 200
+        # Getting the endpoint and content_type
+        request_path = URI(env['REQUEST_URI']).path.split(".")[0]
+        content_type = @headers['Content-Type'].split(';')[0] if @headers['Content-Type']
+        Middleware::write_to_telegraf("endpoint_name": request_path, "method_name": env['REQUEST_METHOD'], "status_code": @status, "response_time": response_time,  "content_type": content_type)
+      end
+
+      [@status, @headers, @response]
+
+    end
+
+  end
+
+end

data/lib/zuora_connect.rb

@@ -4,9 +4,11 @@ require 'zuora_connect/exceptions'
 require 'zuora_connect/controllers/helpers'
 require 'zuora_connect/views/helpers'
 require 'zuora_connect/railtie'
-require 'resque/additions' 
+require 'resque/additions'
 require 'resque/dynamic_queues'
 require 'resque/self_lookup'
+require 'prometheus/client'
+
 
 module ZuoraConnect
   class << self

data/lib/zuora_connect/configuration.rb

@@ -1,6 +1,6 @@
 module ZuoraConnect
   class Configuration
-    attr_accessor :oauth_client_id, :oauth_client_secret, :oauth_client_redirect_uri,:use_s3, :default_locale,:dev_mode_appinstance ,:dev_mode_admin, :dev_mode_user, :dev_mode_pass, :default_time_zone,:delayed_job,:url, :private_key, :dev_mode_logins,:dev_mode_mode, :dev_mode_options, :mode, :timeout,:dev_mode_secret_access_key,:dev_mode_access_key_id,:aws_region, :s3_bucket_name, :s3_folder_name, :additional_apartment_models
+    attr_accessor :oauth_client_id, :oauth_client_secret, :oauth_client_redirect_uri,:use_s3, :default_locale,:dev_mode_appinstance ,:dev_mode_admin, :dev_mode_user, :dev_mode_pass, :default_time_zone,:delayed_job,:url, :private_key, :dev_mode_logins,:dev_mode_mode, :dev_mode_options, :mode, :timeout,:dev_mode_secret_access_key,:dev_mode_access_key_id,:aws_region, :s3_bucket_name, :s3_folder_name, :additional_apartment_models, :telegraf_endpoint, :enable_metrics_flag, :telegraf_client, :custom_prometheus_update_block, :app_name_inbound, :app_name_outbound
 
     def initialize
       @default_locale = :en
@@ -11,6 +11,15 @@ module ZuoraConnect
       @use_s3 = false
       @private_key = ENV["CONNECT_KEY"]
       @additional_apartment_models = []
+      # telegraf_endpoints: select based on which daemonset to use
+      @telegraf_endpoint = 'udp://telegraf-ds.deis.svc.cluster.local:8094'
+      # @telegraf_endpoint = 'udp://deis-monitor-telegraf.deis.svc.cluster.local:8094'
+      @enable_metrics_flag =  true
+      @telegraf_client = Telegraf::Agent.new @telegraf_endpoint
+
+      # Setting the app name for telegraf write
+      @app_name_inbound = ENV['DEIS_APP'].present? ? "#{ENV['DEIS_APP']}-inbound" : "#{Rails.application.class.parent_name}-inbound"
+      @app_name_outbound = ENV['DEIS_APP'].present? ? "#{ENV['DEIS_APP']}-outbound" : "#{Rails.application.class.parent_name}-outbound"
 
       # OAuth Settings
       @oauth_client_id = ""
@@ -30,6 +39,10 @@ module ZuoraConnect
       @aws_region = "us-west-2"
       @s3_bucket_name = "rbm-apps"
       @s3_folder_name = Rails.application.class.parent_name
+
+      #Prometheus
+      @custom_prometheus_update_block = nil
+
     end
 
     def private_key

data/lib/zuora_connect/controllers/helpers.rb

@@ -1,9 +1,12 @@
 require 'apartment/migrator'
+require 'benchmark'
+
 module ZuoraConnect
   module Controllers
     module Helpers
       extend ActiveSupport::Concern
 
+
       def authenticate_app_api_request
         #Skip session for api requests
         Thread.current[:appinstance] = nil
@@ -36,14 +39,14 @@ module ZuoraConnect
         else
           setup_instance_via_dev_mode
         end
-        #Call .data_lookup with the current session to retrieve session. In some cases session may be stored/cache in redis 
+        #Call .data_lookup with the current session to retrieve session. In some cases session may be stored/cache in redis
         #so data lookup provides a model method that can be overriden per app.
         if params[:controller] != 'zuora_connect/api/v1/app_instance' && params[:action] != 'drop'
           if @appinstance.new_session_for_ui_requests(:params => params)
             @appinstance.new_session(:session => @appinstance.data_lookup(:session => session))
           end
         end
-        PaperTrail.whodunnit =  session["#{@appinstance.id}::user::email"] if defined?(PaperTrail) && session["#{@appinstance.id}::user::email"].present? 
+        PaperTrail.whodunnit =  session["#{@appinstance.id}::user::email"] if defined?(PaperTrail) && session["#{@appinstance.id}::user::email"].present?
         begin
           I18n.locale = session["#{@appinstance.id}::user::locale"] ?  session["#{@appinstance.id}::user::locale"] : @appinstance.locale
         rescue I18n::InvalidLocale => ex
@@ -112,7 +115,7 @@ module ZuoraConnect
           else
             raise ZuoraConnect::Exceptions::AccessDenied.new("Authorization mistmatch. Possible tampering")
           end
-        end     
+        end
       end
 
       def setup_instance_via_session

data/lib/zuora_connect/railtie.rb

@@ -1,5 +1,10 @@
+require 'middleware/metrics_middleware'
+
 module ZuoraConnect
   class Railtie < Rails::Railtie
+    require 'prometheus/middleware/exporter'
+
+
     config.before_initialize do
       version = Rails.version
       if version >= "5.0.0"
@@ -12,6 +17,25 @@ module ZuoraConnect
       ::Rails.configuration.action_dispatch.x_sendfile_header = nil
     end
 
+    # Base object not being loaded at this point for some reason
+    if ZuoraConnect::Configuration.new.enable_metrics_flag == true
+
+      initializer "prometheus.configure_rails_initialization" do |app|
+        app.middleware.use Prometheus::Middleware::Exporter,(options ={:path => '/connect/internal/metrics'})
+      end
+
+      initializer "zuora_connect.configure_rails_initialization" do |app|
+        app.middleware.insert_after Rack::Sendfile, Middleware::MetricsMiddleware
+      end
+
+      # hook to process_action
+      ActiveSupport::Notifications.subscribe('process_action.action_controller', Middleware::PageRequest.new)
+
+
+
+    end
+
+
     initializer(:rails_stdout_logging, before: :initialize_logger) do
       if Rails.env != 'development' && !ENV['DEIS_APP'].blank?
         require 'lograge'

data/lib/zuora_connect/version.rb

@@ -1,3 +1,3 @@
 module ZuoraConnect
-  VERSION = "1.5.40a"
+  VERSION = "1.5.40b"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zuora_connect
 version: !ruby/object:Gem::Version
-  version: 1.5.40a
+  version: 1.5.40b
 platform: ruby
 authors:
 - Connect Team
@@ -106,6 +106,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: telegraf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: prometheus-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -238,6 +266,7 @@ files:
 - app/views/zuora_connect/static/session_error.html.erb
 - config/initializers/apartment.rb
 - config/initializers/object_method_hooks.rb
+- config/initializers/prometheus.rb
 - config/initializers/redis.rb
 - config/initializers/resque.rb
 - config/initializers/to_bool.rb
@@ -252,6 +281,7 @@ files:
 - db/migrate/20110503003603_add_catalog_mappings_to_app_instance.rb
 - db/migrate/20110503003604_catalog_default.rb
 - db/migrate/20180301052853_add_catalog_attempted_at.rb
+- lib/middleware/metrics_middleware.rb
 - lib/resque/additions.rb
 - lib/resque/dynamic_queues.rb
 - lib/resque/self_lookup.rb