snowagent 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42aacb27b1de008f048ef737649388ede58a7060
-  data.tar.gz: 8ed7ac6e359b29e47b59b37778cc7cb373c59106
+  metadata.gz: 036f78e36bf8fee0461fe56c7d2521af27c95f7d
+  data.tar.gz: 0b06485bb20631d213eeec5db48e850c6390ff34
 SHA512:
-  metadata.gz: 378d78170e3bc1a75691520bbe71969235295e2754362214643b0fad438667fa64ba2b1b23fd85ac3a839da6a90222b0bbefcabe128dcb924a2ddaaf3cda3714
-  data.tar.gz: a4045d4bddf3ac31e1b53f988979c0a69114eb6d494d8b5cfc2f43ca11bbf1fb0e2abdc78010acaf80af3bbc9be45124ea9ede55e75a75063f0ad7621623bccd
+  metadata.gz: 854f26cf4f28743453277d4f1b65abaa53ee943905c8d0d9633060ed419ed849d389cd62192b564920d08f32a5b5f926f09a3d77c6cfc3ba6836f7b15090dcc5
+  data.tar.gz: 53f3a0c4be2c501fc35e1ea861889d9a9e1cc6f0389732c485ca5d5b7c55d507bd96dc00a8eac63b1db3dac8b9c0d138a8b7f8015846648da67997c1cbdae34a

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # SnowAgent
 
+Version 0.1.0 - 2015.09.12
+- Remove support of async strategy
+- Add useful release script
+
 Version 0.0.3 - 2015.06.08
 - Add `time` and `increment` metrics
 - `async = true` by default

data/README.md

@@ -2,30 +2,41 @@
 
 [![Gem Version](https://badge.fury.io/rb/snowagent.svg)](http://badge.fury.io/rb/snowagent) [![Build Status](https://travis-ci.org/snowman-io/snowagent.svg)](https://travis-ci.org/snowman-io/snowagent)
 
+Gem for sending metrics to [SnowmanIO](http://snowman.io).
+
 ## Installation
 
-Add this line to your application's Gemfile:
+1. Register new application in your SnowmanIO instance.
+2. Add `gem 'snowagent'` to application's Gemfile.
+3. Add two environments variables as described on 'Install' section of application
 
-```ruby
-gem 'snowagent'
-```
+Example of installation instructions page:
+
+![](doc/install.png)
 
-And then execute:
+## Usage
 
-    $ bundle
+The main goal of SnowmanIO is to collect low frequient business metrics and trends. So the agent
+supports only synchronous mode of sending metrics via HTTP/HTTPS.
 
-Or install it yourself as:
+It's strongly recomended **don't send metric directly from request**. Instead use cron tasks, delalyed jobs and other background processes to deliver metrics!
 
-    $ gem install snowagent
+Code examples:
+``` ruby
+# In controller
+SnowAgent.delay.increment("User Login")
 
-## Usage
+# In scheduled task
+SnowAgent.time("Task Time") do
+  # time consumed calculations
+end
 
-TODO: Write usage instructions here
+# Some custom metric
+SnowAgent.metric("Sessions Amount", Session.alive.count, "amount")
+```
 
 ## Contributing
 
-1. Fork it ( https://github.com/snowman-io/snowagent/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+1. Implement a feature (remember about tests and CHANGELOG.md!)
+2. (optional) Suggest a [blog](https://github.com/snowman-io/blog) mini post about new feature
+3. :snowman: will be happier

data/lib/snowagent.rb

@@ -4,9 +4,7 @@ require 'logger'
 
 require "snowagent/version"
 require "snowagent/agent"
-require "snowagent/async_strategy"
 require "snowagent/sync_strategy"
-require "snowagent/sender"
 require "snowagent/service"
 require "snowagent/configuration"
 
@@ -19,6 +17,7 @@ end
 module SnowAgent
   class << self
     attr_writer :configuration
+    attr_writer :logger
 
     def logger
       @logger ||= Logger.new(STDOUT)
@@ -36,7 +35,7 @@ module SnowAgent
       if configuration.configured?
         agent.metric(*args)
       else
-        # logger.debug "Metric was not send due to configuration."
+        logger.debug "Metric was not send due to configuration."
       end
 
       nil

data/lib/snowagent/agent.rb

@@ -1,7 +1,7 @@
 module SnowAgent
   class Agent
     def initialize(configuration)
-      strategy_class = configuration.async ? AsyncStrategy : SyncStrategy
+      strategy_class = SyncStrategy
       @strategy      = strategy_class.new(configuration)
     end
 

data/lib/snowagent/configuration.rb

@@ -6,32 +6,23 @@ module SnowAgent
     # Secret access token for authentication with SnowmanIO
     attr_accessor :secret_token
 
-    # Interval for reporting data to the server
-    attr_accessor :send_interval
-
     # Timeout when waiting for the server to return data in seconds
     attr_accessor :read_timeout
 
     # Timout when opening connection to the server
     attr_accessor :open_timeout
 
-    # Whether send metrics asynchronously or not
-    attr_accessor :async
-
     def initialize
       self.server        = ENV['SNOWMANIO_SERVER']
       self.secret_token  = ENV['SNOWMANIO_SECRET_TOKEN']
-      self.send_interval = 15
 
       self.read_timeout = 30
       self.open_timeout = 30
-
-      self.async        = false
     end
 
     # Determines if the agent confiured to send metrics.
     def configured?
-      !server.nil? # TODO: also check secret_token token
+      !server.nil? && !secret_token.nil?
     end
   end
 end

data/lib/snowagent/version.rb

@@ -1,3 +1,3 @@
 module SnowAgent
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/snowagent.gemspec

@@ -22,4 +22,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "webmock", "~> 1.21"
+  spec.add_development_dependency "timecop", "~> 0.8"
+  spec.add_development_dependency "ansi", "~> 1.5"
+  spec.add_development_dependency "git", "~> 1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snowagent
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Alexey Vakhov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-08 00:00:00.000000000 Z
+date: 2015-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,6 +53,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: ansi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 description: Send metrics to snowman
 email:
 - artyom.keydunov@gmail.com
@@ -65,10 +121,8 @@ files:
 - README.md
 - lib/snowagent.rb
 - lib/snowagent/agent.rb
-- lib/snowagent/async_strategy.rb
 - lib/snowagent/configuration.rb
 - lib/snowagent/railtie.rb
-- lib/snowagent/sender.rb
 - lib/snowagent/service.rb
 - lib/snowagent/sync_strategy.rb
 - lib/snowagent/version.rb

data/lib/snowagent/async_strategy.rb

@@ -1,17 +0,0 @@
-module SnowAgent
-  class AsyncStrategy
-    def initialize(configuration)
-      @queue = Queue.new
-      run_sender(configuration)
-    end
-
-    def run_sender(conf)
-      sender_thread = Thread.new { Sender.new(@queue, conf).run }
-      sender_thread.abort_on_exception = true
-    end
-
-    def metric(metric)
-      @queue.push(metric)
-    end
-  end
-end

data/lib/snowagent/sender.rb

@@ -1,37 +0,0 @@
-module SnowAgent
-  class Sender
-    def initialize(queue, conf)
-      @queue      = queue
-      @service    = Service.new(conf)
-      @conf       = conf
-      @metrics    = []
-      @send_at    = Time.now.to_i + @conf.send_interval
-    end
-
-    def run
-      loop { process }
-    end
-
-    def process
-      # Pop metrics from the queue
-      while !@queue.empty?
-        @metrics << @queue.pop
-      end
-
-      if @send_at <= Time.now.to_i
-        @send_at = Time.now.to_i + @conf.send_interval
-        send_data if @metrics.any?
-      end
-
-      sleep 1
-    end
-
-    def send_data
-      # TODO:
-      # * requeue data on failure
-      @service.post_data({ metrics: @metrics.map(&:to_h) })
-
-      @metrics.clear
-    end
-  end
-end