observability 0.1.0 → 0.2.0

data/lib/observability/instrumentation/grape.rb

@@ -0,0 +1,22 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'observability/instrumentation' unless defined?( Observability::Instrumentation )
+
+
+# Instrumentation for the Grape HTTP API framework
+# Refs:
+# - http://www.ruby-grape.org/
+module Observability::Instrumentation::Grape
+	extend Observability::Instrumentation
+
+	depends_on 'Grape'
+
+
+	when_installed( 'Grape::API' ) do
+		Grape::API.extend( Observability )
+		Grape::API.observe_method( :call )
+	end
+
+end # module Observability::Instrumentation::Grape
+

data/lib/observability/instrumentation/rack.rb

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'observability/instrumentation' unless defined?( Observability::Instrumentation )
+
+
+# Instrumentation for the Rack HTTP interface library
+# Refs:
+# - https://rack.github.io
+module Observability::Instrumentation::Rack
+	extend Observability::Instrumentation
+
+	depends_on 'Rack'
+
+
+	when_installed( 'Rack::Builder' ) do
+		Rack::Builder.extend( Observability )
+		Rack::Builder.observe_method( :call )
+	end
+
+
+end # module Observability::Instrumentation::Rack
+

data/lib/observability/instrumentation/sequel.rb

@@ -0,0 +1,37 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'observability/instrumentation' unless defined?( Observability::Instrumentation )
+
+
+# Instrumentation for the Sequel database toolkit.
+# Refs:
+# - http://sequel.jeremyevans.net/
+module Observability::Instrumentation::Sequel
+	extend Observability::Instrumentation
+
+	depends_on 'Sequel::Database'
+
+
+	when_installed( 'Sequel::Database' ) do
+		Sequel::Database.extend( Observability )
+		Sequel::Database.observe_class_method( :connect )
+		Sequel::Database.observe_method( :disconnect )
+	end
+
+
+	when_installed( 'Sequel::Postgres::Adapter' ) do
+		Sequel::Postgres::Adapter.extend( Observability )
+		Sequel::Postgres::Adapter.observe_method( :execute, timed: true ) do |sql, *|
+			begin
+				nsql = PgQuery.normalize( sql )
+				Observability.observer.add( query: nsql )
+			rescue => err
+				Loggability[ Observability ].warn "Couldn't normalize query: %p" % [ sql ]
+			end
+		end
+	end
+
+
+end # module Observability::Instrumentation::Sequel
+

data/lib/observability/observer.rb

@@ -271,17 +271,23 @@ class Observability::Observer
 	### Return a Hash of fields to add to the current event derived from the given
 	### +exception+ object.
 	def fields_from_exception( exception )
-		trace_frames = exception.backtrace_locations.map do |loc|
-			{ label: loc.label, path: loc.absolute_path, lineno: loc.lineno }
+		fields = {
+			type: exception.class.name,
+			message: exception.message,
+		}
+
+		if exception.cause
+			cause_fields = self.fields_from_exception( exception.cause )
+			fields[ :cause ] = cause_fields[ :error ]
 		end
 
-		return {
-			error: {
-				type: exception.class.name,
-				message: exception.message,
-				backtrace: trace_frames
-			}
-		}
+		if ( locations = exception.backtrace_locations )
+			fields[ :backtrace ] = locations.map do |loc|
+				{ label: loc.label, path: loc.absolute_path, lineno: loc.lineno }
+			end
+		end
+
+		return { error: fields }
 	end
 
 

data/lib/observability/sender.rb

@@ -25,7 +25,9 @@ class Observability::Sender
 
 		##
 		# The sender type to use
-		setting :type, default: :null
+		setting :type, default: :null do |value|
+			value && value.to_sym
+		end
 
 	end
 

data/lib/observability/sender/udp_multicast.rb

@@ -0,0 +1,114 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'socket'
+require 'configurability'
+
+require 'observability/sender' unless defined?( Observability::Sender )
+
+# A sender that sends events as JSON over multicast UDP.
+class Observability::Sender::UdpMulticast < Observability::Sender
+	extend Configurability
+
+
+	# Number of seconds to wait between retrying a blocked write
+	RETRY_INTERVAL = 0.25
+
+	# The pipeline to use for turning events into network data
+	SERIALIZE_PIPELINE = :resolve.to_proc >> JSON.method( :generate )
+
+
+	# Declare configurable settings
+	configurability( 'observability.sender.udp' ) do
+
+		##
+		# The local address to bind to
+		setting :bind_address, default: '0.0.0.0'
+
+		##
+		# The address of the multicast group to join
+		setting :multicast_address, default: '224.15.7.75'
+
+		##
+		# The TTL of the outgoing messages, i.e., how many hops they will be limited to
+		setting :multicast_ttl, default: 1
+
+		##
+		# The port to bind to
+		setting :port, default: 15775
+
+	end
+
+
+	### Return an IPAddr that represents the local + multicast addresses to bind to.
+	def self::bind_addr
+		return IPAddr.new( self.bind_address ).hton + IPAddr.new( self.multicast_address ).hton
+	end
+
+
+	### Create a new UDP sender
+	def initialize( * )
+		@multicast_address = self.class.multicast_address
+		@port              = self.class.port
+		@socket            = self.create_socket
+	end
+
+
+	######
+	public
+	######
+
+	##
+	# The address of the multicast group to send to
+	attr_reader :multicast_address
+
+	##
+	# The port to send on
+	attr_reader :port
+
+	##
+	# The socket to send events over
+	attr_reader :socket
+
+
+	### Stop the sender's executor.
+	def stop
+		super
+
+		self.socket.shutdown( :WR )
+	end
+
+
+	### Serialize each the given +events+ and return the results.
+	def serialize_events( events  )
+		return events.map( &SERIALIZE_PIPELINE )
+	end
+
+
+	### Send the specified +event+.
+	def send_event( data )
+
+		until data.empty?
+			bytes = self.socket.send( data, 0, self.multicast_address, self.port )
+
+			self.log.debug "Sent: %p" % [ data[0, bytes] ]
+			data[ 0, bytes ] = ''
+		end
+	end
+
+
+	### Create and return a UDPSocket after setting it up for multicast.
+	def create_socket
+		iaddr = self.class.bind_addr
+		socket = UDPSocket.new
+
+		socket.setsockopt( :IPPROTO_IP, :IP_ADD_MEMBERSHIP, iaddr )
+		socket.setsockopt( :IPPROTO_IP, :IP_MULTICAST_TTL, self.class.multicast_ttl )
+		socket.setsockopt( :IPPROTO_IP, :IP_MULTICAST_LOOP, 1 )
+		socket.setsockopt( :SOL_SOCKET, :SO_REUSEPORT, 1 )
+
+		return socket
+	end
+
+end # class Observability::Sender::UDP
+

data/spec/observability/instrumentation_spec.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/env rspec -cfd
+
+require_relative '../spec_helper'
+
+require 'observability/instrumentation'
+
+
+describe Observability::Instrumentation do
+
+	let( :instrumentation ) do
+		mod = Module.new
+		mod.extend( described_class )
+		return mod
+	end
+
+
+	it "provides a way to load instrumentation for common libraries" do
+		expect( described_class ).to receive( :require ).
+			with( 'observability/instrumentation/rack' )
+
+		described_class.load( :rack )
+	end
+
+
+	it "can load several libraries at once" do
+		expect( described_class ).to receive( :require ).
+			with( 'observability/instrumentation/sequel' )
+		expect( described_class ).to receive( :require ).
+			with( 'observability/instrumentation/bunny' )
+
+		described_class.load( :sequel, :bunny )
+	end
+
+
+	it "can install loaded instrumentation" do
+		installation_callback_called = false
+
+		instrumentation.when_installed do
+			installation_callback_called = true
+		end
+
+		expect {
+			described_class.install
+		}.to change { installation_callback_called }.to( true )
+	end
+
+end
+

data/spec/observability/observer_spec.rb

@@ -252,6 +252,37 @@ describe Observability::Observer do
 		end
 
 
+		it "can be added for a secondary Exception" do
+			observer = described_class.new( :testing )
+			observer.event( 'acme.engine.start' )
+
+			expect {
+				observer.finish_after_block do
+					begin
+						raise "misfire!"
+					rescue => err
+						raise ArgumentError, "Cleared a misfire."
+					end
+				end
+			}.to raise_error( ArgumentError, 'Cleared a misfire.' )
+
+			event = observer.sender.enqueued_events.last
+			expect( event.type ).to eq( 'acme.engine.start' )
+
+			expect( event.fields ).to include(
+				error: a_hash_including(
+					type: 'ArgumentError',
+					message: 'Cleared a misfire.',
+					cause: a_hash_including(
+						type: 'RuntimeError',
+						message: 'misfire!',
+						backtrace: an_instance_of( Array )
+					)
+				)
+			)
+		end
+
+
 		it "can be added for any object that responds to #to_h" do
 			observer = described_class.new( :testing )
 			observer.event( 'acme.engine.start' )
@@ -271,7 +302,6 @@ describe Observability::Observer do
 	end
 
 
-
 	describe "context" do
 
 		it "can be added for all inner events" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: observability
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Michael Granger
@@ -11,8 +11,8 @@ cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
   MIIENDCCApygAwIBAgIBATANBgkqhkiG9w0BAQsFADAiMSAwHgYDVQQDDBdnZWQv
-  REM9RmFlcmllTVVEL0RDPW9yZzAeFw0xODExMjAxODI5NTlaFw0xOTExMjAxODI5
-  NTlaMCIxIDAeBgNVBAMMF2dlZC9EQz1GYWVyaWVNVUQvREM9b3JnMIIBojANBgkq
+  REM9RmFlcmllTVVEL0RDPW9yZzAeFw0xOTEwMDkwMDM2NTdaFw0yMDEwMDgwMDM2
+  NTdaMCIxIDAeBgNVBAMMF2dlZC9EQz1GYWVyaWVNVUQvREM9b3JnMIIBojANBgkq
   hkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAvyVhkRzvlEs0fe7145BYLfN6njX9ih5H
   L60U0p0euIurpv84op9CNKF9tx+1WKwyQvQP7qFGuZxkSUuWcP/sFhDXL1lWUuIl
   M4uHbGCRmOshDrF4dgnBeOvkHr1fIhPlJm5FO+Vew8tSQmlDsosxLUx+VB7DrVFO
@@ -24,17 +24,17 @@ cert_chain:
   N2I4L/ZOIe2DIVuYH7aLHfjZDQv/mNgpAgMBAAGjdTBzMAkGA1UdEwQCMAAwCwYD
   VR0PBAQDAgSwMB0GA1UdDgQWBBRyjf55EbrHagiRLqt5YAd3yb8k4DAcBgNVHREE
   FTATgRFnZWRARmFlcmllTVVELm9yZzAcBgNVHRIEFTATgRFnZWRARmFlcmllTVVE
-  Lm9yZzANBgkqhkiG9w0BAQsFAAOCAYEAP9Ffkvg4e8CjIWi8SykQ8oJSS8jbmbgF
-  abke3vXWLG6V9kFiObuJd5wZRBluJANu7bEtjgc3fFaGVP2XxVdCpVjNbmMDg4Qp
-  ovvczP53X6pQP2RSZgxF6Lblvy8y11RziUTVRG/Z2aJHsElo6gI7vQznE/OSDrhC
-  gEhr8uaIUt7D+HZWRbU0+MkKPpL5uMqaFuJbqXEvSwPTuUuYkDfNfsjQO7ruWBac
-  bxHCrvpZ6Tijc0nrlyXi6gPOCLeaqhau2xFnlvKgELwsGYSoKBJyDwqtQ5kwrOlU
-  tkSyLrfZ+RZcH535Hyvif7ZxB0v5OxXXoec+N2vrUsEUMRDL9dg4/WFdN8hIOixF
-  3IPKpZ1ho0Ya5q7yhygtBK9/NBFHw+nbJjcltfPDBXleRe8u73gnQo8AZIhStYSP
-  v4qqqa27Bs468d6SoPxjSm8a2mM9HZ4OdWhq4tFsbTeXDVquCfi64OTEaTt2xQdR
-  JnC4lpJfCP6aCXa5h2XAQfPSH636cQap
+  Lm9yZzANBgkqhkiG9w0BAQsFAAOCAYEAFqsr6o0SvQRgjQVmhbQvExRnCMCoW1yb
+  FJiN7A5RA2Iy2E61OG1Ul5nGmaDmx/PNB/6JIbIV3B9Uq8aTZx4uOjK7r8vMl1/t
+  ZfY7r6HejJfXlcO2m6JDMbpdyEVv916LncBkzZRz6vnnNCx+31f15FKddxujpAFd
+  qpn3JRQY+oj7ZkoccL/IUiDpxQWeS3oOoz9qr2kVTp8R50InZimt79FqCl/1m66W
+  kdOuf+wM3DDx7Rt4IVNHrhGlyfMr7xjKW1Q3gll+pMN1DT6Ajx/t3JDSEg7BnnEW
+  r7AciSO6J4ApUdqyG+coLFlGdtgFTgRHv7ihbQtDI7Z/LV7A4Spn1j2PK3j0Omri
+  kSl1hPVigRytfgdVGiLXzvkkrkgj9EknCaj5UHbac7XvVBrljXj9hsnnqTANaKsg
+  jBZSA+N+xUTgUWpXjjwsLZjzJkhWATJWq+krNXcqpwXo6HsjmdUxoFMt63RBb+sI
+  XrxOxp8o0uOkU7FdLSGsyqJ2LzsR4obN
   -----END CERTIFICATE-----
-date: 2019-07-24 00:00:00.000000000 Z
+date: 2019-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -42,28 +42,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.5
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.5
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby-ext
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.5
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.5
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: loggability
   requirement: !ruby/object:Gem::Requirement
@@ -121,61 +121,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: hoe-mercurial
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-- !ruby/object:Gem::Dependency
-  name: hoe-deveiate
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-- !ruby/object:Gem::Dependency
-  name: hoe-highline
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: rake-deveiate
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -204,82 +176,31 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7'
-- !ruby/object:Gem::Dependency
-  name: hoe
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.17'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.17'
-description: "Observability is a toolkit for instrumenting code to make it more observable,\nfollowing
-  the principle of Observability-Oriented Design as expressed by Charity\nMajors (@mipsytipsy).\n\nIts
-  goals are [stolen from https://charity.wtf/2019/02/05/logs-vs-structured-events/]:\n\n*
-  Emit a rich record from the perspective of a single action as the code is\n  executing.\n*
-  Emit a single event per action per system that it occurs in. Write it out just\n
-  \ before the action completes or errors.\n* Bypass local disk entirely, write to
-  a remote service.\n* Sample if needed for cost or resource constraints. Practice
-  dynamic sampling.\n* Treat this like operational data, not transactional data. Be
-  profligate and\n  disposable.\n* Feed this data into a columnar store or honeycomb
-  or similar\n* Now use it every day. Not just as a last resort. Get knee deep in
-  production\n  every single day. Explore. Ask and answer rich questions about your
-  systems,\n  system quality, system behavior, outliers, error conditions, etc. You
-  will be\n  absolutely amazed how useful it is … and appalled by what you turn up.
-  \U0001F642"
+description: |-
+  Observability is a toolkit for instrumenting code to make it more observable.
+  It follows the principle of Observability-Oriented Design as expressed by Charity
+  Majors (@mipsytipsy).
 email:
-- ged@FaerieMUD.org
-executables:
-- observability-collector
+- ged@faeriemud.org
+executables: []
 extensions: []
-extra_rdoc_files:
-- DevNotes.md
-- History.md
-- LICENSE.txt
-- Manifest.txt
-- README.md
+extra_rdoc_files: []
 files:
-- ".document"
-- ".rdoc_options"
-- ".simplecov"
-- ChangeLog
 - DevNotes.md
 - History.md
 - LICENSE.txt
-- Manifest.txt
 - README.md
-- Rakefile
 - bin/observability-collector
-- examples/basic-usage.rb
 - lib/observability.rb
 - lib/observability/collector.rb
+- lib/observability/collector/rabbitmq.rb
 - lib/observability/collector/timescale.rb
 - lib/observability/event.rb
+- lib/observability/instrumentation.rb
+- lib/observability/instrumentation/bunny.rb
+- lib/observability/instrumentation/grape.rb
+- lib/observability/instrumentation/rack.rb
+- lib/observability/instrumentation/sequel.rb
 - lib/observability/observer.rb
 - lib/observability/observer_hooks.rb
 - lib/observability/sender.rb
@@ -287,7 +208,9 @@ files:
 - lib/observability/sender/null.rb
 - lib/observability/sender/testing.rb
 - lib/observability/sender/udp.rb
+- lib/observability/sender/udp_multicast.rb
 - spec/observability/event_spec.rb
+- spec/observability/instrumentation_spec.rb
 - spec/observability/observer_hooks_spec.rb
 - spec/observability/observer_spec.rb
 - spec/observability/sender/logger_spec.rb
@@ -295,21 +218,19 @@ files:
 - spec/observability/sender_spec.rb
 - spec/observability_spec.rb
 - spec/spec_helper.rb
-homepage: http://bitbucket.org/ged/observability
+homepage: https://hg.sr.ht/~ged/Observability
 licenses:
 - BSD-3-Clause
 metadata: {}
 post_install_message: 
-rdoc_options:
-- "--main"
-- README.md
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -319,7 +240,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Observability is a toolkit for instrumenting code to make it more observable,
-  following the principle of Observability-Oriented Design as expressed by Charity
-  Majors (@mipsytipsy)
+summary: Observability is a toolkit for instrumenting code to make it more observable.
 test_files: []