pack_stats 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43fc659730748dbbe47795bd71e3b421b746b8a76b1f8fe4c8d058161c3175b6
-  data.tar.gz: f5ad0c0e321f701bd7f426a67faaca0988a00ac5b47c44995139818918e4c540
+  metadata.gz: 60677361991af3d26c3e99c8869f07d92bd4be100ca7247b17ea89e898de4537
+  data.tar.gz: 10f3807f7d6641cc8228ea824167aa284d58f69375f27d2f623235d532f3d3ba
 SHA512:
-  metadata.gz: 2d4d160bc1584c09a97c271a1f45a38b56183730f65c8a9235b85add2eb45e30a2e403ea19a13364b2a5e06fba41bbad4a36fb4e42adab96b205cadb61e117d4
-  data.tar.gz: 99d1de19334442e788ff48e27a3c980891e0cdfffb6327667dd3338e62b45499762e5d55580244fcac6771c87e3c05a93fe3589445c9ed9a09b22072d040a9ba
+  metadata.gz: 9757afa0869a454e6b0569b0004a66341c5f4f15d015f530c94397a510b379823593efd7242ceaa6b142b4156827d7aaee32047227686973342baa85d6f9c809
+  data.tar.gz: 33bbcbbaf89cc0ff2de1ccce13b472b51c321dac78bcab9726aeadb568512c2cd0f2bcb5aefec7f10c18db2020658752967cc7d9c60969c685df8474cffeaa80

data/lib/pack_stats/gauge_metric.rb

@@ -17,10 +17,11 @@ module PackStats
         raise StandardError.new("Metrics names must not exceed 200 characters: #{name}") # rubocop:disable Style/RaiseArgs
       end
 
+      all_tags = [*tags, max_enforcements_tag]
       new(
         name: name,
         count: count,
-        tags: tags
+        tags: all_tags
       )
     end
 
@@ -35,5 +36,16 @@ module PackStats
         other.count == self.count &&
         other.tags == self.tags
     end
+
+    sig { params(tag_value: T::Boolean).void }
+    def self.set_max_enforcements_tag(tag_value)
+      @max_enforcements_tag = T.let(@max_enforcements_tag, T.nilable(Tag))
+      @max_enforcements_tag = Tag.new(key: 'max_enforcements', value: tag_value ? 'true' : 'false')
+    end
+
+    sig { returns(Tag) }
+    def self.max_enforcements_tag
+      @max_enforcements_tag || Tag.new(key: 'max_enforcements', value: 'false')
+    end
   end
 end

data/lib/pack_stats.rb

@@ -39,7 +39,9 @@ module PackStats
       # See note on get_metrics
       packaged_source_code_locations: T.nilable(T::Array[Pathname]),
       # See note on get_metrics
-      use_gusto_legacy_names: T::Boolean
+      use_gusto_legacy_names: T::Boolean,
+      # See note on get_metrics
+      max_enforcements_tag_value: T::Boolean
     ).void
   end
   def self.report_to_datadog!(
@@ -50,7 +52,8 @@ module PackStats
     report_time: Time.now, # rubocop:disable Rails/TimeZone
     verbose: false,
     packaged_source_code_locations: [],
-    use_gusto_legacy_names: false
+    use_gusto_legacy_names: false,
+    max_enforcements_tag_value: false
   )
 
     all_metrics = self.get_metrics(
@@ -58,6 +61,7 @@ module PackStats
       componentized_source_code_locations: componentized_source_code_locations,
       app_name: app_name,
       use_gusto_legacy_names: use_gusto_legacy_names,
+      max_enforcements_tag_value: max_enforcements_tag_value,
     )
 
     # This helps us debug what metrics are being sent
@@ -89,7 +93,12 @@ module PackStats
       # Gusto uses this to preserve historical trends in Dashboards as the names of
       # things changed, but new dashboards can use names that better match current tooling conventions.
       # The behavior of setting this parameter to true might change without warning
-      use_gusto_legacy_names: T::Boolean
+      use_gusto_legacy_names: T::Boolean,
+      # You can set this to `true` to tag all metrics with `max_enforcements:true`.
+      # This is useful if you want to submit two sets of metrics:
+      # Once with the violation counts as configured in the app
+      # Another time with the violation counts after turning on all enforcements and running `bin/packwerk update`.
+      max_enforcements_tag_value: T::Boolean
     ).returns(T::Array[GaugeMetric])
   end
   def self.get_metrics(
@@ -97,8 +106,12 @@ module PackStats
     componentized_source_code_locations:,
     app_name:,
     packaged_source_code_locations: [],
-    use_gusto_legacy_names: false
+    use_gusto_legacy_names: false,
+    max_enforcements_tag_value: false
   )
+
+    GaugeMetric.set_max_enforcements_tag(max_enforcements_tag_value)
+
     all_metrics = Private::DatadogReporter.get_metrics(
       source_code_files: source_code_files(
         source_code_pathnames: source_code_pathnames,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pack_stats
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-06 00:00:00.000000000 Z
+date: 2023-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_teams