treblle 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7e8150492d3a4b39eff0b9d64a12e75e459fe4d74ac42a6eb172f860f6cc6e0
-  data.tar.gz: b96ad0f8f9697838523d4db9945a3214e7810865033f9fc27fe1666f1d108589
+  metadata.gz: 33af7f59af8142ab9221eeae5e96157831ebd85f103d282bbfe94527f3430a50
+  data.tar.gz: 46a242aba5acb59cc02eb83b7ddfecbdcafdaccf6b096a1d3130d1f5176b0898
 SHA512:
-  metadata.gz: 2aa83b4cda17c255dc307f9135fb9e60839af43abab4e39639eecc165e67b2cee4dd8b8b6dc93b0162ff6f7113722000e1b7791c6bb9d3d7d1236282f41baa97
-  data.tar.gz: 10da084dcceb356776492b26473c5564fa1675b5a801d6afc235023cc77085eeeb4b84c563aa051d8b1995dfd628e84faa5b84d29f5f97260207e441318989ce
+  metadata.gz: c4c40f9be2cdf09ef85ba0c2a9b8fc5ff8da22fd96356c8154602d1d48003ccb47a126f35cd27abf44b865d0299d6c6b8a25f7507d836fa38422156d7034f70a
+  data.tar.gz: 2546afe677f060122e034453992bf565d6008dd62fff234bf48aef93ac6c6251e34e4879baf1464a8e9669aeeba5f04eba77ceeeb4aeb4e28c1f26e04526795d

data/lib/treblle/data_builder.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require 'socket'
+
+# Gathers and builds body payload to be sent to Treblle in json format.
+# Hides sensitive data based on default values and additional ones provided via env variable.
+class DataBuilder
+  DEFAULT_SENSITIVE_FIELDS = Set[
+    'card_number',
+    'cardNumber',
+    'cc',
+    'ccv',
+    'credit_score',
+    'creditScore',
+    'password',
+    'password_confirmation',
+    'passwordConfirmation',
+    'pwd',
+    'secret',
+    'ssn'
+  ].freeze
+
+  attr_accessor :env, :status, :started_at, :ended_at, :request, :headers, :json_response, :exception
+
+  def initialize(params)
+    @ended_at = params[:ended_at]
+    @env = params[:env]
+    @exception = params[:exception]
+    @headers = params[:headers]
+    @json_response = params[:json_response]
+    @request = params[:request]
+    @started_at = params[:started_at]
+    @status = params[:status]
+  end
+
+  def call
+    time_spent = ended_at - started_at
+    user_agent = env['HTTP_USER_AGENT']
+    ip = env['action_dispatch.remote_ip'].calculate_ip
+    request_method = env['REQUEST_METHOD']
+    project_id = ENV.fetch('TREBLLE_PROJECT_ID') { '' }
+    request_body = request_method.downcase == 'get' ? request.query_parameters : safe_to_json(request.raw_post)
+
+    data = {
+      api_key: ENV.fetch('TREBLLE_API_KEY') { '' },
+      project_id: project_id,
+      version: Treblle::TREBLLE_VERSION,
+      sdk: 'ruby',
+      data: {
+        server: {
+          ip: server_ip,
+          timezone: Time.zone.name,
+          software: request_headers.try(:[], 'SERVER_SOFTWARE'),
+          signature: '',
+          protocol: request_headers.try(:[], 'SERVER_PROTOCOL'),
+          os: {}
+        },
+        language: {
+          name: 'ruby',
+          version: RUBY_VERSION
+        },
+        request: {
+          timestamp: started_at.to_formatted_s(:db),
+          ip: ip,
+          url: request.original_url,
+          user_agent: user_agent,
+          method: request_method,
+          headers: request_headers,
+          body: without_sensitive_attrs(request_body)
+        },
+        response: {
+          headers: headers || {},
+          code: status,
+          size: json_response&.to_json&.bytesize || 0,
+          load_time: time_spent,
+          body: without_sensitive_attrs(json_response),
+          errors: build_error_object(exception)
+        }
+      }
+    }
+
+    begin
+      data.to_json
+    rescue Exception
+      JSON.dump(data)
+    end
+  end
+
+  private
+
+  def without_sensitive_attrs(obj)
+    return {} unless obj.present?
+
+    obj.each do |k, v|
+      value = v || k
+      if value.is_a?(Hash) || value.is_a?(Array)
+        without_sensitive_attrs(value)
+      elsif sensitive_attrs.include?(k.to_s)
+        obj[k] = '*' * v.to_s.length
+      end
+    end
+    obj
+  rescue StandardError => e
+    Rails.logger.error e.message
+  end
+
+  def sensitive_attrs
+    @sensitive_attrs ||= user_sensitive_fields.merge(DEFAULT_SENSITIVE_FIELDS)
+  end
+
+  def user_sensitive_fields
+    fields = ENV.fetch('TREBLLE_SENSITIVE_FIELDS') { '' }.gsub(/\s+/, '')
+    fields.split(',').to_set
+  end
+
+  def build_error_object(exception)
+    return [] unless exception.present?
+
+    [
+      {
+        source: 'onError',
+        type: exception.class.to_s || 'Unhandled error',
+        message: exception.message,
+        file: exception.backtrace.try(:first) || ''
+      }
+    ]
+  end
+
+  def server_ip
+    Socket.ip_address_list.find { |ai| ai.ipv4? && !ai.ipv4_loopback? }.ip_address
+  end
+
+  def request_headers
+    @request_headers ||= request.headers.env.reject { |key| key.to_s.include?('.') }
+  end
+
+  def safe_to_json(obj)
+    JSON.parse(obj)
+  rescue StandardError => e
+    {}
+  end
+end

data/lib/treblle.rb

@@ -78,7 +78,6 @@ class Treblle
     req['Content-Type'] = 'application/json'
     req['x-api-key'] = ENV.fetch('TREBLLE_API_KEY') { '' }
     req.body = data
-    puts data
     res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
       http.request(req)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: treblle
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Hrvoje Grdic
@@ -17,6 +17,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/treblle.rb
+- lib/treblle/data_builder.rb
 homepage: https://rubygems.org/gems/treblle
 licenses:
 - MIT