zuora_observability 0.1.0.pre.a

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c7e3a6c154d518f30f5a95e1be272b96b1853b46df0300d4fa45ca8e17f04451
+  data.tar.gz: 0c510e0da92d8b7139586e60bd048bc91f18cc61a9cfe8165f4f44676c223180
+SHA512:
+  metadata.gz: 3948b6dacece27853e9df426c81d6f475c1b8b5417131c4318eeac8b88c8ffa4c4f625036f95cc5b73ed78ed53352f182c2f7efb16800e313b797a7416372b3b
+  data.tar.gz: f67b67d6bbbf2ff33c30433f32f321bf28109540bbf54250764509332de9caba0dbcf94917439882ea7a0f8d6e1bc437eae221134ceb4adfac00933dddadd1f6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Hartley McGuire
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,26 @@
+# Zuora Observability
+
+A ruby gem to enable observability into rails applications
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zuora_observability'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install zuora_observability
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ZuoraObservability'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/zuora_observability_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/zuora_observability .css

data/app/assets/stylesheets/zuora_observability/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/zuora_observability/application_controller.rb

@@ -0,0 +1,5 @@
+module ZuoraObservability
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/zuora_observability/metrics_controller.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# require vs. require_dependency for namespaced controllers
+# https://github.com/rails/rails/commit/29d17d3ab65633695babc9123463c78248e41a67
+require_dependency 'zuora_observability/application_controller'
+
+module ZuoraObservability
+  class MetricsController < ApplicationController
+    # GET /connect/internal/data
+    def metrics
+      if params[:type] == 'stats'
+        render json: Metrics.resque, status: :ok
+      else
+        render json: Metrics.versions, status: :ok
+      end
+    end
+  end
+end

data/app/helpers/zuora_observability/application_helper.rb

@@ -0,0 +1,4 @@
+module ZuoraObservability
+  module ApplicationHelper
+  end
+end

data/app/jobs/zuora_observability/application_job.rb

@@ -0,0 +1,4 @@
+module ZuoraObservability
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/zuora_observability/application_mailer.rb

@@ -0,0 +1,6 @@
+module ZuoraObservability
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/zuora_observability/application_record.rb

@@ -0,0 +1,5 @@
+module ZuoraObservability
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/zuora_observability/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Zuora observability</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "zuora_observability/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+ZuoraObservability::Engine.routes.draw do
+  get 'metrics', to: 'metrics#metrics'
+end

data/lib/tasks/zuora_observability_tasks.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# desc "Explaining what the task does"
+# task :zuora_observability do
+#   # Task goes here
+# end

data/lib/zuora_observability.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'zuora_observability/configuration'
+require 'zuora_observability/engine'
+require 'zuora_observability/env'
+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
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def reset
+      @configuration = Configuration.new
+    end
+  end
+end

data/lib/zuora_observability/configuration.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ZuoraObservability
+  # Global configuration that can be set in a Rails initializer
+  class Configuration
+    attr_accessor :enable_metrics, :telegraf_endpoint, :telegraf_debug,
+                  :json_logging
+
+    def initialize
+      @enable_metrics = false
+      @telegraf_endpoint = 'udp://telegraf-app-metrics.monitoring.svc.cluster.local:8094'
+      @telegraf_debug = false
+      @json_logging = false
+    end
+  end
+end

data/lib/zuora_observability/engine.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module ZuoraObservability
+  # The ZuoraObservability Engine is mounted to hook into Rails
+  class Engine < ::Rails::Engine
+    isolate_namespace ZuoraObservability
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    initializer(:rails_stdout_logging, before: :initialize_logger) do
+      require 'lograge'
+
+      Rails.configuration.logger = ZuoraObservability::Logger.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) }
+            begin
+              if request_headers["HTTP_AUTHORIZATION"].present?
+                if request_headers["HTTP_AUTHORIZATION"].include?("Basic")
+                  user_password = request_headers["HTTP_AUTHORIZATION"].split("Basic").last.strip
+                  user, password = Base64.decode64(user_password).split(":")
+                  request_headers["HTTP_AUTHORIZATION"] = "Basic #{user}:ValueFiltered"
+                elsif
+                  request_headers["HTTP_AUTHORIZATION"] = "ValueFiltered"
+                end
+              end
+              request_headers["HTTP_API_TOKEN"] = "ValueFiltered" if request_headers["HTTP_API_TOKEN"].present?
+            rescue
+              request_headers.delete("HTTP_API_TOKEN")
+              request_headers.delete("HTTP_AUTHORIZATION")
+            end
+            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
+      end
+    end
+  end
+end

data/lib/zuora_observability/env.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module ZuoraObservability
+  # Methods to get information about the application environment
+  class Env
+    class << self
+      def app_name
+        # parent_name is deprecated in Rails 6.0, removed in 6.1
+        ENV['DEIS_APP'].presence || Rails.application.class.parent_name
+      end
+
+      def pod_name
+        ENV['HOSTNAME'].presence || Socket.gethostname
+      end
+
+      def full_process_name(process_name: nil, function: nil)
+        keys = [pod_name, process_name.presence || process_type, Process.pid, function]
+        keys.compact.join('][').prepend('[').concat(']')
+      end
+
+      # Returns the process type if any
+      def 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
+end

data/lib/zuora_observability/logger.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'mono_logger'
+
+module ZuoraObservability
+  # A configurable logger that can be used for Rails and additional libraries
+  module Logger
+    # NOTE(hartley): potentially change Logger module to delegate methods to
+    # value returned from custom_logger (so it ends up being a pure wrapper)
+    def self.custom_logger(name: "", level: Rails.logger.present? ? Rails.logger.level : MonoLogger::INFO, type: :ougai)
+      #puts name + ' - ' + {Logger::WARN => 'Logger::WARN', Logger::ERROR => 'Logger::ERROR', Logger::DEBUG => 'Logger::DEBUG', Logger::INFO => 'Logger::INFO' }[level] + ' - '
+      if type == :ougai
+        require 'ougai'
+        require "ougai/formatters/customizable"
+        #logger = Ougai::Logger.new(MonoLogger.new(STDOUT))
+        logger = Ougai::Logger.new(STDOUT)
+        logger.level = level
+        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|
+              next nil unless data.key?(:err)
+              err = data.delete(:err)
+              "  #{err[:name]} (#{err[:message]})\n #{err[:stack]}"
+            end,
+            format_data: proc do |data|
+              data.delete(:app_instance_id); data.delete(:tenant_ids); data.delete(:organization); data.delete(:environment)
+              format('%s %s: %s', 'DATA'.ljust(6), Time.now.strftime('%FT%T.%6NZ'), "#{data.to_json}") if data.present?
+            end,
+            format_msg: proc do |severity, datetime, _progname, data|
+              msg = data.delete(:msg)
+              format('%s %s: %s', severity.ljust(6), datetime, msg)
+            end
+          )
+          logger.formatter.datetime_format = '%FT%T.%6NZ'
+        end
+      else
+        require 'mono_logger'
+        logger = MonoLogger.new(STDOUT)
+        logger.level = level
+        logger.formatter =  proc do |serverity, datetime, progname, msg|
+          begin
+            msg = JSON.parse(msg)
+          rescue JSON::ParserError => ex
+          end
+          if ZuoraObservability.configuration.json_logging
+            require 'json'
+            store = {
+              name: name,
+              level: serverity,
+              timestamp: datetime.strftime('%FT%T.%6NZ'),
+              pid: Process.pid,
+              message: name == "ActionMailer" ? msg.strip : msg
+            }
+            JSON.dump(store) + "\n"
+          else
+            format('%s %s: %s', serverity.ljust(6), datetime, msg) + "\n"
+          end
+        end
+      end
+      return logger
+    end
+  end
+end

data/lib/zuora_observability/logging/formatter.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'ougai/formatters/base'
+require 'ougai/formatters/for_json'
+
+module ZuoraObservability
+  module Logging
+    # A JSON formatter compatible with node-bunyan
+    class Formatter < Ougai::Formatters::Base
+      include Ougai::Formatters::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 = Ougai::Formatters::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/zuora_observability/metrics.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+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
+
+        resque = Resque.info
+
+        {
+          app_name: ZuoraObservability::Env.app_name, url: 'dummy', Resque: {
+            Jobs_Finished: resque[:processed], Jobs_Failed: resque[:failed],
+            Jobs_Pending: resque[:pending], Workers_Active: resque[:working],
+            Workers_Total: resque[:workers]
+          }
+        }
+      end
+
+      def versions
+        {
+          app_name: ZuoraObservability::Env.app_name,
+          url: 'dummy',
+          Version_Gem: ZuoraConnect::VERSION,
+          Version_Zuora: ZuoraAPI::VERSION,
+          Version_Ruby: RUBY_VERSION,
+          Version_Rails: Rails.version,
+          hold: 1
+        }
+      end
+
+      def unicorn_listener
+        stats_hash = {}
+        stats_hash["total_active"] = 0
+        stats_hash["total_queued"] = 0
+
+        begin
+          tmp = Unicorn.listener_names
+          unix = tmp.grep(%r{\A/})
+          tcp = tmp.grep(/\A.+:\d+\z/)
+          tcp = nil if tcp.empty?
+          unix = nil if unix.empty?
+
+
+          Raindrops::Linux.tcp_listener_stats(tcp).each do |addr,stats|
+            stats_hash["active_#{addr}"] = stats.active
+            stats_hash["queued_#{addr}"] = stats.queued
+            stats_hash["total_active"] = stats.active + stats_hash["total_active"]
+            stats_hash["total_queued"] = stats.queued + stats_hash["total_queued"]
+          end if tcp
+
+          Raindrops::Linux.unix_listener_stats(unix).each do |addr,stats|
+            stats_hash["active_#{addr}"] = stats.active
+            stats_hash["queued_#{addr}"] = stats.queued
+            stats_hash["total_active"] = stats.active + stats_hash["total_active"]
+            stats_hash["total_queued"] = stats.queued + stats_hash["total_queued"]
+          end if unix
+        rescue IOError => ex
+        rescue => ex
+          Rails.logger.error(ex)
+          puts ex
+        end
+        return stats_hash
+      end
+    end
+  end
+end

data/lib/zuora_observability/metrics/point_value.rb

@@ -0,0 +1,84 @@
+# 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

@@ -0,0 +1,98 @@
+# 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

data/lib/zuora_observability/version.rb

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

metadata

@@ -0,0 +1,291 @@
+--- !ruby/object:Gem::Specification
+name: zuora_observability
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre.a
+platform: ruby
+authors:
+- Hartley McGuire
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lograge
+  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: ougai
+  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: ougai-formatters-customizable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: mono_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: brakeman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0.pre
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0.pre
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: unicorn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Description of ZuoraObservability.
+email:
+- hmcguire@zuora.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/zuora_observability_manifest.js
+- app/assets/stylesheets/zuora_observability/application.css
+- app/controllers/zuora_observability/application_controller.rb
+- app/controllers/zuora_observability/metrics_controller.rb
+- app/helpers/zuora_observability/application_helper.rb
+- app/jobs/zuora_observability/application_job.rb
+- app/mailers/zuora_observability/application_mailer.rb
+- app/models/zuora_observability/application_record.rb
+- app/views/layouts/zuora_observability/application.html.erb
+- config/routes.rb
+- lib/tasks/zuora_observability_tasks.rake
+- lib/zuora_observability.rb
+- lib/zuora_observability/configuration.rb
+- lib/zuora_observability/engine.rb
+- lib/zuora_observability/env.rb
+- lib/zuora_observability/logger.rb
+- lib/zuora_observability/logging/formatter.rb
+- lib/zuora_observability/metrics.rb
+- lib/zuora_observability/metrics/point_value.rb
+- lib/zuora_observability/metrics/telegraf.rb
+- lib/zuora_observability/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Summary of ZuoraObservability.
+test_files: []