rails_observatory 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f127883108bb93b52d5230b2201ca52356acebf2de4ea62dc9cccf1d1c44d1b6
-  data.tar.gz: 90007d376e64259aad9633c375d7dce81a93d4bec9de7a9a61f9e72d1f39d5ab
+  metadata.gz: 493d740aa5e9922dd611aa3425c2830c4cfaa920a3474d7d58383613cabdaf05
+  data.tar.gz: 982d077e561ce0895f6c722d690d9aad3ceaf79302d302dfb7afb544bc07a3bc
 SHA512:
-  metadata.gz: 6a25967194df5b78f63bbb8e380a146706bf345224e3da519da64556639d9ec9e37cad25a9332d224ea47f4336ae260e74272e69d6ee8498787f3cafdd498432
-  data.tar.gz: c847561c550175312c4442930dc65a2523dec1c915c97387e3858bf1396c38d262e498f849fc6ca108cb0f8316a69df09138b9844be6f3e55902db18b9134775
+  metadata.gz: af0cdab142f36284b8265a1953a4a1663ebf86f267be6854a50a6e61ab213bc5067f38159c61095f1e4ddae5b191e995fac6e902f9febc7c494a81b854555f67
+  data.tar.gz: 3e38d9ba1e846b8648eeb714dbe89c39fcca3a216ec050dcda1cebf09a3d19b059b1949013ce8ecc4a5afec018aee1114648f00f42642f3491b4f38ec1f082d1

data/README.md

@@ -1,6 +1,6 @@
 # Rails Observatory
 
-Simple observability for your Rails app.
+Observability for your Rails app.
 
 Rails observatory hooks into ActiveSupport::Instrumentation
 with [RedisStack](https://redis.io/docs/about/about-stack/) to provide
@@ -38,5 +38,4 @@ Pull requests, issues and more are welcome!
 
 ## License
 
-The gem is available as open source under the terms of the LGPL v2 License.
-If you'd like a commercial license, please contact me mark.godwin@hey.com
+The gem is available as open source under the terms of the MIT License.

data/app/assets/js/controllers/chart_controller.js

@@ -1,7 +1,7 @@
 import {Controller} from "@hotwired/stimulus";
 import Apexcharts from "apexcharts";
 
-const icicleChartOptions = function(controller) {
+const icicleChartOptions = function (controller) {
   return {
     chart: {
       id: controller.element.id,
@@ -9,10 +9,12 @@ const icicleChartOptions = function(controller) {
       type: 'rangeBar',
       height: 300,
       events: {
-        dataPointSelection: function(event, chartContext, config) {
-          controller.dispatch('selected', {detail: {
+        dataPointSelection: function (event, chartContext, config) {
+          controller.dispatch('selected', {
+            detail: {
               ...config.w.config.series[config.seriesIndex].data[config.dataPointIndex]
-            }})
+            }
+          })
         }
       },
     },
@@ -69,8 +71,12 @@ const icicleChartOptions = function(controller) {
         const seriesSelfTime = controller.series()[opts.seriesIndex].data.reduce((acc, val) => {
           return acc + val['event_self_time']
         }, 0)
-        console.log(controller.series()[opts.seriesIndex].name, controller.series()[opts.seriesIndex].data);
-        const totalSelfTime = controller.series().reduce((acc, val) => { return acc + val.data.reduce((acc, val) => { return acc + val['event_self_time'] }, 0) }, 0)
+        // console.log(controller.series()[opts.seriesIndex].name, controller.series()[opts.seriesIndex].data);
+        const totalSelfTime = controller.series().reduce((acc, val) => {
+          return acc + val.data.reduce((acc, val) => {
+            return acc + val['event_self_time']
+          }, 0)
+        }, 0)
         const percent = seriesSelfTime / totalSelfTime * 100
         return `${seriesName} <span class="percent">${seriesSelfTime.toFixed(1)}ms <div class="bar"><div  style="width:${percent.toFixed(1)}%"></div></div></span> `
       },
@@ -97,7 +103,7 @@ const icicleChartOptions = function(controller) {
 
 }
 
-const defaultOptions = function(controller) {
+const defaultOptions = function (controller) {
   return {
     chart: {
       id: controller.element.id,
@@ -126,14 +132,6 @@ const defaultOptions = function(controller) {
         opacityTo: 0
       }
     },
-    theme: {
-      monochrome: {
-        enabled: true,
-        color: '#0c8be8',
-        shadeTo: 'dark',
-        shadeIntensity: 0.65
-      }
-    },
     stroke: {
       width: 2,
       curve: 'straight'
@@ -142,6 +140,17 @@ const defaultOptions = function(controller) {
 
 }
 
+function stackedAreaOptions(controller) {
+  return {
+    ...defaultOptions(controller),
+    chart: {
+      ...defaultOptions(controller).chart,
+      type: 'area',
+      stacked: true,
+    },
+  }
+}
+
 export class ChartController extends Controller {
   static targets = ["chart", "data"]
 
@@ -157,6 +166,8 @@ export class ChartController extends Controller {
     switch (this.typeValue) {
       case 'icicle':
         return icicleChartOptions(this)
+      case 'stackedArea':
+        return stackedAreaOptions(this)
       default:
         return defaultOptions(this)
     }

data/app/helpers/rails_observatory/application_helper.rb

@@ -14,8 +14,13 @@ module RailsObservatory
       html.to_html
     end
 
-    def series_for(name:, aggregate_using:, time_range: nil, downsample: 120,  **opts)
-      series = RailsObservatory::TimeSeries.where(name:, **opts).downsample(downsample, using: aggregate_using)
+    def series_for(name:, aggregate_using:, time_range: nil, downsample: 60, children: false,  **opts)
+      if children
+        series = TimeSeries.where(parent: name, **opts)
+      else
+        series = TimeSeries.where(name:, **opts)
+      end
+      series = series.downsample(downsample, using: aggregate_using)
       series = series.slice(time_range) if time_range
       series
     end

data/app/views/rails_observatory/requests/index.html.erb

@@ -11,9 +11,8 @@
 <div class="layout-requests_index-chart">
   <%= render 'chart', name: 'Requests', type: 'bar', series: series_for(name: 'request.count', aggregate_using: :sum, action: params[:controller_action]) %>
   <%= render 'chart', name: 'Latency', type: 'area', series: series_for(name: 'request.latency', aggregate_using: :avg, action: params[:controller_action]) %>
-
-<%#= render 'chart', name: "Latency Breakdown", series: @latency_composition, type: 'area' %>
-<%#= render 'chart', name: 'Errors', series: @errors, type: 'bar', palette: 'palette7' %>
+  <%= render 'chart', name: "Latency Breakdown", series: series_for(name: 'request.latency', aggregate_using: :avg, compaction: :avg, action: params[:controller_action], children: true), type: 'stackedArea' %>
+  <%= render 'chart', name: 'Errors', series: series_for(name: 'request.error_count', aggregate_using: :sum, action: params[:controller_action]), type: 'bar' %>
 </div>
 <% if params[:controller_action].blank? %>
   <section class="layout-requests_index-by_controller">

data/lib/rails_observatory/middleware.rb

@@ -48,6 +48,7 @@ module RailsObservatory
       status, headers, body = response
       body = ::Rack::BodyProxy.new(body) do
         duration = (Process.clock_gettime(Process::CLOCK_MONOTONIC, :float_millisecond) - start_at_mono)
+        serialized_events = events.map { Serializer.serialize(_1) }
         RequestTrace.new(
           request_id: request.request_id,
           status:,
@@ -59,13 +60,16 @@ module RailsObservatory
           duration:,
           time: start_at.to_f,
           path: request.path,
-          events: events.map { Serializer.serialize(_1) },
+          events: serialized_events,
           logs:
         ).save
         labels = { action: controller_action, format: request.format, status:, http_method: request.method }
         TimeSeries.record_occurrence("request.count", labels:)
         TimeSeries.record_occurrence("request.error_count", labels:) if status >= 500
         TimeSeries.record_timing("request.latency", duration, labels:)
+        EventCollection.new(serialized_events).self_time_by_library.each do |library, self_time|
+          TimeSeries.record_timing("request.latency/#{library}", self_time, labels: { action: controller_action })
+        end
       rescue => e
         puts e
         puts e.backtrace.join("\n")

data/lib/rails_observatory/models/event_collection.rb

@@ -65,6 +65,13 @@ module RailsObservatory
       end
     end
 
+    def self_time_by_library
+      each_with_object(Hash.new(0)) do |event, hash|
+        library = event['name'].split('.').last
+        hash[library] += event['self_time']
+      end
+    end
+
 
 
     private

data/lib/rails_observatory/redis/time_series/query_builder.rb

@@ -127,10 +127,11 @@ module RailsObservatory
       end
 
       def ts_filters
-        raise 'Must specify name' if @conditions[:name].blank?
+        root_labels = @conditions[:name] || @conditions[:parent]
+        raise 'Must specify name or parent' if @conditions[:name].blank? && @conditions[:parent].blank?
 
         @conditions[@group] = "*" if @group
-        labels = @series_class.redis.call('SMEMBERS', "#{@conditions[:name]}:labels")
+        labels = @series_class.redis.call('SMEMBERS', "#{root_labels}:labels")
         labels = labels.map { |l| [l.to_sym, nil] }.to_h
         @conditions.reverse_merge!(labels)
         @conditions.map do |k, v|

data/lib/rails_observatory/redis/time_series/timing_script.lua

@@ -9,7 +9,7 @@ local function generate_key_combinations(keys)
       for i = start_idx, n do
         local new_comb = {}
         for _, v in ipairs(curr_comb) do
-            table.insert(new_comb, v)
+          table.insert(new_comb, v)
         end
         table.insert(new_comb, keys[i])
         table.insert(combs, new_comb)
@@ -36,7 +36,7 @@ local metric_name = tostring(ARGV[1])  -- Ensure it's a string
 local value_to_add = tonumber(ARGV[2]) -- Ensure it's a number
 local raw_retention = 10000 -- Hardcoded to 10ms
 local compaction_retention = 31536000000 -- Hardcoded to 1 year in ms (365*24*60*60*1000)
-local compactions = {"avg", "min", "max"}
+local compactions = { "avg", "min", "max" }
 
 -- Assuming base_name is defined somewhere above
 local parent_label = extract_parent_label(metric_name)
@@ -44,11 +44,15 @@ local parent_label = extract_parent_label(metric_name)
 -- Extracting labels
 local labels = {}
 local keys = {}
-for i=3, #ARGV, 2 do
+for i = 3, #ARGV, 2 do
   local key = tostring(ARGV[i])
-  local value = tostring(ARGV[i+1])
+  local value = tostring(ARGV[i + 1])
   labels[key] = value
-  redis.call("SADD", metric_name .. ':labels', key)
+  if parent_label then
+    redis.call("SADD", parent_label .. ':labels', key)
+  else
+    redis.call("SADD", metric_name .. ':labels', key)
+  end
   table.insert(keys, key)
 end
 
@@ -78,9 +82,8 @@ for _, comb_keys in ipairs(key_combinations) do
   for _, compaction in ipairs(compactions) do
     local compaction_key = ts_name .. "_" .. compaction
     if redis.call("EXISTS", compaction_key) == 0 then
-      redis.call("TS.CREATE", compaction_key, "RETENTION", compaction_retention, "CHUNK_SIZE", 48, "LABELS","name", metric_name, "compaction", compaction, unpack(label_set))
+      redis.call("TS.CREATE", compaction_key, "RETENTION", compaction_retention, "CHUNK_SIZE", 48, "LABELS", "name", metric_name, "compaction", compaction, unpack(label_set))
       redis.call("TS.CREATERULE", ts_name, compaction_key, "AGGREGATION", compaction, 10000)
-      return redis.call("TS.INFO", compaction_key)
     end
   end
   redis.call("TS.ADD", ts_name, "*", value_to_add)

data/lib/rails_observatory/serializers/serializer.rb

@@ -34,7 +34,7 @@ module RailsObservatory
         when Symbol
           argument.to_s
         else
-          ADDITIONAL_SERIALIZERS.find { argument.is_a?(_1.klass) }&.new&.serialize(argument) || "Unable to serialize #{argument.class.name}"
+          ADDITIONAL_SERIALIZERS.find { argument.is_a?(_1.klass) }&.new&.serialize(argument)&.deep_stringify_keys || "Unable to serialize #{argument.class.name}"
         end
       end
 
@@ -42,7 +42,7 @@ module RailsObservatory
         argument.each_with_object({}) do |(key, value), hash|
           case key
           when String, Symbol
-            hash[key] = serialize_payload(value)
+            hash[key.to_s] = serialize_payload(value)
           end
         end
       end

data/lib/rails_observatory/version.rb

@@ -1,3 +1,3 @@
 module RailsObservatory
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/public/assets/js/application.js

@@ -10850,9 +10850,11 @@
         height: 300,
         events: {
           dataPointSelection: function(event, chartContext, config) {
-            controller.dispatch("selected", { detail: {
-              ...config.w.config.series[config.seriesIndex].data[config.dataPointIndex]
-            } });
+            controller.dispatch("selected", {
+              detail: {
+                ...config.w.config.series[config.seriesIndex].data[config.dataPointIndex]
+              }
+            });
           }
         }
       },
@@ -10903,7 +10905,6 @@
           const seriesSelfTime = controller.series()[opts.seriesIndex].data.reduce((acc, val) => {
             return acc + val["event_self_time"];
           }, 0);
-          console.log(controller.series()[opts.seriesIndex].name, controller.series()[opts.seriesIndex].data);
           const totalSelfTime = controller.series().reduce((acc, val) => {
             return acc + val.data.reduce((acc2, val2) => {
               return acc2 + val2["event_self_time"];
@@ -10962,20 +10963,22 @@
           opacityTo: 0
         }
       },
-      theme: {
-        monochrome: {
-          enabled: true,
-          color: "#0c8be8",
-          shadeTo: "dark",
-          shadeIntensity: 0.65
-        }
-      },
       stroke: {
         width: 2,
         curve: "straight"
       }
     };
   };
+  function stackedAreaOptions(controller) {
+    return {
+      ...defaultOptions(controller),
+      chart: {
+        ...defaultOptions(controller).chart,
+        type: "area",
+        stacked: true
+      }
+    };
+  }
   var ChartController = class extends Controller {
     static targets = ["chart", "data"];
     static values = {
@@ -10989,6 +10992,8 @@
       switch (this.typeValue) {
         case "icicle":
           return icicleChartOptions(this);
+        case "stackedArea":
+          return stackedAreaOptions(this);
         default:
           return defaultOptions(this);
       }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_observatory
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Mark Godwin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-09 00:00:00.000000000 Z
+date: 2024-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faker
@@ -66,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Observability for Rails Apps
+description: See what's happening in your Rails App
 email:
 - mark.godwin@hey.com
 executables: []
@@ -193,5 +193,5 @@ requirements: []
 rubygems_version: 3.4.13
 signing_key:
 specification_version: 4
-summary: Observability for Rails Apps
+summary: See what's happening in your Rails App
 test_files: []