dropsonde 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 643def01638761803e04cf758bbf627ac821bb091fc7dad50c5b161251534728
-  data.tar.gz: f0c8a36548214da7beeecee9dc583dcd8d81eceb640b967078fadf5b2978f987
+  metadata.gz: f4a87b2c8abe75d07a73a52a48041c2734bb7914a54df3471d696458f3f0cb05
+  data.tar.gz: cd2b7d3a36aa9aa386997ab21f7ffee57387819b08a79407b98c5bfdbbcd619d
 SHA512:
-  metadata.gz: 7c260e1617666fb83d7b0be1a3d73ad13aaee5c33844d5eb4117b186c6eec23a9aad6dc03ff3df393168b6a3715bf492ce677624fdbe536e4961d956d1e9cdcb
-  data.tar.gz: cffbe7901afe08afa593ee73fa749358257efcd03d612564b3aac507684897d2d0db3e504a599d1eab7251508c3f455e236985501ea9f6722f108bb02cf80e2e
+  metadata.gz: 4a033ee5a796d3dab8c46d7562848255ca66552671f31f58ffde8a5a00f98dbcf1e9485a8279529b7c78094f96add8e932fa401e634ccfc067f5c9b72eed93c3
+  data.tar.gz: b86bc1f854fe414a388534ced35132d0744ac21001298d3eefce326afa97a63bd56ce9b250458889690831e7b0343963666377eaf10c25c38861b50e1160225d

data/bin/dropsonde

@@ -5,6 +5,9 @@ require 'dropsonde'
 class Dropsonde
   extend GLI::App
 
+  @cache = nil
+  @puppetdb_session = Dropsonde.new
+
   program_desc 'A simple telemetry tool for Puppet infrastructures'
   config_file  "#{File.dirname(Puppet.settings[:confdir])}/telemetry.yaml"
   version      Dropsonde::VERSION
@@ -30,15 +33,18 @@ class Dropsonde
   desc 'Any number or string used to generate the randomized site ID.'
   flag [:seed]
 
+  desc 'Static site ID'
+  flag [:siteid]
+
   pre do |global, command, options, args|
     Dropsonde.settings = global
-    Dropsonde::Cache.init(global[:cachepath], global[:ttl], global[:update])
+    @cache = Dropsonde::Cache.new(global[:cachepath], global[:ttl], global[:update])
   end
 
   desc 'Manually update the Forge module name cache'
   command :update do |c|
     c.action do |global, options, args|
-      Dropsonde::Cache.update
+      @cache.update
     end
   end
 
@@ -55,8 +61,8 @@ class Dropsonde
     c.flag [:format], :default_value => 'human'
 
     c.action do |global, options, args|
-      Dropsonde::Cache.autoupdate
-      Dropsonde.generate_report(options[:format])
+      @cache.autoupdate
+      Dropsonde.generate_report(options[:format], @puppetdb_session)
     end
   end
 
@@ -69,7 +75,7 @@ class Dropsonde
     c.flag [:port], :default_value => 443, :type => Integer
 
     c.action do |global, options, args|
-      Dropsonde::Cache.autoupdate
+      @cache.autoupdate
       Dropsonde.submit_report(options[:endpoint], options[:port])
     end
   end
@@ -111,7 +117,7 @@ class Dropsonde
       c.flag [:filename], :default_value => 'example.jsonl'
 
       c.action do |global, options, args|
-        Dropsonde::Cache.autoupdate
+        @cache.autoupdate
         Dropsonde.generate_example(options[:size], options[:filename])
       end
     end

data/lib/dropsonde/cache.rb

@@ -1,34 +1,41 @@
+# frozen_string_literal: true
+
 require 'date'
 require 'json'
 require 'fileutils'
 require 'puppet_forge'
 
+# cache class
 class Dropsonde::Cache
-  @@autoupdate = false
+  @autoupdate = false
 
-  def self.init(path, ttl, autoupdate)
+  def initialize(path, ttl, autoupdate)
     FileUtils.mkdir_p(path)
-    @@path = "#{File.expand_path(path)}/forge.json"
-    @@ttl  = ttl
-    @@autoupdate = autoupdate
-
-    if File.file? @@path
-      @@cache = JSON.parse(File.read(@@path))
-    else
-      @@cache = {
-                'timestamp' => '2000-1-1',  # long before any puppet modules were released!
-                'modules'   => [],
-              }
-    end
-
-    PuppetForge.user_agent = "Dropsonde Telemetry Client/0.0.1"
+    @path = "#{File.expand_path(path)}/forge.json"
+    @ttl  = ttl
+    @autoupdate = autoupdate
+
+    @@cache = if File.file? @path # rubocop:disable Style/ClassVars
+                JSON.parse(File.read(@path))
+              else
+                {
+                  'timestamp' => '2000-1-1', # long before any puppet modules were released!
+                  'modules' => [],
+                }
+              end
+
+    PuppetForge.user_agent = 'Dropsonde Telemetry Client/0.0.1'
   end
 
-  def self.modules
+  def modules
     @@cache['modules']
   end
 
-  def self.forgeModule?(mod)
+  def cache
+    @@cache
+  end
+
+  def self.forge_module?(mod)
     case mod
     when Puppet::Module
       modname = mod.forge_slug
@@ -39,12 +46,12 @@ class Dropsonde::Cache
     end
     return unless modname
 
-    modules.include? modname.tr('/','-')
+    @@cache['modules'].include? modname.tr('/', '-')
   end
 
-  def self.update
-    puts "Updating module cache..."
-    iter   = PuppetForge::Module.all(:sort_by => 'latest_release')
+  def update
+    puts 'Updating module cache...'
+    iter   = PuppetForge::Module.all(sort_by: 'latest_release')
     newest = DateTime.parse(@@cache['timestamp'])
 
     @@cache['timestamp'] = iter.first.updated_at
@@ -53,7 +60,7 @@ class Dropsonde::Cache
       # stop once we reach modules we've already cached
       break if DateTime.parse(iter.first.updated_at) <= newest
 
-      @@cache['modules'].concat iter.map {|mod| mod.slug }
+      @@cache['modules'].concat(iter.map { |mod| mod.slug })
 
       iter = iter.next
       print '.'
@@ -62,22 +69,19 @@ class Dropsonde::Cache
     @@cache['modules'].sort!
     @@cache['modules'].uniq!
 
-    File.write(@@path, JSON.pretty_generate(@@cache))
+    File.write(@path, JSON.pretty_generate(@@cache))
   end
 
-  def self.autoupdate
-    return unless @@autoupdate
+  def autoupdate
+    return unless @autoupdate
 
-    unless File.file? @@path
-      puts "Dropsonde caches a list of all Forge modules to ensure that it only reports"
-      puts "usage data on public modules. Generating this cache may take some time on"
+    unless File.file? @path
+      puts 'Dropsonde caches a list of all Forge modules to ensure that it only reports'
+      puts 'usage data on public modules. Generating this cache may take some time on'
       puts "the first run and you'll see your screen fill up with dots."
       update
     end
 
-    if (Date.today - File.mtime(@@path).to_date).to_i > @@ttl
-      update
-    end
+    return update if (Date.today - File.mtime(@path).to_date).to_i > @ttl
   end
-
 end

data/lib/dropsonde/metrics/dependencies.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+# dependencies plugin
 class Dropsonde::Metrics::Dependencies
   def self.initialize_dependencies
     # require any libraries needed here -- no need to load puppet; it's already initialized
@@ -5,10 +8,10 @@ class Dropsonde::Metrics::Dependencies
   end
 
   def self.description
-    <<~EOF
+    <<~DESCRIPTION
       This group of metrics discovers dependencies between modules in all
       environments. It will omit dependencies on private modules.
-    EOF
+    DESCRIPTION
   end
 
   def self.schema
@@ -18,23 +21,23 @@ class Dropsonde::Metrics::Dependencies
       {
         "fields": [
           {
-            "description": "The depended on module name",
-            "mode": "NULLABLE",
-            "name": "name",
-            "type": "STRING"
+            "description": 'The depended on module name',
+            "mode": 'NULLABLE',
+            "name": 'name',
+            "type": 'STRING',
           },
           {
-            "description": "The depended on module version requirement",
-            "mode": "NULLABLE",
-            "name": "version_requirement",
-            "type": "STRING"
-          }
+            "description": 'The depended on module version requirement',
+            "mode": 'NULLABLE',
+            "name": 'version_requirement',
+            "type": 'STRING',
+          },
         ],
-        "description": "List of modules that private modules in all environments depend on.",
-        "mode": "REPEATED",
-        "name": "dependencies",
-        "type": "RECORD"
-      }
+        "description": 'List of modules that private modules in all environments depend on.',
+        "mode": 'REPEATED',
+        "name": 'dependencies',
+        "type": 'RECORD',
+      },
     ]
   end
 
@@ -42,26 +45,25 @@ class Dropsonde::Metrics::Dependencies
     # run just before generating this metric
   end
 
-  def self.run
+  def self.run(_puppetdb_session = nil)
     # return an array of hashes representing the data to be merged into the combined checkin
-    environments = Puppet.lookup(:environments).list.map{|e|e.name}
-    modules = environments.map do |env|
+    environments = Puppet.lookup(:environments).list.map { |e| e.name }
+    modules = environments.map { |env|
       Puppet.lookup(:environments).get(env).modules
-    end.flatten
+    }.flatten
 
     # we want only PUBLIC modules that PRIVATE modules depend on
-    dependencies = modules.map do|mod|
+    dependencies = modules.map { |mod|
       next unless mod.dependencies
-      next if Dropsonde::Cache.forgeModule? mod  # skip unless this is a private module
+      next if Dropsonde::Cache.forge_module? mod # skip unless this is a private module
 
       # and return a list of all public modules it depends on
-      mod.dependencies.select {|mod| Dropsonde::Cache.forgeModule? mod }
-    end.flatten.compact
+      mod.dependencies.select { |dep| Dropsonde::Cache.forge_module? dep }
+    }.flatten.compact
 
     [
-      { :dependencies => dependencies },
+      { dependencies: dependencies },
     ]
-
   end
 
   def self.example
@@ -69,14 +71,17 @@ 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 {|item| {
-                                    :name                => item,
-                                    :version_requirement => versions.sample,
-                                  }},
+      dependencies: dropsonde_cache.modules
+                                   .sample(rand(250))
+                                   .map do |item|
+                      {
+                        name: item,
+                        version_requirement: versions.sample,
+                      }
+                    end,
     ]
   end
 

data/lib/dropsonde/metrics/environments.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+# environments plugin
 class Dropsonde::Metrics::Environments
   def self.initialize_environments
     # Require any libraries needed here -- no need to load puppet or puppetdb;
@@ -7,20 +10,20 @@ class Dropsonde::Metrics::Environments
 
   def self.description
     # This is a Ruby squiggle heredoc; just a multi-line string with indentation removed
-    <<~EOF
+    <<~DESCRIPTION
       This group of metrics gathers information about environments.
-    EOF
+    DESCRIPTION
   end
 
   def self.schema
     # return an array of hashes of a partial schema to be merged into the complete schema
     [
       {
-        "description": "The number of environments",
-        "mode": "NULLABLE",
-        "name": "environment_count",
-        "type": "INTEGER"
-      }
+        "description": 'The number of environments',
+        "mode": 'NULLABLE',
+        "name": 'environment_count',
+        "type": 'INTEGER',
+      },
     ]
   end
 
@@ -28,10 +31,10 @@ class Dropsonde::Metrics::Environments
     # run just before generating this metric
   end
 
-  def self.run
+  def self.run(_puppetdb_session = nil)
     # return an array of hashes representing the data to be merged into the combined checkin
     [
-      :environment_count => Puppet.lookup(:environments).list.count,
+      environment_count: Puppet.lookup(:environments).list.count,
     ]
   end
 
@@ -40,7 +43,7 @@ class Dropsonde::Metrics::Environments
     # make it easier to write data aggregation queries without access to the
     # actual private data that users have submitted.
     [
-      :environment_count => rand(1..100),
+      environment_count: rand(1..100),
     ]
   end
 

data/lib/dropsonde/metrics/modules.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+# modules plugin
 class Dropsonde::Metrics::Modules
   def self.initialize_modules
     # require any libraries needed here -- no need to load puppet; it's already initialized
@@ -5,10 +8,10 @@ class Dropsonde::Metrics::Modules
   end
 
   def self.description
-    <<~EOF
+    <<~DESCRIPTION
       This group of metrics exports name & version information about the public
       modules installed in all environments, ignoring private modules.
-    EOF
+    DESCRIPTION
   end
 
   def self.schema
@@ -18,49 +21,49 @@ class Dropsonde::Metrics::Modules
       {
         "fields": [
           {
-            "description": "The module name",
-            "mode": "NULLABLE",
-            "name": "name",
-            "type": "STRING"
+            "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 slug (author-name)',
+            "mode": 'NULLABLE',
+            "name": 'slug',
+            "type": 'STRING',
           },
           {
-            "description": "The module version",
-            "mode": "NULLABLE",
-            "name": "version",
-            "type": "STRING"
-          }
+            "description": 'The module version',
+            "mode": 'NULLABLE',
+            "name": 'version',
+            "type": 'STRING',
+          },
         ],
-        "description": "List of modules in all environments.",
-        "mode": "REPEATED",
-        "name": "modules",
-        "type": "RECORD"
+        "description": 'List of modules in all environments.',
+        "mode": 'REPEATED',
+        "name": 'modules',
+        "type": 'RECORD',
       },
       {
         "fields": [
           {
-            "description": "The class name",
-            "mode": "NULLABLE",
-            "name": "name",
-            "type": "STRING"
+            "description": 'The class name',
+            "mode": 'NULLABLE',
+            "name": 'name',
+            "type": 'STRING',
           },
           {
-            "description": "How many nodes it is declared on",
-            "mode": "NULLABLE",
-            "name": "count",
-            "type": "INTEGER"
-          }
+            "description": 'How many nodes it is declared on',
+            "mode": 'NULLABLE',
+            "name": 'count',
+            "type": 'INTEGER',
+          },
         ],
-        "description": "List of classes and counts in all environments.",
-        "mode": "REPEATED",
-        "name": "classes",
-        "type": "RECORD"
-      }
+        "description": 'List of classes and counts in all environments.',
+        "mode": 'REPEATED',
+        "name": 'classes',
+        "type": 'RECORD',
+      },
     ]
   end
 
@@ -68,46 +71,44 @@ class Dropsonde::Metrics::Modules
     # run just before generating this metric
   end
 
-  def self.run
+  def self.run(puppetdb_session = nil)
     # return an array of hashes representing the data to be merged into the combined checkin
-    environments = Puppet.lookup(:environments).list.map{|e|e.name}
-    modules = environments.map do |env|
-      Puppet.lookup(:environments).get(env).modules.map do|mod|
+    environments = Puppet.lookup(:environments).list.map { |e| e.name }
+    modules = environments.map { |env|
+      Puppet.lookup(:environments).get(env).modules.map do |mod|
         next unless mod.forge_module?
 
         {
-          :name    => mod.name,
-          :slug    => mod.forge_slug,
-          :version => mod.version,
+          name: mod.name,
+          slug: mod.forge_slug,
+          version: mod.version,
         }
       end
-    end.flatten.compact.uniq
+    }.flatten.compact.uniq
 
-    if Dropsonde.puppetDB
+    if puppetdb_session
       # classes and how many nodes they're enforced on
-      results = Dropsonde.puppetDB.request( '',
-        'resources[type, title] { type = "Class" }'
-      ).data
+      results = puppetdb_session.puppet_db.request('', 'resources[type, title] { type = "Class" }').data
 
       # select only classes from public modules.
       # Use uniq to reduce the iteration over very large datasets
-      classes = results.uniq.map do |klass|
+      classes = results.uniq.map { |klass|
         title   = klass['title']
         modname = title.split('::').first.downcase
-        next unless modules.find {|mod| mod[:name] == modname }
+        next unless modules.find { |mod| mod[:name] == modname }
 
         {
-          :name  => title,
-          :count => results.count {|row| row['title'] == title},
+          name: title,
+          count: results.count { |row| row['title'] == title },
         }
-      end.compact
+      }.compact
     else
       classes = []
     end
 
     [
-      { :modules => modules },
-      { :classes => classes },
+      { modules: modules },
+      { classes: classes },
     ]
   end
 
@@ -118,20 +119,25 @@ 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 {|item| {
-                                    :name    => item.split('-').last,
-                                    :slug    => item,
-                                    :version => versions.sample,
-                                  }},
-      :classes => Dropsonde::Cache.modules
-                                  .sample(rand(500))
-                                  .map {|item| {
-                                    :name  => item.split('-').last.capitalize + classes.sample,
-                                    :count => rand(750),
-                                  }},
+      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|
+                 {
+                   name: item.split('-').last.capitalize + classes.sample,
+                   count: rand(750),
+                 }
+               end,
     ]
   end