xhummingbird 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 582e31f5f12893d74a24a8bc948e544778c7ad847bd95d8acd020f9617b6e27e
-  data.tar.gz: c68df314d986f338ee06fec0f0c43c5b6024aaba74787fde79a939096fb8171a
+  metadata.gz: 15a88a5d49e5f283250cb3ea1a3c65cdbd6f856c4d4f8e51833f4395a930fce0
+  data.tar.gz: 6d433c7920f91d794aea403c0f0f6cfd3196b0c166574f250c6e4f6783cb4679
 SHA512:
-  metadata.gz: 3efd449a0ae81617f6941e821ae60cfd7d248188b5d74ada5cc5c398a07232880c214fe41ae285d5e2fd0e106c6cb866556e91f7ccf33e91990ba7fbefa9e9eb
-  data.tar.gz: 7fb41838d484f79b1a2738a726ee44486d1ce97e1cf72aa255ce235a42b235dca48bc8d5c3155c5ad65a807b246eac7ad3565e9331bdbcc5f2aaa575c212e1ee
+  metadata.gz: 746d060320800872e1e0393039d16f12adc5ab79a390f4ee1424cc29a66feae1ac3b2a0fcfb94abecacaaae3c03ce7e70ddaec713ef7600e6514e44fdc556f41
+  data.tar.gz: d19646279e7fc71681753f2980a1cdfe84c6ee3f5bb0b2b1c2381657d814d1fc81da9f62c142ba1d904a16f735edf4c126494481f88fc83f7921fe7bd5e6692f

data/.ruby-version

@@ -0,0 +1 @@
+3.0.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    xhummingbird (0.1.0)
+    xhummingbird (0.1.5)
       ffi-rzmq
       google-protobuf
 
@@ -14,7 +14,7 @@ GEM
       ffi-rzmq-core (>= 1.0.7)
     ffi-rzmq-core (1.0.7)
       ffi
-    google-protobuf (3.15.5-x86_64-linux)
+    google-protobuf (3.15.8-x86_64-linux)
     minitest (5.14.4)
     parallel (1.20.1)
     parser (3.0.0.0)

data/examples/custom_tags.rb

@@ -0,0 +1,23 @@
+require 'xhummingbird'
+
+raise "Set #{Xhummingbird::Client::XH_SERVER} environment variable" unless Xhummingbird.enabled?
+
+Xhummingbird.start
+
+Xhummingbird.send_trace(
+  title: "CustomTagTrace",
+  message: "CustomTags",
+  tags: {
+    tag_a: 42,
+    tag_b: "foo",
+    tag_c: :bar
+  }
+)
+
+begin
+  raise 'Something wrong'
+rescue => e
+  Xhummingbird.send_exception(e, tags: {path: __FILE__})
+end
+
+sleep 1 # Await sending

data/examples/send_exception.rb

@@ -2,6 +2,8 @@ require 'xhummingbird'
 
 raise "Set #{Xhummingbird::Client::XH_SERVER} environment variable" unless Xhummingbird.enabled?
 
+Xhummingbird.start
+
 begin
   raise 'Something wrong'
 rescue => e

data/examples/send_trace.rb

@@ -2,6 +2,8 @@ require 'xhummingbird'
 
 raise "Set #{Xhummingbird::Client::XH_SERVER} environment variable" unless Xhummingbird.enabled?
 
+Xhummingbird.start
+
 Xhummingbird.send_trace(title: "SampleTrace", message: "Something happend")
 
 sleep 1 # Await sending

data/examples/short_name.rb

@@ -3,6 +3,8 @@ require 'xhummingbird/short_name'
 
 raise "Set #{XH::Client::XH_SERVER} environment variable" unless XH.enabled?
 
+XH.start
+
 XH.send_trace(title: "ShortNameTrace", message: "Send trace from short name reference")
 
 begin

data/examples/use_in_processes.rb

@@ -2,10 +2,14 @@ require 'xhummingbird'
 
 raise "Set #{Xhummingbird::Client::XH_SERVER} environment variable" unless Xhummingbird.enabled?
 
+Xhummingbird.start
+
 Xhummingbird.send_trace(title: "ParentProcess", message: "Send trace from parent process")
 
 process_ids = 10.times.map do |i|
   fork do
+    Xhummingbird.start
+
     Xhummingbird.send_trace(title: "ChildProcess", message: "Send trace from child process #{i}")
 
     sleep 1 # Await sending

data/examples/use_in_threads.rb

@@ -2,6 +2,8 @@ require 'xhummingbird'
 
 raise "Set #{Xhummingbird::Client::XH_SERVER} environment variable" unless Xhummingbird.enabled?
 
+Xhummingbird.start
+
 threads = 10.times.map do |i|
   Thread.start do
     Xhummingbird.send_trace(title: "Thread", message: "Send trace from thread #{i}")

data/lib/xhummingbird.rb

@@ -3,6 +3,8 @@
 require 'singleton'
 require 'ffi-rzmq'
 require 'socket'
+require 'logger'
+require 'set'
 
 require_relative "xhummingbird/version"
 require_relative "xhummingbird/client"
@@ -11,7 +13,25 @@ require_relative "xhummingbird/protos/event_pb"
 module Xhummingbird
   class Error < StandardError; end
 
-  def self.send_trace(title:, message: "", level: 1)
+  XH_SERVICE = 'XH_SERVICE'
+
+  LOGGER = Logger.new(STDERR)
+
+  def self.debug(*args)
+    LOGGER.debug(*args) if ENV['XH_DEBUG']
+  end
+
+  def self.start
+    debug(__method__)
+
+    Client.instance.start
+
+    send_trace(title: "Started", message: "Xhummingbird Ruby SDK started.", level: 0)
+  end
+
+  def self.send_trace(title:, message: "", level: 1, tags: {}, service: nil)
+    debug(__method__)
+
     return unless enabled?
 
     send(
@@ -19,14 +39,17 @@ module Xhummingbird
       title: title.to_s,
       message: message.to_s,
       trace: caller,
-      tags: default_tags,
-      timestamp: Time.now
+      tags: default_tags.merge(format_hash(tags)),
+      timestamp: Time.now,
+      service: service || default_service
     )
-  rescue
-    raise Error
+  rescue => e
+    debug(e)
   end
 
-  def self.send_exception(exception, level: 2)
+  def self.send_exception(exception, level: 2, tags: {}, service: nil)
+    debug(__method__)
+
     return unless enabled?
 
     send(
@@ -34,37 +57,65 @@ module Xhummingbird
       title: exception.class.name,
       message: exception.message,
       trace: exception.backtrace,
-      tags: default_tags,
-      timestamp: Time.now
+      tags: default_tags.merge(format_hash(tags)),
+      timestamp: Time.now,
+      service: service || default_service
     )
-  rescue
-    raise Error
+  rescue => e
+    debug(e)
   end
 
   def self.send_event(**args)
+    debug(__method__)
+
     return unless enabled?
 
     send(**args)
-  rescue
-    raise Error
+  rescue => e
+    debug(e)
   end
 
   def self.enabled?
+    debug(__method__)
+
     Client.instance.enabled?
   end
 
   def self.default_tags
+    debug(__method__)
+
     {
-       hostname: Socket.gethostname,
-       ruby_version: RUBY_VERSION,
-       pid: Process.pid.to_s,
-       thread_object_id: Thread.current.object_id.to_s
+      "default/sdk" => "Ruby #{Xhummingbird::VERSION}",
+      "default/hostname" =>  Socket.gethostname,
+      "default/ruby_version" =>  RUBY_VERSION,
+      "default/pid" =>  Process.pid.to_s,
+      "default/thread_object_id" => Thread.current.object_id.to_s
     }
   end
 
   def self.send(**args)
+    debug(__method__)
+
     event = Event.new(**args)
     message = Event.encode(event)
     Client.instance.send(message)
   end
+
+  def self.format_hash(hash)
+    debug(__method__)
+
+    formatted = {}
+
+    hash.each do |k, v|
+      formatted[k.to_s] = v.to_s
+    end
+
+    formatted
+  end
+
+  def self.default_service
+    debug(__method__)
+
+    ENV.fetch(XH_SERVICE, "")
+  end
 end

data/lib/xhummingbird/client.rb

@@ -5,41 +5,48 @@ module Xhummingbird
     XH_SERVER = 'XH_SERVER'
 
     def initialize
-      @mutex = Mutex.new
+      @pid = nil
+      @socket = nil
+      @active = false
     end
 
     def send(message)
-      socket.send_string(message)
+      if active?
+        @socket.send_string(message)
+      else
+        Xhummingbird.debug("Xhummingbird not started.")
+      end
     end
 
     def enabled?
-      @setup ||= !!address
+      @enabled ||= !!address
     end
 
-    private
-
-    def socket
-      return @socket if defined?(@socket) && @pid == Process.pid
+    def start
+      ctx = ZMQ::Context.new
+      socket = ctx.socket(ZMQ::PUSH)
+      socket.connect(address)
+      @socket = socket
+      Xhummingbird.debug("Socket created (pid: #{$$})")
+
+      at_exit do
+        Xhummingbird.debug("at_exit started.")
+        @socket.close
+        Xhummingbird.debug("at_exit stopped.")
+      end
 
-      @socket = init_socket
+      @pid = $$
+      @active = true
     end
 
-    def init_socket
-      @mutex.synchronize do
-        return @socket if defined?(@socket) && @pid == Process.pid
-
-        @pid = Process.pid
-
-        ctx = ZMQ::Context.new
-        socket = ctx.socket(ZMQ::PUSH)
-        socket.connect(address)
-
-        @socket = socket
-      end
-    end
+    private
 
     def address
       ENV[XH_SERVER]
     end
+
+    def active?
+      @pid == $$ && @socket && @active
+    end
   end
 end

data/lib/xhummingbird/protos/event_pb.rb

@@ -13,6 +13,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       repeated :trace, :string, 4
       map :tags, :string, :string, 5
       optional :timestamp, :message, 6, "google.protobuf.Timestamp"
+      optional :service, :string, 7
     end
   end
 end

data/lib/xhummingbird/rack.rb

@@ -0,0 +1 @@
+require_relative 'rack/capture_exception'

data/lib/xhummingbird/rack/capture_exception.rb

@@ -0,0 +1,62 @@
+module Xhummingbird
+  module Rack
+    class CaptureException
+      CONVERT_KEYS = Set.new(%w(
+        REQUEST_METHOD
+        SCRIPT_NAME
+        PATH_INFO
+        QUERY_STRING
+        SERVER_NAME
+        SERVER_PORT
+        rack.version
+        rack.url_scheme
+        rack.multithread
+        rack.multiprocess
+        rack.run_once
+        rack.hijack?
+      ))
+
+      HTTP_HEADER_PREFIX = 'HTTP_'
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        begin
+          response = @app.call(env)
+        rescue => e
+          Xhummingbird.send_exception(e, tags: convert_to_rack_tags(env))
+        end
+
+        error = env['rack.exception'] || env['sinatra.error']
+
+        if error
+          level = (400..499).include?(response.first.to_i) ? 0 : 2
+
+          Xhummingbird.send_exception(error, level: level, tags: convert_to_rack_tags(env))
+        end
+
+        response
+      end
+
+      private
+
+      def convert_to_rack_tags(env)
+        tags = {}
+
+        env.each do |k, v|
+          if CONVERT_KEYS.include?(k) || k.start_with?(HTTP_HEADER_PREFIX)
+            begin
+              tags["rack_env/" +  k.to_s] = v.to_s
+            rescue => e
+              Xhummingbird.debug(e)
+            end
+          end
+        end
+
+        tags
+      end
+    end
+  end
+end

data/lib/xhummingbird/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Xhummingbird
-  VERSION = "0.1.0"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xhummingbird
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - xmisao
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-13 00:00:00.000000000 Z
+date: 2021-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi-rzmq
@@ -47,6 +47,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".ruby-version"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -55,6 +56,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/custom_tags.rb
 - examples/send_exception.rb
 - examples/send_trace.rb
 - examples/short_name.rb
@@ -63,6 +65,8 @@ files:
 - lib/xhummingbird.rb
 - lib/xhummingbird/client.rb
 - lib/xhummingbird/protos/event_pb.rb
+- lib/xhummingbird/rack.rb
+- lib/xhummingbird/rack/capture_exception.rb
 - lib/xhummingbird/short_name.rb
 - lib/xhummingbird/version.rb
 - xhummingbird.gemspec