dropsonde 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2b344789cd257a8cae81d53150c1ab50fe0cf20716c4fce306446a2c207c7e2
-  data.tar.gz: 563788ccfcf13c75feb8529e4870ba65a0679a1d461eda2413cd401c0c52decd
+  metadata.gz: 91f1b98200a2be8ff60cd36c8f8c3f8186505ddf78642baa92e9a3f964de7018
+  data.tar.gz: a930895cae5b9a4c93ce563394d11f1dce7b9de73365983ce5d9ca0f253d99f6
 SHA512:
-  metadata.gz: 5006cf40dd17e018b6af805ae6192d5cc8b1842b981a4eba6895966a7ace7ee13365b9bae976169adaad1399ee9ca767d10b56cef56542ba5420cd04cecafdb6
-  data.tar.gz: ebda439d8baeec73d04887fb03b745acb2a11b9af8621f8992ad585b9ea9380f4c5732f88a5c17661f8123cba8125dc781d2929302a0954511bd6fae221c78f4
+  metadata.gz: d50ad9535e6b36eefb147ffeadfbe91db4ade2bbf78be6a0ec42a6c9343f2528396ff619a1ce2414f6e7ea27df770e0e691aadf0f5cac79bb10c3cbba5c2b558
+  data.tar.gz: 7978033d3e0a99dda1837d4de3e5f88e8a7a23d0577f7c0e3a281cb3c2cb3d733fb724c5f2488f5b1222601127cb87448cb2f0a4480ebe523b4a1ee9e55d307e

data/CHANGELOG.md

@@ -1,11 +1,44 @@
 # Changelog
 
-## [0.0.7](https://github.com/puppetlabs/dropsonde/tree/0.0.7) (2022-02-10)
+## [0.1.0](https://github.com/OpenVoxProject/dropsonde/tree/0.1.0) (2025-06-10)
 
-[Full Changelog](https://github.com/puppetlabs/dropsonde/compare/v0.0.6...0.0.7)
+[Full Changelog](https://github.com/OpenVoxProject/dropsonde/compare/v0.0.8...0.1.0)
+
+**Breaking changes:**
+
+- remove and abstract Puppet dependency; manually require the gem you want to use [\#1](https://github.com/OpenVoxProject/dropsonde/pull/1) ([binford2k](https://github.com/binford2k))
+
+**Fixed bugs:**
+
+- Fix a couple nil references [\#5](https://github.com/OpenVoxProject/dropsonde/pull/5) ([binford2k](https://github.com/binford2k))
+- fix broken acceptance test [\#4](https://github.com/OpenVoxProject/dropsonde/pull/4) ([binford2k](https://github.com/binford2k))
+
+**Merged pull requests:**
+
+- dependabot: check for github actions and bundler [\#6](https://github.com/OpenVoxProject/dropsonde/pull/6) ([bastelfreak](https://github.com/bastelfreak))
+- workflow housekeeping [\#3](https://github.com/OpenVoxProject/dropsonde/pull/3) ([binford2k](https://github.com/binford2k))
+- No need to run specs nightly [\#2](https://github.com/OpenVoxProject/dropsonde/pull/2) ([binford2k](https://github.com/binford2k))
+
+## [v0.0.8](https://github.com/puppetlabs/dropsonde/tree/0.0.8) (2022-08-29)
+
+[Full Changelog](https://github.com/puppetlabs/dropsonde/compare/v0.0.7...0.0.8)
+
+**Merged pull requests:**
+
+- \[maint\] correct cache [\#29](https://github.com/puppetlabs/dropsonde/pull/29) ([binford2k](https://github.com/binford2k))
+- \[maint\] rubocop style fixes [\#28](https://github.com/puppetlabs/dropsonde/pull/28) ([binford2k](https://github.com/binford2k))
+- Fix example generation [\#27](https://github.com/puppetlabs/dropsonde/pull/27) ([binford2k](https://github.com/binford2k))
+- unused modules [\#26](https://github.com/puppetlabs/dropsonde/pull/26) ([binford2k](https://github.com/binford2k))
+- Adding changelog generation to Rakefile [\#23](https://github.com/puppetlabs/dropsonde/pull/23) ([binford2k](https://github.com/binford2k))
+
+## [v0.0.7](https://github.com/puppetlabs/dropsonde/tree/v0.0.7) (2022-02-10)
+
+[Full Changelog](https://github.com/puppetlabs/dropsonde/compare/v0.0.6...v0.0.7)
 
 **Merged pull requests:**
 
+- Releasing v00.7 [\#22](https://github.com/puppetlabs/dropsonde/pull/22) ([binford2k](https://github.com/binford2k))
+- Releasing v00.7 [\#21](https://github.com/puppetlabs/dropsonde/pull/21) ([binford2k](https://github.com/binford2k))
 - update server language [\#20](https://github.com/puppetlabs/dropsonde/pull/20) ([binford2k](https://github.com/binford2k))
 - Updates the telemetry endpoint to a stable URL [\#19](https://github.com/puppetlabs/dropsonde/pull/19) ([MikaelSmith](https://github.com/MikaelSmith))
 - docs updates now that it's shipped [\#18](https://github.com/puppetlabs/dropsonde/pull/18) ([binford2k](https://github.com/binford2k))

data/bin/dropsonde

@@ -69,14 +69,14 @@ class Dropsonde
   desc 'Submit a telemetry report'
   command :submit do |c|
     c.desc 'Telemetry endpoint'
-    c.flag [:endpoint], :default_value => 'https://updates.puppet.com'
+    c.flag [:endpoint]
 
     c.desc 'Telemetry port'
-    c.flag [:port], :default_value => 443, :type => Integer
+    c.flag [:port], :type => Integer
 
     c.action do |global, options, args|
       @cache.autoupdate
-      Dropsonde.submit_report(options[:endpoint], options[:port])
+      Dropsonde.submit_report(options)
     end
   end
 

data/lib/dropsonde/cache.rb

@@ -7,11 +7,13 @@ require 'puppet_forge'
 
 # cache class
 class Dropsonde::Cache
+  @@cache = nil # rubocop:disable Style/ClassVars
   @autoupdate = false
 
-  def initialize(path, ttl, autoupdate)
+  def initialize(path = '~/.dropsonde', ttl = 7, autoupdate = true) # rubocop:disable Style/OptionalBooleanParameter
+    path = File.expand_path(path)
     FileUtils.mkdir_p(path)
-    @path = "#{File.expand_path(path)}/forge.json"
+    @path = "#{path}/forge.json"
     @ttl  = ttl
     @autoupdate = autoupdate
 
@@ -27,10 +29,14 @@ class Dropsonde::Cache
     PuppetForge.user_agent = 'Dropsonde Telemetry Client/0.0.1'
   end
 
-  def modules
+  def self.modules
     @@cache['modules']
   end
 
+  def modules
+    Dropsonde::Cache.modules
+  end
+
   def cache
     @@cache
   end

data/lib/dropsonde/metrics/dependencies.rb

@@ -71,12 +71,11 @@ class Dropsonde::Metrics::Dependencies
     # make it easier to write data aggregation queries without access to the
     # actual private data that users have submitted.
 
-    dropsonde_cache = Dropsonde::Cache.new('foo', 7, true)
     versions = ['>= 1.5.2', '>= 4.3.2', '>= 3.0.0 < 4.0.0', '>= 2.2.1 < 5.0.0', '>= 5.0.0 < 7.0.0', '>= 4.11.0']
     [
-      dependencies: dropsonde_cache.modules
-                                   .sample(rand(250))
-                                   .map do |item|
+      dependencies: Dropsonde::Cache.modules
+                                    .sample(rand(250))
+                                    .map do |item|
                       {
                         name: item,
                         version_requirement: versions.sample,

data/lib/dropsonde/metrics/modules.rb

@@ -5,6 +5,8 @@ class Dropsonde::Metrics::Modules
   def self.initialize_modules
     # require any libraries needed here -- no need to load puppet; it's already initialized
     # All plugins are initialized before any metrics are generated.
+    require 'puppet/info_service'
+    require 'puppet/info_service/class_information_service'
   end
 
   def self.description
@@ -64,6 +66,46 @@ class Dropsonde::Metrics::Modules
         "name": 'classes',
         "type": 'RECORD',
       },
+      {
+        "fields": [
+          {
+            "description": 'The module name',
+            "mode": 'NULLABLE',
+            "name": 'name',
+            "type": 'STRING',
+          },
+          {
+            "description": 'The module slug (author-name)',
+            "mode": 'NULLABLE',
+            "name": 'slug',
+            "type": 'STRING',
+          },
+          {
+            "description": 'The module version',
+            "mode": 'NULLABLE',
+            "name": 'version',
+            "type": 'STRING',
+          },
+        ],
+        "description": 'List of modules whose classes are not declared in any environments.',
+        "mode": 'REPEATED',
+        "name": 'unused_modules',
+        "type": 'RECORD',
+      },
+      {
+        "fields": [
+          {
+            "description": 'The class name',
+            "mode": 'NULLABLE',
+            "name": 'name',
+            "type": 'STRING',
+          },
+        ],
+        "description": 'List of unused classes in all environments.',
+        "mode": 'REPEATED',
+        "name": 'unused_classes',
+        "type": 'RECORD',
+      },
     ]
   end
 
@@ -86,7 +128,7 @@ class Dropsonde::Metrics::Modules
       end
     }.flatten.compact.uniq
 
-    if puppetdb_session
+    if puppetdb_session&.puppet_db
       # classes and how many nodes they're enforced on
       results = puppetdb_session.puppet_db.request('', 'resources[type, title] { type = "Class" }').data
 
@@ -102,13 +144,45 @@ class Dropsonde::Metrics::Modules
           count: results.count { |row| row['title'] == title },
         }
       }.compact
+
+      # now lets get a list of all classes so we can identify which are unused
+      infoservice = Puppet::InfoService::ClassInformationService.new
+      env_hash = {}
+      environments.each do |env|
+        manifests = Puppet.lookup(:environments).get(env).modules.reduce([]) do |acc, mod|
+          next acc unless mod.forge_module?
+
+          acc.concat mod.all_manifests
+        end
+        env_hash[env] = manifests
+      end
+
+      klasses_per_env = infoservice.classes_per_environment(env_hash)
+
+      installed_classes = klasses_per_env.reduce([]) do |klasses, (_key, env)|
+        names = env.reduce([]) do |acc, (_file, contents)|
+          acc.concat(contents[:classes].map { |c| c[:name] })
+        end
+
+        klasses.concat names
+      end
+
+      unused_modules = installed_classes.map { |c| c.split('::').first }.sort.uniq
+      classes.each { |c| unused_modules.delete(c[:name].split('::').first.downcase) }
+
+      unused_classes = installed_classes.dup
+      classes.each { |c| unused_classes.delete(c[:name].downcase) }
     else
       classes = []
+      unused_modules  = []
+      unused_classes  = []
     end
 
     [
       { modules: modules },
       { classes: classes },
+      { unused_modules: unused_modules },
+      { unused_classes: unused_classes },
     ]
   end
 
@@ -119,25 +193,30 @@ class Dropsonde::Metrics::Modules
 
     versions = ['1.3.2', '0.0.1', '0.1.2', '1.0.0', '3.0.2', '7.10', '6.1.0', '2.1.0', '1.4.0']
     classes = ['', '::Config', '::Service', '::Server', '::Client', '::Packages']
-    dropsonde_cache = Dropsonde::Cache.new('foo', 7, true)
     [
-      modules: dropsonde_cache.modules
-                              .sample(rand(100))
-                              .map do |item|
+      modules: Dropsonde::Cache.modules
+                               .sample(rand(100))
+                               .map do |item|
                  {
                    name: item.split('-').last,
                    slug: item,
                    version: versions.sample,
                  }
                end,
-      classes: dropsonde_cache.modules
-                              .sample(rand(500))
-                              .map do |item|
+      classes: Dropsonde::Cache.modules
+                               .sample(rand(500))
+                               .map do |item|
                  {
                    name: item.split('-').last.capitalize + classes.sample,
                    count: rand(750),
                  }
                end,
+      unused_modules: Dropsonde::Cache.modules
+                                      .sample(rand(500))
+                                      .map { |item| item.split('-').last },
+      unused_classes: Dropsonde::Cache.modules
+                                      .sample(rand(500))
+                                      .map { |item| item.split('-').last.capitalize + classes.sample },
     ]
   end
 

data/lib/dropsonde/metrics/platforms.rb

@@ -54,7 +54,7 @@ class Dropsonde::Metrics::Platforms
 
   def self.run(puppetdb_session = nil)
     # skip this metric if we don't have an active PuppetDB connection
-    return unless puppetdb_session
+    return unless puppetdb_session&.puppet_db
 
     classes = puppetdb_session.puppet_db.request('', 'resources[certname, title] { type = "Class" }').data
     facts   = puppetdb_session.puppet_db.request('', 'facts[certname, value] { name = "osfamily" }').data
@@ -100,10 +100,9 @@ class Dropsonde::Metrics::Platforms
     platforms = %w[RedHat Debian Windows Suse FreeBSD Darwin Archlinux AIX]
     classes   = ['', '::Config', '::Service', '::Server', '::Client', '::Packages']
 
-    dropsonde_cache = Dropsonde::Cache.new('foo', 7, true)
-    data = dropsonde_cache.modules
-                          .sample(rand(35))
-                          .map { |item|
+    data = Dropsonde::Cache.modules
+                           .sample(rand(35))
+                           .map { |item|
       name = item.split('-').last.capitalize + classes.sample
 
       rand(5).times.map do

data/lib/dropsonde/metrics/puppetfiles.rb

@@ -54,7 +54,7 @@ class Dropsonde::Metrics::Puppetfiles
       next unless File.file? puppetfile
 
       tokens  = Ripper.sexp(File.read(puppetfile)).flatten
-      indices = tokens.map.with_index { |a, i| a == :command ? i : nil }.compact
+      indices = tokens.map.with_index { |a, i| (a == :command) ? i : nil }.compact
 
       indices.map { |i| tokens[i + 2] }
     }.flatten.compact

data/lib/dropsonde/metrics.rb

@@ -52,7 +52,7 @@ class Dropsonde::Metrics
 
   def schema
     schema = skeleton_schema
-    Dropsonde::Metrics.plugins.each do |_name, plugin|
+    Dropsonde::Metrics.plugins.each_value do |plugin|
       schema.concat(sanity_check_schema(plugin))
     end
     check_for_duplicates(schema)
@@ -62,7 +62,7 @@ class Dropsonde::Metrics
   def preview(puppetdb_session = nil)
     str = "                      Puppet Telemetry Report Preview\n"
     str += "                      ===============================\n\n"
-    Dropsonde::Metrics.plugins.each do |_name, plugin|
+    Dropsonde::Metrics.plugins.each_value do |plugin|
       schema = plugin.schema
 
       plugin.setup if plugin.respond_to? :setup
@@ -91,7 +91,7 @@ class Dropsonde::Metrics
 
   def report(puppetdb_session = nil)
     snapshots = {}
-    Dropsonde::Metrics.plugins.each do |_name, plugin|
+    Dropsonde::Metrics.plugins.each_value do |plugin|
       plugin.setup
       sanity_check_data(plugin, plugin.run(puppetdb_session)).each do |row|
         snapshots[row.keys.first] = {
@@ -115,7 +115,7 @@ class Dropsonde::Metrics
     results[:ip]         = IPAddr.new(rand(2**32), Socket::AF_INET)
     results.delete(:'self-service-analytics')
 
-    Dropsonde::Metrics.plugins.each do |_name, plugin|
+    Dropsonde::Metrics.plugins.each_value do |plugin|
       sanity_check_data(plugin, plugin.example).each do |row|
         results.merge!(row)
       end

data/lib/dropsonde/submitter/dujour.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# This uses Puppet's standard Dujour telemetry endpoint.
+# It currently expects a report formatted precisely to meet Dujour's odd schema.
+# At some point, we'll define our own report format and this submitter will
+# transform it to meet the expected schema.
+#
+# This is currently the only operational submitter.
+class Dropsonde::Submitter::Dujour
+  def self.submit_report(options)
+    client = HTTPClient.new
+
+    endpoint = options[:endpoint] || Dropsonde.settings[:endpoint] || 'https://updates.puppet.com'
+    port     = options[:port]     || Dropsonde.settings[:port]     || 443
+
+    # The httpclient gem ships with some expired CA certificates.
+    # This causes us to load the certs shipped with whatever
+    # Ruby is used to execute this gem's commands, which are generally
+    # more up-to-date, especially if using puppet-agent's Ruby.
+    #
+    # Note that this is no-op with Windows system Ruby.
+    client.ssl_config.set_default_paths
+
+    result = client.post("#{endpoint}:#{port}",
+                         header: { 'Content-Type' => 'application/json' },
+                         body: Dropsonde::Metrics.new.report.to_json)
+
+    if result.status == 200
+      data = JSON.parse(result.body)
+      if data['newer']
+        puts 'A newer version of the telemetry client is available:'
+        puts "  -- #{data['link']}"
+      else
+        puts data['message']
+      end
+    else
+      puts 'Failed to submit report'
+      puts JSON.pretty_generate(result.body) if Dropsonde.settings[:verbose]
+      exit 1
+    end
+  end
+end

data/lib/dropsonde/submitter/open_telemetry.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# This currently doesn't actually exist.
+# It's just a placeholder for someday when it does exist!
+class Dropsonde::Submitter::OpenTelemetry
+  def self.submit_report(options)
+    puts 'When Vox Pupuli has its own telemetry server, this will post there.'
+    puts options.inspect
+  end
+end

data/lib/dropsonde/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Dropsonde
-  VERSION = '0.0.7'
+  VERSION = '0.1.0'
 end

data/lib/dropsonde.rb

@@ -4,7 +4,12 @@ require 'json'
 require 'httpclient'
 require 'puppetdb'
 require 'inifile'
-require 'puppet'
+
+begin
+  require 'puppet'
+rescue LoadError
+  raise 'Please install either Puppet or OpenVox gem to use this tool.'
+end
 
 # This class handles caching module process, generate reports,
 # fetchs all plugins defined in lib/dropsonde/metrics and also
@@ -15,6 +20,9 @@ class Dropsonde
   require 'dropsonde/monkeypatches'
   require 'dropsonde/version'
 
+  # This class abstracts the endpoint we submit to.
+  class Dropsonde::Submitter; end
+
   def self.puppet_settings_overrides
     overrides = []
     if (confdir = ENV['PUPPET_CONFDIR'])
@@ -75,33 +83,13 @@ class Dropsonde
     end
   end
 
-  def self.submit_report(endpoint, port)
-    client = HTTPClient.new
-
-    # The httpclient gem ships with some expired CA certificates.
-    # This causes us to load the certs shipped with whatever
-    # Ruby is used to execute this gem's commands, which are generally
-    # more up-to-date, especially if using puppet-agent's Ruby.
-    #
-    # Note that this is no-op with Windows system Ruby.
-    client.ssl_config.set_default_paths
-
-    result = client.post("#{endpoint}:#{port}",
-                         header: { 'Content-Type' => 'application/json' },
-                         body: Dropsonde::Metrics.new.report.to_json)
-
-    if result.status == 200
-      data = JSON.parse(result.body)
-      if data['newer']
-        puts 'A newer version of the telemetry client is available:'
-        puts "  -- #{data['link']}"
-      else
-        puts data['message']
-      end
+  def self.submit_report(options)
+    if Puppet.respond_to?(:implementation) && Puppet.implementation == 'openvox'
+      require 'dropsonde/submitter/open_telemetry'
+      Dropsonde::Submitter::OpenTelemetry.submit_report(options)
     else
-      puts 'Failed to submit report'
-      puts JSON.pretty_generate(result.body) if Dropsonde.settings[:verbose]
-      exit 1
+      require 'dropsonde/submitter/dujour'
+      Dropsonde::Submitter::Dujour.submit_report(options)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dropsonde
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors:
 - Ben Ford
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-10 00:00:00.000000000 Z
+date: 2025-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: puppet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: puppet_forge
   requirement: !ruby/object:Gem::Requirement
@@ -140,7 +126,7 @@ description: |
   Dropsonde is a simple telemetry probe designed to run as a regular cron job. It
   will gather metrics defined by self-contained plugins that each defines its own
   partial schema and then gathers the data to meet that schema.
-email: ben.ford@puppet.com
+email: binford2k@overlookinfratech.com
 executables:
 - dropsonde
 extensions: []
@@ -159,12 +145,16 @@ files:
 - lib/dropsonde/metrics/platforms.rb
 - lib/dropsonde/metrics/puppetfiles.rb
 - lib/dropsonde/monkeypatches.rb
+- lib/dropsonde/submitter/dujour.rb
+- lib/dropsonde/submitter/open_telemetry.rb
 - lib/dropsonde/version.rb
-homepage: https://github.com/puppetlabs/dropsonde
+homepage: https://github.com/OpenVoxProject/dropsonde
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message:
+post_install_message: |
+  For portability reasons, this gem no longer depends on Puppet. You will need to
+  install either Puppet or OpenVox gems manually.
 rdoc_options: []
 require_paths:
 - lib
@@ -179,8 +169,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
-summary: A simple telemetry probe for gathering usage information about Puppet infrastructures.
+summary: A simple telemetry probe for gathering usage information about OpenVox and
+  Puppet infrastructures.
 test_files: []