pack_stats 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f84f807ac7cd49095073c3da4a5f99fd2a4ba84a56b9740eb6d039ab310f720
-  data.tar.gz: 538a48f38b02506d4841c5f1c2be9d117c9623cc137315d353bb82547762cfe6
+  metadata.gz: 60677361991af3d26c3e99c8869f07d92bd4be100ca7247b17ea89e898de4537
+  data.tar.gz: 10f3807f7d6641cc8228ea824167aa284d58f69375f27d2f623235d532f3d3ba
 SHA512:
-  metadata.gz: 9396f5f105aaadadcc5260d8eaf5beaa3bcc35bf053261b3c73c2c07bfe7e95d0a92e524e110ae842ed8507d87fa1581a76db95c097cae7d1e4da9a7b46b7c9c
-  data.tar.gz: bf1650ae0da82fcfdb29d25b09359c9f112aeb2a395b339f7a162d0963491b2fc0ccec54aa1e52ba178669c505023c301d456cf468372d9233fa2c3bdc93e42c
+  metadata.gz: 9757afa0869a454e6b0569b0004a66341c5f4f15d015f530c94397a510b379823593efd7242ceaa6b142b4156827d7aaee32047227686973342baa85d6f9c809
+  data.tar.gz: 33bbcbbaf89cc0ff2de1ccce13b472b51c321dac78bcab9726aeadb568512c2cd0f2bcb5aefec7f10c18db2020658752967cc7d9c60969c685df8474cffeaa80

data/README.md

@@ -2,6 +2,9 @@
 
 This gem is used to report opinionated statistics about modularization to DataDog and other observability systems.
 
+# Configuring Packs
+This gem assumes you've correctly configured the [`packs`](https://github.com/rubyatscale/packs#configuration) gem so that `pack_stats` knows where to find your code's packs.
+
 # Configuring Ownership
 The gem reports metrics per-team, where each team is configured based on metadata included in Packwerk package.yml files.
 
@@ -62,13 +65,7 @@ namespace(:modularization) do
     # `enforce_dependencies` and `enforce_privacy` set to true, then update deprecations.
     old_packages = ParsePackwerk.all
     old_packages.each do |package|
-      new_package = ParsePackwerk::Package.new(
-        dependencies: package.dependencies,
-        enforce_dependencies: true,
-        enforce_privacy: true,
-        metadata: package.metadata,
-        name: package.name
-      )
+      new_package = package.with(enforce_dependencies: true, enforce_privacy: true)
       ParsePackwerk.write_package_yml!(new_package)
     end
 
@@ -76,14 +73,7 @@ namespace(:modularization) do
 
     # Now we reset it back so that the protection values are the same as the native packwerk configuration
     old_packages.each do |package|
-      new_package = ParsePackwerk::Package.new(
-        dependencies: package.dependencies,
-        enforce_dependencies: package.enforce_dependencies,
-        enforce_privacy: package.enforce_privacy,
-        metadata: package.metadata,
-        name: package.name
-      )
-      ParsePackwerk.write_package_yml!(new_package)
+      ParsePackwerk.write_package_yml!(package)
     end
 
     PackStats.report_to_datadog!(
@@ -98,7 +88,7 @@ end
 
 # Using Other Observability Tools
 
-Right now this tool sends metrics to DataDog early. However, if you want to use this with other tools, you can call `PackStats.get_metrics(...)` to get generic metrics that you can then send to whatever observability provider you use.
+Right now this tool sends metrics to DataDog only. However, if you want to use this with other tools, you can call `PackStats.get_metrics(...)` to get generic metrics that you can then send to whatever observability provider you use.
 
 # Setting Up Your Dashboards
 

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.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-29 00:00:00.000000000 Z
+date: 2023-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_teams
@@ -202,17 +202,6 @@ files:
 - lib/pack_stats/private/source_code_file.rb
 - lib/pack_stats/tag.rb
 - lib/pack_stats/tags.rb
-- sorbet/config
-- sorbet/rbi/gems/ast@2.4.2.rbi
-- sorbet/rbi/gems/code_ownership@1.29.2.rbi
-- sorbet/rbi/gems/code_teams@1.0.0.rbi
-- sorbet/rbi/gems/dogapi@1.45.0.rbi
-- sorbet/rbi/gems/manual.rbi
-- sorbet/rbi/gems/packs@0.0.5.rbi
-- sorbet/rbi/gems/parse_packwerk@0.16.0.rbi
-- sorbet/rbi/gems/rspec@3.10.0.rbi
-- sorbet/rbi/gems/rubocop-packs@0.0.30.rbi
-- sorbet/rbi/todo.rbi
 homepage: https://github.com/rubyatscale/pack_stats
 licenses:
 - MIT

data/sorbet/config

@@ -1,4 +0,0 @@
---dir
-.
---ignore=/vendor/bundle
---enable-experimental-requires-ancestor