buildkite-test_collector 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '096d9a186b77909ac11460179d43bb4e57fd76ebea603f0d35d105264ae65793'
-  data.tar.gz: cc16f83917301ec0e20640545a985a800064777e549f434dfb56f9152efd2482
+  metadata.gz: 0e8ff4ceff4d825291a8878bf19a912362d45c36d6750c5e14628f446cec0bbd
+  data.tar.gz: 215441296a3c91547b0c43b062893239fbe5bae5ca2e1a80cca7b2ec65277e77
 SHA512:
-  metadata.gz: 58375f6b3c26113dc18d5af87b785a891b70045c657621450baaa959120ae36923732cb8992942148c0cfe2eaf199ae9e5e675e7199000f8e39aa6ed4717ab3e
-  data.tar.gz: b4bd0aa37da33506ae7bfe297497230a9d87e36aea074ad3e456d32aa2f13eaf76000dc4070fd6ab6ae6dfae00faeb39680c0945b1ffc1c1d9344d93cd82de1a
+  metadata.gz: d31e59e76f2dc92ef5951f9d97663f14cb84d9ba1256c8586931146151222c7ce3769a8913517910312d0a75a7cafb3488f0b9690257c4fc6686fbf37cbed9ee
+  data.tar.gz: 995fc9e592b74a41385058c4eac868e9639f6ef9bfb2ba9068cd156fd6ab5d90bf40aca86a9ab9c8560cf7c9ba80c4f172747a948e4e219976c680d035eae0af

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## v2.6.0
+
+- Trace spans can be filtered by minimum duration #215 - @pda
+
 ## v2.5.0
 
 - Remove ActiveSupport as a primary dependancy #212 - @pat

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    buildkite-test_collector (2.5.0)
+    buildkite-test_collector (2.6.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/buildkite/test_collector/ci.rb

@@ -40,6 +40,7 @@ class Buildkite::TestCollector::CI
       "language_version" => RUBY_VERSION,
       "version" => Buildkite::TestCollector::VERSION,
       "collector" => "ruby-#{Buildkite::TestCollector::NAME}",
+      "trace_min_duration" => Buildkite::TestCollector.trace_min_duration&.to_s,
     }.select { |_, value| !value.nil? }
   end
 

data/lib/buildkite/test_collector/library_hooks/rspec.rb

@@ -16,7 +16,9 @@ RSpec.configure do |config|
   end
 
   config.around(:each) do |example|
-    tracer = Buildkite::TestCollector::Tracer.new
+    tracer = Buildkite::TestCollector::Tracer.new(
+      min_duration: Buildkite::TestCollector.trace_min_duration,
+    )
 
     # The _buildkite prefix here is added as a safeguard against name collisions
     # as we are in the main thread

data/lib/buildkite/test_collector/minitest_plugin.rb

@@ -9,7 +9,11 @@ require_relative "minitest_plugin/trace"
 module Buildkite::TestCollector::MinitestPlugin
   def before_setup
     super
-    tracer = Buildkite::TestCollector::Tracer.new
+
+    tracer = Buildkite::TestCollector::Tracer.new(
+      min_duration: Buildkite::TestCollector.trace_min_duration,
+    )
+
     # The _buildkite prefix here is added as a safeguard against name collisions
     # as we are in the main thread
     Thread.current[:_buildkite_tracer] = tracer

data/lib/buildkite/test_collector/tracer.rb

@@ -35,21 +35,30 @@ module Buildkite::TestCollector
         @children = []
       end
 
+      def duration
+        raise IncompleteSpan if end_at.nil?
+
+        end_at - start_at
+      end
+
       def as_hash
         {
           section: section,
           start_at: start_at,
           end_at: end_at,
-          duration: end_at - start_at,
+          duration: duration,
           detail: detail,
           children: children.map(&:as_hash),
         }
       end
+
+      class IncompleteSpan < StandardError; end
     end
 
-    def initialize
+    def initialize(min_duration: nil)
       @top = Span.new(:top, MonotonicTime.call, nil, {})
       @stack = [@top]
+      @min_duration = min_duration
     end
 
     def enter(section, **detail)
@@ -60,11 +69,16 @@ module Buildkite::TestCollector
 
     def leave
       current_span.end_at = MonotonicTime.call
+      duration = current_span.duration
       @stack.pop
+      current_span.children.pop if @min_duration && duration < @min_duration
+      nil # avoid ambiguous return type/value
     end
 
     def backfill(section, duration, **detail)
-      new_entry = Span.new(section, MonotonicTime.call - duration, MonotonicTime.call, detail)
+      return if @min_duration && duration < @min_duration
+      now = MonotonicTime.call
+      new_entry = Span.new(section, now - duration, now, detail)
       current_span.children << new_entry
     end
 

data/lib/buildkite/test_collector/version.rb

@@ -2,7 +2,7 @@
 
 module Buildkite
   module TestCollector
-    VERSION = "2.5.0"
+    VERSION = "2.6.0"
     NAME = "buildkite-test_collector"
   end
 end

data/lib/buildkite/test_collector.rb

@@ -38,6 +38,7 @@ module Buildkite
       attr_accessor :artifact_path
       attr_accessor :env
       attr_accessor :batch_size
+      attr_accessor :trace_min_duration
     end
 
     def self.configure(hook:, token: nil, url: nil, tracing_enabled: true, artifact_path: nil, env: {})
@@ -47,6 +48,12 @@ module Buildkite
       self.artifact_path = artifact_path
       self.env = env
       self.batch_size = ENV.fetch("BUILDKITE_ANALYTICS_UPLOAD_BATCH_SIZE") { DEFAULT_UPLOAD_BATCH_SIZE }.to_i
+
+      trace_min_ms_string = ENV["BUILDKITE_ANALYTICS_TRACE_MIN_MS"]
+      self.trace_min_duration = if trace_min_ms_string && !trace_min_ms_string.empty?
+        Float(trace_min_ms_string) / 1000
+      end
+
       self.hook_into(hook)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: buildkite-test_collector
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Buildkite
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-21 00:00:00.000000000 Z
+date: 2024-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.10'
-description: 
+description:
 email:
 - support+analytics@buildkite.com
 executables: []
@@ -100,7 +100,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/buildkite/test-collector-ruby
   source_code_uri: https://github.com/buildkite/test-collector-ruby
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -115,8 +115,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Track test executions and report to Buildkite Test Analytics
 test_files: []