Merge pull request #2 from v-dolgishev/master

Logs and metrics

Author: eric-martin

.ruby-gemset

@@ -0,0 +1 @@
+stackify-api-ruby

.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.2

Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in stackify.gemspec
+gemspec

Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    stackify-api-ruby (1.0.3)
+      faraday (>= 0.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    multipart-post (2.0.0)
+    rake (0.9.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  rake (~> 0)
+  stackify-api-ruby!

README.md

@@ -1,4 +1,140 @@
-stackify-api-ruby
-=================
+# Stackify
 
-Stackify API for Ruby
+Stackify Logs and Metrics API for Ruby
+
+
+Rails Installation
+------------------
+
+### Rails 3.x/4.x
+
+Add the stackify gem to your Gemfile. In Gemfile:
+
+    gem 'stackify-api-ruby'
+
+Run the bundle command to install it:
+
+    $ bundle
+
+Or install it manually:
+
+    $ gem install stackify-api-ruby
+
+After you install stackify-api-ruby you need to run the generator:
+
+    $ rails g stackify --api_key=your_api_key
+
+The generator creates a file 'config/initializers/stackify.rb' configuring stackify-api-ruby with your API key. You can change default settings there.
+
+Usage: Logging
+------------------
+### Rails Environment
+
+stackify-api-ruby starts with start of Rails. Every error, which occurs within your application, will be caught and sent to Stackify automatically. The same situation with logs - you just use the Rails logger as usual:
+
+    Rails.logger.info "Some log message"
+
+### Other Environment
+
+For using stackify-api-ruby gem within any Ruby application add to top of your main file:
+
+    require 'stackify-api-ruby'
+
+After that you need to make base configuration:
+
+    Stackify.setup do |config|
+      config.api_key = "your_api_key"
+      config.env = :development
+      config.app_name = "Your app name"
+      config.app_location = "/somewhere/public"
+    end
+
+"api_key" - it's you key for Stackify. "app-location" - it's location of your application for Nginx/Apache(for Nginx it's value of 'root', for Apache it's value of 'DocumentRoot' at config files).
+
+Gem has 3 modes of work - "both", "logging", "metrics". Mode "both" turns on both parts of gem - logging and metrics.
+If you need ONLY logging or metrics use "logging" or "metrics" mode accordingly.
+
+    config.mode = :metrics
+
+You can set minimal level of logs, which should be caught by gem:
+
+    config.log_level = :error
+
+If you want to use proxy for sending request, you can do it in such way:
+
+    config.proxy = { uri: '127.0.0.1:8118', user: 'user_name', password: 'some_password' }
+
+For internal logging stackify-api-ruby uses such logger:
+
+    config.logger = Logger.new(File.join(Rails.root, "log", "stackify.log"))
+
+After logs configuring you should wrap up your logger:
+
+    logger = Logger.new('mylog.log')
+    logger = Stackify::LoggerProxy.new(logger)
+
+
+And last thing you need to do - call method "run":
+
+    Stackify.run #remember that this call is running in the background of your main script
+
+Usage: Metrics
+------------------
+
+There are four different types of metrics:
+
+- **Gauge**: Keeps track of the last value that was set in the current minute
+
+        Stackify::Metrics.set_gauge "MyCategory", "MyGauge", 100
+
+- **Counter**: Calculates the rate per minute
+
+        Stackify::Metrics.count "MyCategory", "MyCounter"
+
+- **Average**: Calculates the average of all values in the current minute
+
+        Stackify::Metrics.average "MyCategory", "AverageSpeed", 200
+
+- **Timer**: Calculates the average elapsed time for an operation in the current minute
+
+        t = Time.now
+        Stackify::Metrics.time "MyCategory", "ElapsedTime", t
+
+- **Counter and Timer**: Composite of the Counter and Timer metrics for convenience
+
+        t = Time.now
+        Stackify::Metrics.count_and_time "Metric", "CounterWithTime", t
+
+We can configure every metric with settings:
+
+        settings = MetricSettings.new
+        settings.autoreport_zero_if_nothing_reported = true
+        # or
+        settings.autoreport_last_value_if_nothing_reported = true
+        Stackify::Metrics.set_gauge "MyCategory", "MyGauge", 100 , settings
+
+Note, "autoreport_last_value_if_nothing_reported" property has influence only on "average" metric.
+
+Also there are two methods for getting last values of metrics:
+
+- get_latest - return last value of certain metric
+
+    ``` Stackify::Metrics.get_latest "MyCategory", "MyCounter" ```
+
+- get_latest_all_metrics - return all values of existed metrics
+
+    ``` Stackify::Metrics.get_latest_all_metrics```
+
+## Requirements
+Ruby: 1.9/2.0/2.1
+
+Rails: 3.x/4.x
+
+Contributing
+------------------
+
+1. Fork it ( https://github.com/[my-github-username]/stackify/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

Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+

lib/core_ext/core_ext.rb

@@ -0,0 +1,3 @@
+require 'json'
+require 'core_ext/object'
+require 'core_ext/fixnum'

lib/core_ext/fixnum.rb

@@ -0,0 +1,17 @@
+class Fixnum
+  SECONDS_IN_MINUTE = 60
+  SECONDS_IN_HOUR =  60 * SECONDS_IN_MINUTE
+  SECONDS_IN_DAY = 24 * SECONDS_IN_HOUR
+
+  def days
+    self * SECONDS_IN_DAY
+  end
+
+  def minutes
+    self * SECONDS_IN_MINUTE
+  end
+
+  def ago
+    Time.now - self
+  end
+end

lib/core_ext/object.rb

@@ -0,0 +1,9 @@
+class Object
+  def try(*a, &b)
+    if a.empty? && block_given?
+      yield self
+    else
+      public_send(*a, &b) if respond_to?(a.first)
+    end
+  end
+end

lib/generators/stackify/stackify_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators/base'
+
+class StackifyGenerator < Rails::Generators::Base
+  source_root File.expand_path('../../stackify/templates', __FILE__)
+
+  class_option :api_key, type: :string, required: true
+
+  desc 'Creates a Stackify initializer'
+  def copy_initializer
+    template 'stackify.rb', 'config/initializers/stackify.rb'
+  end
+
+end