lumbersexual 0.1.1 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MzVlYTg1YjgyNDdhZTA4OWVkZDE4MWJmNjM4ZDA5OTg0YWUyOTkzNQ==
+    OWRkYjM5NGMwOTFjMjVkNjhmNWI4YWU0MzI2ODE4MzE1ZDRmMWY1ZQ==
   data.tar.gz: !binary |-
-    YTcwZjk2MWE2MWI3ZGU5YzZiMDVjZTE2ZmM1OTcwYmY3NjQ4YzYxOA==
+    MTQxY2JhMDZkNDlkNjk1ZWI5NmUzMzMyZDQ2MjY2ZjY2NzhmN2QxZg==
 SHA512:
   metadata.gz: !binary |-
-    MjI5YmRlZDhkM2UyM2U1ZWVkMzBiNjdkZTYyMmYxYjJiOTU4ZWFmNWZhNTAx
-    ZmQ2NTJmZWRhNDVlYWNmZmFmOGM4ZjFlMDA4MjQ3N2ZhZWE0ZDYxZTYxOTVj
-    MDc2ODJhM2I4M2FhODFiYjNmYjU3ZDk1OGY2OWVkMTJmOGJkMGE=
+    YTkxNTNlZWE3ZWE0NTJjZWU3MjJiMzBmZTJiOGUyZWFmYzdkZDhhYjRkMDM3
+    Njk4ZWIwY2IwMTZlYWUxYzM1ODI3YTRjYzYwZTc0Y2ZmZmVjM2ViODljOTQ2
+    M2M4NTk1NzFmMDFhYjdjZWU3MmI4NDAzZGM0MTk3Zjc2YmJiMzg=
   data.tar.gz: !binary |-
-    ZDBjNjJjM2VjMDBmZGY3OTc2ODcwM2VkNGZjOTkwOTVkNzExNjljMmM4OWE4
-    YWY4OGQwNTA3YTdlZGE0MWY3ZjRlNzE0MDAyNzMzZDZhZDljNTI3MDFlMWQx
-    MWVkOTBhZThjMDk2NzM3ZDE2OTFjOGFmNzBlNDgxNmRlMzM0ZDE=
+    NTkzNGQxZTE3ZTMxMDFmMzVkYWJlZmM0NTAxN2M3ZDk3MzZkNWJlYjdhMjYx
+    MWI0NjE1MWE4MzFiYjUwMjUwMjAzYjJhZTI3MWNmY2ZkMWU3NGEyNjdhNGIx
+    OWI2YWU4ZGFkYmMwNDVkMmI2ZTQxNDRiYjUzODQzY2ZmZGVkMzI=

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
+cache: bundler
 rvm:
 - 2.3.0
 - jruby-9.0.5.0

data/README.md

@@ -1,4 +1,4 @@
-# Lumbersexual [![Build Status](https://travis-ci.org/sampointer/lumbersexual.svg?branch=master)](https://travis-ci.org/sampointer/lumbersexual)
+# Lumbersexual [![Build Status](https://travis-ci.org/sampointer/lumbersexual.svg?branch=master)](https://travis-ci.org/sampointer/lumbersexual) [![Gem Version](https://badge.fury.io/rb/lumbersexual.svg)](https://badge.fury.io/rb/lumbersexual)
 
 <img align="right" width="158" height="144" src="etc/assets/lumber-156795_960_720.png" alt="Lumbersexual" />
 This gem generates random-enough syslog entries for the purposes of testing syslog throughput, aggregated logging infrastructures and log index performance.
@@ -15,6 +15,20 @@ A dictionary file is needed from which to generate the randomized messages. Unde
 $ lumbersexual --help
 ```
 
+## Telemetry
+By supplying the switch `--statsdhost` with a hostname you can turn on statsd metric generation. Lumbersexual will assume it can write to a statsd-like daemon on UDP 8125 and will supply 2 types of telemetry.
+
+* During a run each thread will increment a counter at the path `lumbersexual.thread.<UUID>` (where UUID is a randomized string for each thread) each time a message is successfully sent.
+* At the end of a run the following metric paths will be produced:
+
+```
+lumbersexual.run.messages_total # gauge
+lumbersexual.run.elapsed        # timer
+lumbersexual.run.rate           # gauge
+```
+
+It is up to you to use the aggregation functions of telemetry system to combine these into a form you find acceptable.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec lumbersexual` to use the gem in this directory, ignoring other installed copies of this gem.

data/exe/lumbersexual

@@ -6,6 +6,8 @@ require "syslog"
 require "thread"
 require "timeout"
 require "etc"
+require "statsd-ruby"
+require "securerandom"
 
 options = Slop.parse do |o|
   o.string  '-D', '--dictionaryfile', 'path to dictionary file (default: /etc/dictionaries-common/words)', default: '/etc/dictionaries-common/words'
@@ -15,6 +17,7 @@ options = Slop.parse do |o|
   o.integer '-m', '--minwords', 'minimum number of words per message (default: 3)', default: 3
   o.array   '-p', '--priorities', 'additional comma-seperated priorities', default: []
   o.integer '-r', '--rate', 'messages per second per thread (default: 0, unlimited)', default: 0
+  o.string  '-s', '--statsdhost', 'send statsd telemetry to the named host (default: off)', default: nil
   o.integer '-T', '--threads', 'number of threads (defaults to number of cores * 2)', default: Etc.nprocessors * 2
   o.integer '-t', '--timeout', 'length of execution. 0 for forever (default: 0)', default: 0
 end
@@ -55,36 +58,43 @@ puts "Rate per thread: #{options[:rate]}/s"
 puts "Total rate: #{options[:rate] * options[:threads]}/s"
 puts "Minimum words per message: #{options[:minwords]}"
 puts "Maximum words per message: #{options[:maxwords]}"
+puts "Statsd host: #{options[:statsdhost]}" if options[:statsdhost]
 puts "Running ..."
 
 # Run until we're done
 global_count = 0
 threads = []
 mutex = Mutex.new
+statsd_global = Statsd.new if options[:statsdhost]
 start_time = Time.now
 
 begin
   options[:threads].times do
     threads << Thread.new {
+      # Configure telemetry
+      statsd = Statsd.new(options[:statsdhost]).tap { |s| s.namespace = "lumbersexual.thread.#{SecureRandom.uuid}" } if options[:statsdhost]
+
       while true do
-	# Connect to syslog with some sane options and log a message
-	message = String.new
-	number_of_words = rand(options[:minwords]..options[:maxwords])
-	words.sample(number_of_words).each { |w| message << "#{w} " }
-	ident = "lumbersexual-#{words.sample}"
-	facility = facilities.sample
-	priority = priorities.sample
-
-	sleep pause
-	mutex.synchronize {
-	  syslog = Syslog.open(ident, Syslog::LOG_CONS | Syslog::LOG_NDELAY | Syslog::LOG_PID, priority)
-	  syslog.log(facility, message)
-	  global_count += 1
-	  syslog.close
-	}
+        # Connect to syslog with some sane options and log a message
+        message = String.new
+        number_of_words = rand(options[:minwords]..options[:maxwords])
+        words.sample(number_of_words).each { |w| message << "#{w} " }
+        ident = "lumbersexual-#{words.sample}"
+        facility = facilities.sample
+        priority = priorities.sample
+
+        sleep pause
+        mutex.synchronize {
+          syslog = Syslog.open(ident, Syslog::LOG_CONS | Syslog::LOG_NDELAY | Syslog::LOG_PID, priority)
+          syslog.log(facility, message)
+          global_count += 1
+          statsd.increment [ facility, priority, 'messages_sent' ].join('.') if options[:statsdhost]
+          syslog.close
+        }
 
       end
     }
+
   end
 
   Timeout::timeout(options[:timeout]) {
@@ -94,9 +104,14 @@ begin
 rescue Timeout::Error, Interrupt
   end_time = Time.now
   elapsed = end_time - start_time
-  puts "Sent: #{global_count}"
+  rate = global_count / elapsed
+  statsd_global = Statsd.new(options[:statsdhost]).tap { |s| s.namespace = "lumbersexual.run" } if options[:statsdhost]
+  puts "Sent: #{global_count}" 
+  statsd_global.gauge 'messages_total', global_count if options[:statsdhost]
   puts "Elapsed time: #{elapsed}"
-  puts "Messages per second: #{global_count / elapsed}"
+  statsd_global.timing 'elapsed', elapsed if options[:statsdhost]
+  puts "Messages per second: #{rate}"
+  statsd_global.gauge 'rate', rate if options[:statsdhost]
   puts "Complete"
   exit 0
 end

data/lib/lumbersexual/version.rb

@@ -1,3 +1,3 @@
 module Lumbersexual
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lumbersexual.gemspec

@@ -31,6 +31,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
 
-
   spec.add_dependency "slop", "~> 4.3.0"
+  spec.add_dependency "statsd-ruby", "~> 1.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lumbersexual
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Sam Pointer
@@ -66,6 +66,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 4.3.0
+- !ruby/object:Gem::Dependency
+  name: statsd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
 description: This gem generates random-enough syslog entries for the purposes of testing
   syslog throughput, aggregated logging infrastructures and log index performance.
 email: