telemetry 1.1.1 → 1.1.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjQxNzM4Y2E3NWE4ZGE1MGRhZjZmZGYwYWVjOGViYWI1NDc1MGFmOQ==
+    ZDkwNDA3NTk5YzU3MDkxZjEyMjc4MjZmODg5ZmQ4MWRmOGQwY2YyYQ==
   data.tar.gz: !binary |-
-    ZDg3MjY5N2MwNWM2YTQwN2EzOGM4NGNkNGFiMWYzNzkxN2E4MGY2Yg==
+    ZTk1YmU3OThkYjkwZjRhN2YwOWYxZjU1NGI1ODFjODJmM2UwODcxYQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NmYyYTE3MjVjZmNjMzM0OTFkMDkxZDI2M2JiOWM1NWMyZjQxMDdhYjE3ZDE0
-    MThhZTQzNTgyZGUyNTliNzU4OGM3MjA3OWY4YmVhZjZmM2JjMGYwZGE1Njdl
-    N2UzOTA5MDA5ODZmNWE2ODFiNzFlNmRhOTMwYjJkYzE3YmQ3N2Q=
+    NmU2NDRjNTdiMTM5ZTE2ZWYxNDUxODZiZmVmMzFhYWIyYjgyYjI2NDA2MmIz
+    NTJlODlhOTU1ZWE3ZmM3MGUyNjBiZWM5OTgyZTQ0ZGZhOTA1ZmZjOTliYzQx
+    ZGQ5ZGMzNjQwNzljZjBlODUzMGYwMDAxOTc0ZGIxYmJhYWNlYzc=
   data.tar.gz: !binary |-
-    ZjFkZTMxZDJkYzczODZmZmIwZDE5NDg4MTE2MzcxOGE0NGQyODM1MDlhN2Fj
-    OGIzZGIwNGFiNjkzZTRiMjMyMjQwNTIxYWRmMDE2YmEyZDBjM2ZjYzIyZWQ5
-    OWZjMzNlN2Q4NmE2OWQ3YjM1YmM5ZGY5ZThhYWE3OWMxYzc5N2M=
+    NDdiM2IwNDZlNmVlZGE3MjYxNzlhYTZmM2FiZGIxN2UxMWRhODFkZGNmY2Y4
+    ZTYwZmEwYTg4MGUwOGZmOWQwNDJhOTIwMDk5NWFhZmJmZmQyOTc5YjUzOTli
+    YTVhYzU3N2ViN2FlOGMxOTU3ZDE5NjI1MTkwYTI4YTgzOThlYWQ=

data/README.md

@@ -8,7 +8,28 @@ Install on your system:
 
     $ gem install telemetry
 
-## Usage
+## Basic Usage
+
+To use this gem you must require it in your file and specify your API Token that you can find on the [Telemetry API Token page](https://admin.telemetryapp.com/account/api_token)
+
+Set a hash of values for the flow to update.  Each hash must contain the tag of the flow that you want to update.  
+
+	require 'telemetry'
+
+	Telemetry.token = "test-api-token"
+
+	properties = {
+		tag: "test-flow-value",
+		value: 3434
+	}
+	Telemetry::Value.new(properties).emit
+
+For documentation on flows and the properties they support please see the [flow documentation](https://admin.telemetryapp.com/documentation/flows) pages.
+
+
+## Daemon
+
+Telemetry also supports a daemon mode where a binary (telemetryd) runs indefintely and loops through a configuration file triggering updates to the API as it goes.
 
 Create a config file on your disk (by default /etc/telemetryd_config.rb).  This file may have ruby code in it,  you may include your own gems, etc.  The file supports two configuration directives "interval" and "api_token".  The interval is how frequently each flow block is executed with the results sent to the server.  Please note if the result from a block is unchanged from the previous execution then it will be sent to the server only once per day. 
 
@@ -17,9 +38,9 @@ For more details please see our website.
 Example simple config:
 
 	interval 5
-	api_token "c65bc385a3b30135590a80973483ebf"
+	api_token "test-api-token"
 
-	gauge "my-gauge" do
+	gauge "test-flow-gauge" do
 		set value: 45
 		set max: 100
 	end
@@ -32,7 +53,14 @@ To kill the daemon:
 
 	$ telemetryd.rb -k
 
-Omitting the -d will start the process in the foreground and log to stdout.  This is useful for debugging your config file. 
+Omitting the -d will start the process in the foreground and log to stdout.  This is useful for debugging your config file.   The daemon can be started with -o to run once and exit.
+
+Custom update intervals are supported on a per flow basis.  To configure the update interval append an integer with the number of seconds to update as per the following:
+
+	gauge "test-flow-gauge", 86400 do
+		set value: 50
+	end
+
 
 ## Contributing
 

data/lib/telemetry/version.rb

@@ -1,3 +1,3 @@
 module Telemetry
-  TELEMETRY_VERSION = "1.1.1"
+  TELEMETRY_VERSION = "1.1.2"
 end

data/telemetry.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |gem|
   gem.description   = %q{Telemetry Data Submission API Gem.  See our website for a more detailed description.}
   gem.summary       = %q{Telemetry Data Submission API Gem}
   gem.homepage      = "http://www.telemetryapp.com"
+  gem.license = 'MIT'
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telemetry
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - W. Gersham Meharg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-16 00:00:00.000000000 Z
+date: 2013-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -121,7 +121,8 @@ files:
 - spec/spec_helper.rb
 - telemetry.gemspec
 homepage: http://www.telemetryapp.com
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []