jirametrics 2.9.1pre1 → 2.10pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c87abf98bf68d70050c43537ea6cc58e07afdd780d472b8b6f31e40467739300
-  data.tar.gz: cc9933a325414413446cf5e43231432869e8e2c114f8d76c4ec51e1e0bcd6b3b
+  metadata.gz: 61592efc6953979c52dcf6798aec717b51e3b1c1a78d2d79db9f4715a554c926
+  data.tar.gz: 2eca3045f51a62ee94c83d76e46c808db86ba34c0eb7fc6691284d8de0d5544d
 SHA512:
-  metadata.gz: ea7f38ef5c9ce0fc3102aec0a6b03b37c5b49fb4518cc800d71520f991bc06ee5e62981e130529d8b9ab4e0737c40930474313499fcf33de9acc52584b42769f
-  data.tar.gz: 85050e6890af3a3f49d710da97330b54e5b0b719b09871be938bd74ced7d95bc5cfaa5dc9ee7bcef31dae48e767a2ff5c4b36ca8500c1ae14d8d687a70500407
+  metadata.gz: c34d8f657119ef2118a2945822724a0f23534e914a41cedb2e95f05b4a921d3039ff937dc4bdc7fe7408ec503f9f057d04ea78956e221a59ba324b7ea24fcb00
+  data.tar.gz: d474eaf1afee67bc9181e446d23ba978bda2a2abeea1968dfe2623e255505f82b923bf7da9574b52f06c35ae526cab3e8b8d269cd3edd4521e5a5cbc9e33ab73

data/lib/jirametrics/cycletime_histogram.rb

@@ -5,10 +5,14 @@ require 'jirametrics/groupable_issue_chart'
 class CycletimeHistogram < ChartBase
   include GroupableIssueChart
   attr_accessor :possible_statuses
+  attr_reader :show_stats
 
   def initialize block
     super()
 
+    percentiles [50, 85, 98]
+    @show_stats = true
+
     header_text 'Cycletime Histogram'
     description_text <<-HTML
       <p>
@@ -26,6 +30,15 @@ class CycletimeHistogram < ChartBase
     end
   end
 
+  def percentiles percs = nil
+    @percentiles = percs unless percs.nil?
+    @percentiles
+  end
+
+  def disable_stats
+    @show_stats = false
+  end
+
   def run
     stopped_issues = completed_issues_in_range include_unstarted: true
 
@@ -33,10 +46,16 @@ class CycletimeHistogram < ChartBase
     histogram_issues = stopped_issues.select { |issue| issue.board.cycletime.started_stopped_times(issue).first }
     rules_to_issues = group_issues histogram_issues
 
+    the_stats = {}
+
     data_sets = rules_to_issues.keys.collect do |rules|
+      the_issue_type = rules.label
+      the_histogram = histogram_data_for(issues: rules_to_issues[rules])
+      the_stats[the_issue_type] = stats_for histogram_data: the_histogram, percentiles: @percentiles if @show_stats
+
       data_set_for(
-        histogram_data: histogram_data_for(issues: rules_to_issues[rules]),
-        label: rules.label,
+        histogram_data: the_histogram,
+        label: the_issue_type,
         color: rules.color
       )
     end
@@ -55,6 +74,48 @@ class CycletimeHistogram < ChartBase
     count_hash
   end
 
+  def stats_for histogram_data:, percentiles: []
+    return {} if histogram_data.empty?
+
+    total_values = histogram_data.values.sum
+
+    # Calculate the average
+    weighted_sum = histogram_data.reduce(0) { |sum, (value, frequency)| sum + (value * frequency) }
+    average = total_values.zero? ? 0 : weighted_sum.to_f / total_values
+
+    # Find the mode (or modes!) and the spread of the distribution
+    sorted_histogram = histogram_data.sort_by { |_value, frequency| frequency }
+    max_freq = sorted_histogram[-1][1]
+    mode = sorted_histogram.select { |_v, f| f == max_freq }
+
+    minmax = histogram_data.keys.minmax
+
+    # Calculate percentiles
+    sorted_values = histogram_data.keys.sort
+    cumulative_counts = {}
+    cumulative_sum = 0
+
+    sorted_values.each do |value|
+      cumulative_sum += histogram_data[value]
+      cumulative_counts[value] = cumulative_sum
+    end
+
+    percentile_results = {}
+    percentiles.each do |percentile|
+      rank = (percentile / 100.0) * total_values
+      percentile_value = sorted_values.find { |value| cumulative_counts[value] >= rank }
+      percentile_results[percentile] = percentile_value
+    end
+
+    {
+      average: average,
+      mode: mode.collect(&:first).sort,
+      min: minmax[0],
+      max: minmax[1],
+      percentiles: percentile_results
+    }
+  end
+
   def data_set_for histogram_data:, label:, color:
     keys = histogram_data.keys.sort
     {

data/lib/jirametrics/downloader.rb

@@ -103,8 +103,6 @@ class Downloader
       json = @jira_gateway.call_url relative_url: '/rest/api/2/search' \
         "?jql=#{escaped_jql}&maxResults=#{max_results}&startAt=#{start_at}&expand=changelog&fields=*all"
 
-      exit_if_call_failed json
-
       json['issues'].each do |issue_json|
         issue_json['exporter'] = {
           'in_initial_query' => initial_query
@@ -139,15 +137,6 @@ class Downloader
     end
   end
 
-  def exit_if_call_failed json
-    # Sometimes Jira returns the singular form of errorMessage and sometimes the plural. Consistency FTW.
-    return unless json['error'] || json['errorMessages'] || json['errorMessage']
-
-    log "Download failed. See #{@file_system.logfile_name} for details.", both: true
-    log "  #{JSON.pretty_generate(json)}"
-    exit 1
-  end
-
   def download_statuses
     log '  Downloading all statuses', both: true
     json = @jira_gateway.call_url relative_url: '/rest/api/2/status'
@@ -188,8 +177,6 @@ class Downloader
     log "  Downloading board configuration for board #{board_id}", both: true
     json = @jira_gateway.call_url relative_url: "/rest/agile/1.0/board/#{board_id}/configuration"
 
-    exit_if_call_failed json
-
     @file_system.save_json(
       json: json,
       filename: File.join(@target_path, "#{file_prefix}_board_#{board_id}_configuration.json")
@@ -213,7 +200,6 @@ class Downloader
     while is_last == false
       json = @jira_gateway.call_url relative_url: "/rest/agile/1.0/board/#{board_id}/sprint?" \
         "maxResults=#{max_results}&startAt=#{start_at}"
-      exit_if_call_failed json
 
       @file_system.save_json(
         json: json,

data/lib/jirametrics/exporter.rb

@@ -116,7 +116,9 @@ class Exporter
 
   def jira_config filename = nil
     if filename
-      @jira_config = file_system.load_json(filename)
+      @jira_config = file_system.load_json(filename, fail_on_error: false)
+      raise "Unable to load Jira configuration file and cannot continue: #{filename.inspect}" if @jira_config.nil?
+
       @jira_config['url'] = $1 if @jira_config['url'] =~ /^(.+)\/+$/
     end
     @jira_config

data/lib/jirametrics/file_config.rb

@@ -66,15 +66,20 @@ class FileConfig
   # is that all empty values in the first column should be at the bottom.
   def sort_output all_lines
     all_lines.sort do |a, b|
+      result = nil
       if a[0] == b[0]
-        a[1..] <=> b[1..]
+        result = a[1..] <=> b[1..]
       elsif a[0].nil?
-        1
+        result = 1
       elsif b[0].nil?
-        -1
+        result = -1
       else
-        a[0] <=> b[0]
+        result = a[0] <=> b[0]
       end
+
+      # This will only happen if one of the objects isn't comparable. Seen in production.
+      result = -1 if result.nil?
+      result
     end
   end
 

data/lib/jirametrics/file_system.rb

@@ -35,6 +35,10 @@ class FileSystem
     log "Warning: #{message}", more: more, also_write_to_stderr: true
   end
 
+  def error message, more: nil
+    log "Error: #{message}", more: more, also_write_to_stderr: true
+  end
+
   def log message, more: nil, also_write_to_stderr: false
     message += " See #{logfile_name} for more details about this message." if more
 

data/lib/jirametrics/html/cycletime_histogram.erb

@@ -1,6 +1,57 @@
 <div class="chart">
   <canvas id="<%= chart_id %>" width="<%= canvas_width %>" height="<%= canvas_height %>"></canvas>
 </div>
+<%
+if show_stats 
+  link_id = next_id
+  issues_id = next_id
+%>
+[<a id='<%= link_id %>' href="#" onclick='expand_collapse("<%= link_id %>", "<%= issues_id %>"); return false;'>Show details</a>]
+<div id="<%= issues_id %>" style="display: none;">
+  <div>
+     <table class="standard">
+      <tr>
+        <th>Issue Type</th>
+        <th>Min</th>
+        <th>Max</th>
+        <th>Avg</th>
+        <th>Mode</th>
+        <% percentiles.each do |p| %>
+           <th><%= p %>th</th>
+        <% end %>
+      </tr>
+      <% the_stats.each do |k, v| %>
+          <tr>
+            <td><%= k %></td>
+            <td><%= v[:min] %></td>
+            <td><%= v[:max] %></td>
+            <td><%= sprintf('%.2f', v[:average]) %></td>
+            <td><%= v[:mode].join(', ') %></td>
+            <% percentiles.each do |p| %>
+               <td><%= v[:percentiles][p] %></td>
+            <% end %>
+          </tr>
+       <% end %>
+     </table>
+  </div>
+  <div>
+    <p>These statistics help understand the <i>"shape"</i> of the cycletime histogram distribution, to help us with predictions.</p>
+    <ul>
+      <li><b>Min & Max:</b> the observed spread for the data set. Useful to judge how wide the variation is. </li>
+      <li><b>Average:</b> the arithmetic mean of the data set. Useful as a <i>"typical representative"</i> of the complete set.</li>
+      <li><b>Mode:</b> the most repeated value(s) in the data set. This is the value we're most likely to remember. </li>
+      <li><b>Percentiles:</b> they partition the data set. If X is the Nth percentile, it means that N% of cycletime values are X or less. Typical percentiles of interest are:</li>
+      <ul>
+        <li><b>50%</b>: also known as the <b>Median</b>. Useful to establish short feedback loops, to monitor that it's not drifting to the right.</li>
+        <li><b>85%</b>: useful to establish service level expectations, accounting for rare events..</li>
+        <li><b>98% (or higher)</b>: useful to gauge worst case expectations..</li>
+      </ul>
+    </ul>
+  </div>
+</div>
+<%
+end
+%>
 <script>
 new Chart(document.getElementById('<%= chart_id %>').getContext('2d'),
 {

data/lib/jirametrics/jira_gateway.rb

@@ -14,9 +14,15 @@ class JiraGateway
   def call_url relative_url:
     command = make_curl_command url: "#{@jira_url}#{relative_url}"
     result = call_command command
-    JSON.parse result
-  rescue => e # rubocop:disable Style/RescueStandardError
-    raise "Error #{e.message.inspect} when parsing result: #{result.inspect}"
+    begin
+      json = JSON.parse(result)
+    rescue # rubocop:disable Style/RescueStandardError
+      raise "Error when parsing result: #{result.inspect}"
+    end
+
+    raise "Download failed with: #{JSON.pretty_generate(json)}" unless json_successful?(json)
+
+    json
   end
 
   def call_command command
@@ -61,4 +67,11 @@ class JiraGateway
     command << " --url \"#{url}\""
     command
   end
+
+  def json_successful? json
+    return false if json.is_a?(Hash) && (json['error'] || json['errorMessages'] || json['errorMessage'])
+    return false if json.is_a?(Array) && json.first == 'errorMessage'
+
+    true
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: jirametrics
 version: !ruby/object:Gem::Version
-  version: 2.9.1pre1
+  version: 2.10pre1
 platform: ruby
 authors:
 - Mike Bowler
 bindir: bin
 cert_chain: []
-date: 2025-01-21 00:00:00.000000000 Z
+date: 2025-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: random-word