rubberband_flamethrower 0.5.0 → 0.5.1

data/README.md

@@ -88,7 +88,29 @@ To run the "flamethrower  fire" command 5 times, inserting 5,000 objects each ti
 	flamethrower auto 5 5000
 	
 The id_overwrite parameter determines the ID strategy used for subsequent batches in the auto command. 	When set to "n" ("n" is the default) each batch will be writing new data with unused IDs to the Elastic Search server, simulating a system where new data is constantly being inserted and not updated. 5 batches of 500 with an "n" would use the IDs 1-2500. When it is set to "y" each batch (after the first) will be overwriting existing data on the Elastic Search server, simulating a system where data is constantly being updated (after the initial batch). 5 batches of 500 with a setting of "y" would use the IDs 1-500 on each batch.
-	
+
+#### Generate Dataset
+
+The "generate_dataset" command can be used to create a set of documents for insertion that can be used over and over. This is useful when you are benchmarking one possible configuration against another and want to use consistent data for each run. The generated file will contain one JSON document per line.
+
+	flamethrower generate_dataset
+
+This will generate a batch of 500 documents and store it in a local file called "dataset". You can configure the size of the dataset by providing an additional parameter to the command.
+
+To generate a dataset of 10,000 documents:
+
+	flamethrower generate_dataset 10000
+
+The dataset will always be written to a file named "dataset". If you want to generate multiple dataset files you will need to rename the first file before generating a second.
+
+#### Load Dataset
+
+The "load_dataset" command can be used much like the "fire" command only the data inserted will come from the dataset file rather than being randomly generated. You can create your own dataset file if you would like.
+
+	flamethrower load_dataset
+
+The command can be configured much like the "fire" command, but the first parameter accepted is not the number of documents to generate and insert but is instead the filename of the dataset. The parameters in order with their default values: (filename="dataset", starting_id=1, server_url="http://localhost:9200", index="twitter", type="tweet")
+
 #### Help
 
 The command with the argument "help" or without any arguments will display the help screen:
@@ -136,7 +158,6 @@ To put your documents into an index named "facebook" instead of "twitter" with a
 * Commit and push until you are happy with your contribution.
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
 ## Copyright
 
 Copyright (c) 2013 Michael Orr. See LICENSE.txt for

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.5.1

data/bin/flamethrower

@@ -14,8 +14,8 @@ when "fire"
   RubberbandFlamethrower.fire(*args)
 when "generate_dataset"
   RubberbandFlamethrower.generate_dataset(*args)
-when "fire_dataset"
-  RubberbandFlamethrower.fire_dataset(*args)
+when "load_dataset"
+  RubberbandFlamethrower.load_dataset(*args)
 when "help"
   RubberbandFlamethrower.help
 else

data/lib/rubberband_flamethrower.rb

@@ -48,11 +48,11 @@ module RubberbandFlamethrower
     data.generate_dataset(batch_size)
   end
   
-  def self.fire_dataset(filename="dataset", starting_id=1, server_url="http://localhost:9200", index="twitter", type="tweet")
+  def self.load_dataset(filename="dataset", starting_id=1, server_url="http://localhost:9200", index="twitter", type="tweet")
     require File.dirname(__FILE__)+"/rubberband_flamethrower/flamethrower.rb"
     flamethrower = Flamethrower.new
     time = Benchmark.measure do
-      flamethrower.fire_dataset(filename, starting_id, server_url, index, type, 1)
+      flamethrower.load_dataset(filename, starting_id, server_url, index, type, 1)
     end
     puts "\nFinished Inserting Dataset (#{filename}) into Elastic Search."
     puts "  user       system     total    real"

data/lib/rubberband_flamethrower/flamethrower.rb

@@ -48,12 +48,12 @@ module RubberbandFlamethrower
       end
     end
 
-    def fire_dataset(filename, starting_id, server_url, index, type, printing_level=0)
+    def load_dataset(filename, starting_id, server_url, index, type, printing_level=0)
       # this will constantly flush the printing to the display so the progress dots appear for each insert
       ($stdout.sync = true) if printing_level == 1
       # a unique ID must be provided for each document stored in Elastic Search
       id = starting_id.to_i
-      # loop through lines in the file and insert each
+      # loop through lines in the file and insert each line, each line is a document from the data generator
       IO.foreach(filename) do |line|
         (puts insert_data) if printing_level == 2
         response = HTTParty.put("#{server_url}/#{index}/#{type}/#{id}", body: line) 

data/rubberband_flamethrower.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "rubberband_flamethrower"
-  s.version = "0.5.0"
+  s.version = "0.5.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael Orr"]
-  s.date = "2013-04-17"
+  s.date = "2013-04-18"
   s.description = "Use to quickly fill up some indicies in Elastic Search and to retrieve statistics about insertion rates"
   s.email = "michael@cloudspace.com"
   s.executables = ["flamethrower"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubberband_flamethrower
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-17 00:00:00.000000000 Z
+date: 2013-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &9560560 !ruby/object:Gem::Requirement
+  requirement: &12013880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.10.2
   type: :runtime
   prerelease: false
-  version_requirements: *9560560
+  version_requirements: *12013880
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &9559180 !ruby/object:Gem::Requirement
+  requirement: &12026700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 3.2.13
   type: :runtime
   prerelease: false
-  version_requirements: *9559180
+  version_requirements: *12026700
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &9557580 !ruby/object:Gem::Requirement
+  requirement: &12024060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *9557580
+  version_requirements: *12024060
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &9573900 !ruby/object:Gem::Requirement
+  requirement: &12021660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.3.0
   type: :development
   prerelease: false
-  version_requirements: *9573900
+  version_requirements: *12021660
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &9573020 !ruby/object:Gem::Requirement
+  requirement: &12116420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: 1.8.4
   type: :development
   prerelease: false
-  version_requirements: *9573020
+  version_requirements: *12116420
 description: Use to quickly fill up some indicies in Elastic Search and to retrieve
   statistics about insertion rates
 email: michael@cloudspace.com
@@ -115,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -31644688981302429
+      hash: 1992718283200154027
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: