flare 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8eb495874fecf193c205e02c4254d2229ad264cc3e640bba5239940ac3de8e5d
-  data.tar.gz: 71218afa6c8972dcf6cf76dc3dddc059a5197a7542a05cf8d0ad8a8f964c290f
+  metadata.gz: c659b175126da90baf0738ea221b54c25d9939ffbca3883b7756b2972574d0b6
+  data.tar.gz: 1b5d1f9f146a91ac1e7fc7a605fa2a3e3f22d28b906b92939362f99d9c63361d
 SHA512:
-  metadata.gz: '035922584796dd1033486f6723cf859ae0d9f8dd169221817c120f66d3352ad5bbea6793f154d2963476a77e58b7f1c5a3635bf965821d245176271bd4d752de'
-  data.tar.gz: 72338f6d8503a8b464f86de6e5397023716d55a810623eefe1d9b81cfdeae4ef3829f15b1228ccb1bdbacf0d957938d54a9e345a5c08f6ba09a7c68cd4b2624e
+  metadata.gz: 2662255ed5b8c4b77315e348c6c334f02df3a0879fdba62b64bd9d20ead9c78add8d88847dd945c9a276138ebdaa222352e64b2f2d1b054acb91bb23e3c67da4
+  data.tar.gz: 6374272263432f9f3a75d7d291fb7099bc7bcd8c8bfe87b8d3eb1b6c1a7ff79d39d226e49d20f88018f17f0f1411df6849c7ae65faa73f15350612fe1a03880c

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [Unreleased]
 
+## [0.2.0] - 2026-04-23
+
+- Auto-detect OTel instrumentation gems via `use_all`
+- Name Sidekiq job spans by worker class (via `job_class` attribute)
+- Support both old and new OTel semantic convention property keys in dashboard queries
+- Guard dashboard routes when sqlite3 is missing
+
+## [0.1.1] - 2025-12-17
+
+- Rename gem from caboose to flare
+- Warn instead of raising when sqlite3 gem is missing
+- Make sqlite3 an optional dependency for production compatibility
+
 ## [0.1.0] - 2025-12-17
 
 - Initial release

data/app/controllers/flare/application_controller.rb

@@ -6,10 +6,18 @@ module Flare
 
     layout "flare/application"
 
+    before_action :require_storage
+
     helper_method :show_redis_tab?
 
     private
 
+    def require_storage
+      return if Flare.storage
+
+      render plain: "Flare dashboard requires the sqlite3 gem. Add `gem 'sqlite3'` to your Gemfile.", status: :service_unavailable
+    end
+
     # Only show the Redis tab if:
     # 1. The Redis client library is loaded
     # 2. There are Redis spans in the database

data/app/helpers/flare/application_helper.rb

@@ -53,8 +53,8 @@ module Flare
         { primary: primary, secondary: nil }
       when "http"
         full_url = props["http.url"] || ""
-        target = props["http.target"] || ""
-        host = props["http.host"] || props["net.peer.name"] || props["peer.service"]
+        target = props["url.path"] || props["http.target"] || ""
+        host = props["server.address"] || props["http.host"] || props["net.peer.name"] || props["peer.service"]
         uri = URI.parse(full_url) rescue nil
         if uri && uri.host
           domain = uri.host
@@ -64,8 +64,8 @@ module Flare
           domain = host
           path = target.presence || full_url
         end
-        method = props["http.method"]
-        status = props["http.status_code"]
+        method = props["http.request.method"] || props["http.method"]
+        status = props["http.response.status_code"] || props["http.status_code"]
         { primary: path.to_s.truncate(100), secondary: domain, http_method: method, http_status: status }
       when "mail"
         mailer = props["mailer"]

data/app/views/flare/jobs/show.html.erb

@@ -220,8 +220,8 @@
                     span[:name]
                   end
                 elsif category == "http"
-                  url = props["http.url"] || props["http.target"]
-                  method = props["http.method"]
+                  url = props["http.url"] || props["url.path"]
+                  method = props["http.request.method"]
                   "#{method} #{url}".strip.presence || span[:name]
                 elsif category == "controller"
                   ns = props["code.namespace"]

data/app/views/flare/requests/show.html.erb

@@ -1,9 +1,9 @@
 <%
   # Get root span properties
   root_props = @root_span ? @root_span[:properties] : {}
-  http_method = root_props["http.method"]
-  http_status = root_props["http.status_code"]
-  http_target = root_props["http.target"]
+  http_method = root_props["http.request.method"]
+  http_status = root_props["http.response.status_code"]
+  http_target = root_props["url.path"]
   controller = root_props["code.namespace"]
   action = root_props["code.function"]
 
@@ -51,8 +51,8 @@
 
         # Properties to exclude from "other" section (already shown elsewhere)
         shown_keys = %w[
-          http.method http.status_code http.target http.scheme http.host
-          code.namespace code.function http.route http.user_agent
+          http.request.method http.response.status_code url.path url.scheme server.address
+          code.namespace code.function http.route user_agent.original
         ]
         other_props = root_props.reject { |k, v| shown_keys.include?(k) || v.is_a?(Hash) || v.is_a?(Array) }
       %>
@@ -260,8 +260,8 @@
                     span[:name]
                   end
                 elsif category == "http"
-                  url = props["http.url"] || props["http.target"]
-                  method = props["http.method"]
+                  url = props["http.url"] || props["url.path"]
+                  method = props["http.request.method"]
                   "#{method} #{url}".strip.presence || span[:name]
                 elsif category == "controller"
                   ns = props["code.namespace"]
@@ -387,7 +387,7 @@
         extra = props['identifier'].replace(/.*\/app\/views\//, '');
       } else if (category === 'http') {
         name = 'HTTP';
-        extra = ((props['http.method'] || '') + ' ' + (props['http.url'] || props['http.target'] || '')).trim();
+        extra = ((props['http.request.method'] || '') + ' ' + (props['http.url'] || props['url.path'] || '')).trim();
       }
 
       let line = offset.padStart(8) + ' | ' + duration.padStart(8) + ' | ' + name;

data/lib/flare/metric_span_processor.rb

@@ -156,7 +156,7 @@ module Flare
         bucket: bucket_time(span),
         namespace: "job",
         service: extract_job_system(span),
-        target: transaction_name || span.attributes["code.namespace"] || span.attributes["messaging.destination"] || "unknown",
+        target: transaction_name || span.attributes["code.namespace"] || span.attributes["messaging.sidekiq.job_class"] || span.attributes["messaging.destination"] || "unknown",
         operation: transaction_name ? "perform" : (span.attributes["code.function"] || span.name)
       )
 

data/lib/flare/storage/sqlite.rb

@@ -34,25 +34,25 @@ module Flare
         if status
           case status
           when "2xx"
-            conditions << "status_prop.value LIKE ?"
+            conditions << "COALESCE(status_prop.value, status_prop_old.value) LIKE ?"
             values << "2%"
           when "3xx"
-            conditions << "status_prop.value LIKE ?"
+            conditions << "COALESCE(status_prop.value, status_prop_old.value) LIKE ?"
             values << "3%"
           when "4xx"
-            conditions << "status_prop.value LIKE ?"
+            conditions << "COALESCE(status_prop.value, status_prop_old.value) LIKE ?"
             values << "4%"
           when "5xx"
-            conditions << "status_prop.value LIKE ?"
+            conditions << "COALESCE(status_prop.value, status_prop_old.value) LIKE ?"
             values << "5%"
           else
-            conditions << "status_prop.value = ?"
+            conditions << "COALESCE(status_prop.value, status_prop_old.value) = ?"
             values << status.to_s
           end
         end
 
         if method
-          conditions << "method_prop.value = ?"
+          conditions << "COALESCE(method_prop.value, method_prop_old.value) = ?"
           values << "\"#{method}\""
         end
 
@@ -79,19 +79,22 @@ module Flare
 
         rows = query_all(<<~SQL, values)
           SELECT s.*,
-                 method_prop.value as http_method,
-                 status_prop.value as http_status,
-                 target_prop.value as http_target,
+                 COALESCE(method_prop.value, method_prop_old.value) as http_method,
+                 COALESCE(status_prop.value, status_prop_old.value) as http_status,
+                 COALESCE(target_prop.value, target_prop_old.value) as http_target,
                  controller_prop.value as controller,
                  action_prop.value as action
           FROM flare_spans s
-          LEFT JOIN flare_properties method_prop ON method_prop.owner_type = 'Flare::Span' AND method_prop.owner_id = s.id AND method_prop.key = 'http.method'
-          LEFT JOIN flare_properties status_prop ON status_prop.owner_type = 'Flare::Span' AND status_prop.owner_id = s.id AND status_prop.key = 'http.status_code'
-          LEFT JOIN flare_properties target_prop ON target_prop.owner_type = 'Flare::Span' AND target_prop.owner_id = s.id AND target_prop.key = 'http.target'
+          LEFT JOIN flare_properties method_prop ON method_prop.owner_type = 'Flare::Span' AND method_prop.owner_id = s.id AND method_prop.key = 'http.request.method'
+          LEFT JOIN flare_properties method_prop_old ON method_prop_old.owner_type = 'Flare::Span' AND method_prop_old.owner_id = s.id AND method_prop_old.key = 'http.method'
+          LEFT JOIN flare_properties status_prop ON status_prop.owner_type = 'Flare::Span' AND status_prop.owner_id = s.id AND status_prop.key = 'http.response.status_code'
+          LEFT JOIN flare_properties status_prop_old ON status_prop_old.owner_type = 'Flare::Span' AND status_prop_old.owner_id = s.id AND status_prop_old.key = 'http.status_code'
+          LEFT JOIN flare_properties target_prop ON target_prop.owner_type = 'Flare::Span' AND target_prop.owner_id = s.id AND target_prop.key = 'url.path'
+          LEFT JOIN flare_properties target_prop_old ON target_prop_old.owner_type = 'Flare::Span' AND target_prop_old.owner_id = s.id AND target_prop_old.key = 'http.target'
           LEFT JOIN flare_properties controller_prop ON controller_prop.owner_type = 'Flare::Span' AND controller_prop.owner_id = s.id AND controller_prop.key = 'code.namespace'
           LEFT JOIN flare_properties action_prop ON action_prop.owner_type = 'Flare::Span' AND action_prop.owner_id = s.id AND action_prop.key = 'code.function'
           #{where_clause}
-          AND method_prop.value IS NOT NULL
+          AND COALESCE(method_prop.value, method_prop_old.value) IS NOT NULL
           ORDER BY s.created_at DESC
           LIMIT ? OFFSET ?
         SQL
@@ -352,25 +355,25 @@ module Flare
         if status
           case status
           when "2xx"
-            conditions << "status_prop.value LIKE ?"
+            conditions << "COALESCE(status_prop.value, status_prop_old.value) LIKE ?"
             values << "2%"
           when "3xx"
-            conditions << "status_prop.value LIKE ?"
+            conditions << "COALESCE(status_prop.value, status_prop_old.value) LIKE ?"
             values << "3%"
           when "4xx"
-            conditions << "status_prop.value LIKE ?"
+            conditions << "COALESCE(status_prop.value, status_prop_old.value) LIKE ?"
             values << "4%"
           when "5xx"
-            conditions << "status_prop.value LIKE ?"
+            conditions << "COALESCE(status_prop.value, status_prop_old.value) LIKE ?"
             values << "5%"
           else
-            conditions << "status_prop.value = ?"
+            conditions << "COALESCE(status_prop.value, status_prop_old.value) = ?"
             values << status.to_s
           end
         end
 
         if method
-          conditions << "method_prop.value = ?"
+          conditions << "COALESCE(method_prop.value, method_prop_old.value) = ?"
           values << "\"#{method}\""
         end
 
@@ -396,11 +399,13 @@ module Flare
         row = query_one(<<~SQL, values)
           SELECT COUNT(*) as count
           FROM flare_spans s
-          LEFT JOIN flare_properties method_prop ON method_prop.owner_type = 'Flare::Span' AND method_prop.owner_id = s.id AND method_prop.key = 'http.method'
-          LEFT JOIN flare_properties status_prop ON status_prop.owner_type = 'Flare::Span' AND status_prop.owner_id = s.id AND status_prop.key = 'http.status_code'
+          LEFT JOIN flare_properties method_prop ON method_prop.owner_type = 'Flare::Span' AND method_prop.owner_id = s.id AND method_prop.key = 'http.request.method'
+          LEFT JOIN flare_properties method_prop_old ON method_prop_old.owner_type = 'Flare::Span' AND method_prop_old.owner_id = s.id AND method_prop_old.key = 'http.method'
+          LEFT JOIN flare_properties status_prop ON status_prop.owner_type = 'Flare::Span' AND status_prop.owner_id = s.id AND status_prop.key = 'http.response.status_code'
+          LEFT JOIN flare_properties status_prop_old ON status_prop_old.owner_type = 'Flare::Span' AND status_prop_old.owner_id = s.id AND status_prop_old.key = 'http.status_code'
           LEFT JOIN flare_properties controller_prop ON controller_prop.owner_type = 'Flare::Span' AND controller_prop.owner_id = s.id AND controller_prop.key = 'code.namespace'
           #{where_clause}
-          AND method_prop.value IS NOT NULL
+          AND COALESCE(method_prop.value, method_prop_old.value) IS NOT NULL
         SQL
 
         row ? row["count"] : 0

data/lib/flare/version.rb

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

data/lib/flare.rb

@@ -67,7 +67,9 @@ module Flare
       require_relative "flare/sqlite_exporter"
       SQLiteExporter.new(configuration.database_path)
     rescue LoadError
-      raise LoadError, "Flare spans require the sqlite3 gem. Add `gem 'sqlite3'` to your Gemfile."
+      warn "[Flare] sqlite3 gem not found. Spans are disabled. Add `gem 'sqlite3'` to your Gemfile to enable the development dashboard."
+      configuration.spans_enabled = false
+      nil
     end
   end
 
@@ -139,7 +141,7 @@ module Flare
       "app"
     end
 
-    # Require only the instrumentations we want
+    # Require flare's bundled instrumentations
     require "opentelemetry-instrumentation-rack"
     require "opentelemetry-instrumentation-net_http"
     require "opentelemetry-instrumentation-active_support"
@@ -158,24 +160,30 @@ module Flare
       c.service_name = service_name
 
       # Spans: detailed trace data stored in SQLite
-      if configuration.spans_enabled
+      if configuration.spans_enabled && exporter
         c.add_span_processor(span_processor)
         log "Spans enabled (database=#{configuration.database_path})"
       end
 
-      # Configure specific instrumentations
-      c.use "OpenTelemetry::Instrumentation::Rack",
-        untraced_requests: ->(env) {
-          request = Rack::Request.new(env)
-          return true if request.path.start_with?("/flare")
-
-          configuration.ignore_request.call(request)
+      # Auto-detect and install all OTel instrumentation gems in the bundle.
+      # Apps can add gems like opentelemetry-instrumentation-sidekiq to their
+      # Gemfile and they'll be picked up automatically.
+      c.use_all(
+        "OpenTelemetry::Instrumentation::Rack" => {
+          untraced_requests: ->(env) {
+            request = Rack::Request.new(env)
+            return true if request.path.start_with?("/flare")
+
+            configuration.ignore_request.call(request)
+          }
+        },
+        # Name Sidekiq job spans after the worker class (e.g. "MyWorker
+        # process") instead of the upstream default of the queue name
+        # ("default process"), matching how ActiveJob spans are named.
+        "OpenTelemetry::Instrumentation::Sidekiq" => {
+          span_naming: :job_class,
         }
-      c.use "OpenTelemetry::Instrumentation::Net::HTTP"
-      c.use "OpenTelemetry::Instrumentation::ActiveSupport"
-      c.use "OpenTelemetry::Instrumentation::ActionPack" if defined?(ActionController)
-      c.use "OpenTelemetry::Instrumentation::ActionView" if defined?(ActionView)
-      c.use "OpenTelemetry::Instrumentation::ActiveJob" if defined?(ActiveJob)
+      )
     end
 
     # Subscribe to common ActiveSupport notification patterns
@@ -188,7 +196,7 @@ module Flare
 
     at_exit do
       log "Shutting down..."
-      if configuration.spans_enabled
+      if configuration.spans_enabled && @span_processor
         span_processor.force_flush
         span_processor.shutdown
         log "Span processor flushed and stopped"
@@ -386,7 +394,9 @@ module Flare
       require_relative "flare/storage/sqlite"
       Storage::SQLite.new(configuration.database_path)
     rescue LoadError
-      raise LoadError, "Flare spans require the sqlite3 gem. Add `gem 'sqlite3'` to your Gemfile."
+      warn "[Flare] sqlite3 gem not found. Dashboard is disabled. Add `gem 'sqlite3'` to your Gemfile to enable it."
+      configuration.spans_enabled = false
+      nil
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flare
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - John Nunemaker