metriks-addons 3.1.1 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de657fb2939c9723d6b041a74355f871c3a75cd8
-  data.tar.gz: 1147d1d4f526d4d1dbc164eefc5b6b94d4725254
+  metadata.gz: 2285af2f22ebdaf11723b9540d1068f3e7af7f27
+  data.tar.gz: 7e7091d57a8824e73b3d4f6b8dd350496cbe9dd6
 SHA512:
-  metadata.gz: 0606bb952c50522773bda63b40eda5197f10233441f172c056144e8a7477c422c0efae432f39bc01d42e41e580cb363c8d2609e1b501e15c382865a31b9aa3dc
-  data.tar.gz: 3f1ad2fe5c975185b50f1b737094f15ea48c5d403fb488b56163a729b87153ff743c32e73ddad2fa732d2d79e4b55c7470553b22e362b3309053bbc2cccaedb6
+  metadata.gz: 57eea536cb3094f49d38e83dd17291068c7ef228928c8cedbcaf203c26f25d201526e337025fa69492e9e7578d86db0b63691c1ded1f244a1a2d16d1fd9fdcb2
+  data.tar.gz: 1218d9cb65f11b3664b0988fe4017e934c02ea05b27d1326b44e6407bc61351960bc243bc96dd1de4808050c0c48bcb8bf12d5f0567a160d399a8dd2ddc8807d

data/Gemfile

@@ -1,3 +1,18 @@
+##
+ # Copyright (c) 2015. Qubole Inc
+ # Licensed under the Apache License, Version 2.0 (the "License");
+ # you may not use this file except in compliance with the License.
+ # You may obtain a copy of the License at
+ #
+ #     http://www.apache.org/licenses/LICENSE-2.0
+ #
+ # Unless required by applicable law or agreed to in writing, software
+ # distributed under the License is distributed on an "AS IS" BASIS,
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ # See the License for the specific language governing permissions and
+ #    limitations under the License.
+##
+
 source 'https://rubygems.org'
 
 gemspec

data/NOTICE

@@ -0,0 +1,2 @@
+Qubole Quark
+Copyright 2012-2015 Qubole Inc

data/README.md

@@ -1,26 +1,58 @@
-# Metriks reporter for OpenTSDB
+# Utilities for collecting metrics in a Rails Application
 
-[![Build Status](https://travis-ci.org/vrajat/metriks-addons.svg)](https://travis-ci.org/vrajat/metriks-addons)
+[![Build Status](https://travis-ci.org/qubole/metriks-addons.svg)](https://travis-ci.org/qubole/metriks-addons)
 
-This is the [metriks](https://github.com/eric/metriks) reporter for
-OpenTSDB and SignalFX.
-It is heavily inspired from
-[Librato Reporter] (https://github.com/eric/metriks-librato_metrics)
+This gem provides utilities for collecting and reporting metrics
+in a Rails Application. This gem uses [metriks](https://github.com/eric/metriks).
+
+The first category of utilities is Reporters.
 
-## How to use it
+## Reporters
+Reporters are available for OpenTSDB, SignalFX and AWS Cloudwatch.
+The design is heavily inspired by
+[Librato Reporter] (https://github.com/eric/metriks-librato_metrics)
 
-Sends metrics to OpenTSDB every 60 seconds.
+### OpenTSDBReporter
 
 ``` ruby
-  reporter = Metriks::OpenTSDBReporter.new(host, port, tags)
+  reporter = Metriks::OpenTSDBReporter.new(host, tags, options)
   reporter.start
 ```
 1. host: hostname of OpenTSDB
-2. port: port on which OpenTSDB
-3. tags: A hash of tags that should be associated with every metric.
+2. tags: A hash of tags that should be associated with every metric.
+3. options: A hash to control behavior of the reporter. Valid options are:
+
+### SignalFXReporter
+
+``` ruby
+  reporter = Metriks::SignalFXReporter.new(token, tags, options = {})
+  reporter.start
+```
+
+1. token: Token provided by SignalFX
+2. tags: A hash of tags that should be associated with every metric.
+
+### CloudWatchReporter
+
+``` ruby
+  reporter = Metriks::CloudWatchReporter.new((access_key, secret_key, namespace, tags, options = {}))
+  reporter.start
+```
+
+1. access_key: Access Key provided by AWS
+2. secret_key: Secret Key provided by AWS
+3. namespace: AWS CloudWatch namespace of the metric
+4. tags: A hash of tags that should be associated with every metric.
 
-# License
+### Options
 
-Copyright (c) 2015 Rajat Venkatesh
+All reporters accept a hash of options. Options are used to control the behavior
+of the reporter.
 
-Published under the Apache 2.0 License, see LICENSE
+| Option | Description (Default)|
+---------|----------------------|
+| prefix | Add a prefix to the metric name ()|
+| batch_size | Number of metrics to report in a API call (50)|
+| logger | Logger for debug and info messages (nil) |
+| registry | Metriks::Registry to use. (Metriks::Registry.default) |
+| interval | Interval between two runs (60 secs) |

data/Rakefile

@@ -1,3 +1,18 @@
+##
+ # Copyright (c) 2015. Qubole Inc
+ # Licensed under the Apache License, Version 2.0 (the "License");
+ # you may not use this file except in compliance with the License.
+ # You may obtain a copy of the License at
+ #
+ #     http://www.apache.org/licenses/LICENSE-2.0
+ #
+ # Unless required by applicable law or agreed to in writing, software
+ # distributed under the License is distributed on an "AS IS" BASIS,
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ # See the License for the specific language governing permissions and
+ #    limitations under the License.
+##
+
 require 'rubygems'
 require 'rake'
 require 'date'

data/lib/metriks-addons.rb

@@ -1,7 +1,22 @@
+##
+ # Copyright (c) 2015. Qubole Inc
+ # Licensed under the Apache License, Version 2.0 (the "License");
+ # you may not use this file except in compliance with the License.
+ # You may obtain a copy of the License at
+ #
+ #     http://www.apache.org/licenses/LICENSE-2.0
+ #
+ # Unless required by applicable law or agreed to in writing, software
+ # distributed under the License is distributed on an "AS IS" BASIS,
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ # See the License for the specific language governing permissions and
+ #    limitations under the License.
+##
+
 require_relative 'metriks-addons/opentsdb_reporter'
 require_relative 'metriks-addons/signalfx_reporter'
 require_relative 'metriks-addons/cloudwatch_reporter'
 
 module MetriksAddons
-  VERSION = '3.1.1'
+  VERSION = '3.1.2'
 end

data/lib/metriks-addons/base_reporter.rb

@@ -1,3 +1,17 @@
+##
+ # Copyright (c) 2015. Qubole Inc
+ # Licensed under the Apache License, Version 2.0 (the "License");
+ # you may not use this file except in compliance with the License.
+ # You may obtain a copy of the License at
+ #
+ #     http://www.apache.org/licenses/LICENSE-2.0
+ #
+ # Unless required by applicable law or agreed to in writing, software
+ # distributed under the License is distributed on an "AS IS" BASIS,
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ # See the License for the specific language governing permissions and
+ #    limitations under the License.
+##
 module MetriksAddons
   class BaseReporter
     def initialize(options = {})

data/lib/metriks-addons/cloudwatch_reporter.rb

@@ -1,3 +1,18 @@
+##
+ # Copyright (c) 2015. Qubole Inc
+ # Licensed under the Apache License, Version 2.0 (the "License");
+ # you may not use this file except in compliance with the License.
+ # You may obtain a copy of the License at
+ #
+ #     http://www.apache.org/licenses/LICENSE-2.0
+ #
+ # Unless required by applicable law or agreed to in writing, software
+ # distributed under the License is distributed on an "AS IS" BASIS,
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ # See the License for the specific language governing permissions and
+ #    limitations under the License.
+##
+
 require 'metriks/time_tracker'
 require 'logger'
 require 'aws'

data/lib/metriks-addons/opentsdb_reporter.rb

@@ -1,3 +1,18 @@
+##
+ # Copyright (c) 2015. Qubole Inc
+ # Licensed under the Apache License, Version 2.0 (the "License");
+ # you may not use this file except in compliance with the License.
+ # You may obtain a copy of the License at
+ #
+ #     http://www.apache.org/licenses/LICENSE-2.0
+ #
+ # Unless required by applicable law or agreed to in writing, software
+ # distributed under the License is distributed on an "AS IS" BASIS,
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ # See the License for the specific language governing permissions and
+ #    limitations under the License.
+##
+
 require 'metriks/time_tracker'
 require 'rest-client'
 require 'logger'

data/lib/metriks-addons/signalfx_reporter.rb

@@ -1,3 +1,18 @@
+##
+ # Copyright (c) 2015. Qubole Inc
+ # Licensed under the Apache License, Version 2.0 (the "License");
+ # you may not use this file except in compliance with the License.
+ # You may obtain a copy of the License at
+ #
+ #     http://www.apache.org/licenses/LICENSE-2.0
+ #
+ # Unless required by applicable law or agreed to in writing, software
+ # distributed under the License is distributed on an "AS IS" BASIS,
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ # See the License for the specific language governing permissions and
+ #    limitations under the License.
+##
+
 require 'metriks/time_tracker'
 require 'logger'
 require 'signalfx'
@@ -49,7 +64,7 @@ module MetriksAddons
             :count
           ]
         when Metriks::Counter
-          counter |= create_datapoints name, metric, time, [
+          gauge |= create_datapoints name, metric, time, [
             :count
           ]
         when Metriks::Gauge

data/metriks-addons.gemspec

@@ -1,3 +1,18 @@
+##
+ # Copyright (c) 2015. Qubole Inc
+ # Licensed under the Apache License, Version 2.0 (the "License");
+ # you may not use this file except in compliance with the License.
+ # You may obtain a copy of the License at
+ #
+ #     http://www.apache.org/licenses/LICENSE-2.0
+ #
+ # Unless required by applicable law or agreed to in writing, software
+ # distributed under the License is distributed on an "AS IS" BASIS,
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ # See the License for the specific language governing permissions and
+ #    limitations under the License.
+##
+
 ## This is the rakegem gemspec template. Make sure you read and understand
 ## all of the comments. Some sections require modification, and others can
 ## be deleted if you don't need them. Once you understand the contents of
@@ -13,8 +28,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'metriks-addons'
-  s.version           = '3.1.1'
-  s.date              = '2015-11-23'
+  s.version           = '3.1.2'
+  s.date              = '2015-12-23'
 
   ## Make sure your summary is short. The description may be as long
   ## as you like.
@@ -49,7 +64,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'metriks', '~> 0.9', '>= 0.9.9.7'
   s.add_runtime_dependency 'rest-client', '>= 1.6.7'
   s.add_runtime_dependency 'signalfx', '>= 0.1.0'
-  
+
   ## List your development dependencies here. Development dependencies are
   ## those that are only needed during development
   s.add_development_dependency('mocha', ['~> 0.10'])
@@ -61,6 +76,7 @@ Gem::Specification.new do |s|
   s.files = %w[
     Gemfile
     LICENSE
+    NOTICE
     README.md
     Rakefile
     lib/metriks-addons.rb

data/spec/cloudwatch_spec.rb

@@ -1,3 +1,18 @@
+##
+ # Copyright (c) 2015. Qubole Inc
+ # Licensed under the Apache License, Version 2.0 (the "License");
+ # you may not use this file except in compliance with the License.
+ # You may obtain a copy of the License at
+ #
+ #     http://www.apache.org/licenses/LICENSE-2.0
+ #
+ # Unless required by applicable law or agreed to in writing, software
+ # distributed under the License is distributed on an "AS IS" BASIS,
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ # See the License for the specific language governing permissions and
+ #    limitations under the License.
+##
+
 require 'webmock/rspec'
 require 'metriks'
 require 'metriks-addons/cloudwatch_reporter'

data/spec/opentsdb_spec.rb

@@ -1,3 +1,18 @@
+##
+ # Copyright (c) 2015. Qubole Inc
+ # Licensed under the Apache License, Version 2.0 (the "License");
+ # you may not use this file except in compliance with the License.
+ # You may obtain a copy of the License at
+ #
+ #     http://www.apache.org/licenses/LICENSE-2.0
+ #
+ # Unless required by applicable law or agreed to in writing, software
+ # distributed under the License is distributed on an "AS IS" BASIS,
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ # See the License for the specific language governing permissions and
+ #    limitations under the License.
+##
+
 require 'webmock/rspec'
 require 'metriks'
 require 'metriks-addons/opentsdb_reporter'

data/spec/signalfx_spec.rb

@@ -1,3 +1,18 @@
+##
+ # Copyright (c) 2015. Qubole Inc
+ # Licensed under the Apache License, Version 2.0 (the "License");
+ # you may not use this file except in compliance with the License.
+ # You may obtain a copy of the License at
+ #
+ #     http://www.apache.org/licenses/LICENSE-2.0
+ #
+ # Unless required by applicable law or agreed to in writing, software
+ # distributed under the License is distributed on an "AS IS" BASIS,
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ # See the License for the specific language governing permissions and
+ #    limitations under the License.
+##
+
 require 'webmock/rspec'
 require 'metriks'
 require 'metriks-addons/signalfx_reporter'
@@ -33,11 +48,11 @@ describe "Smoke test" do
   it "counters" do
     @registry.counter('counter.testing').increment
     datapoints = @reporter.get_datapoints
-    expect(datapoints[:counters].size).to eql(1)
-    expect(datapoints[:counters][0][:metric]).to eql("counter.testing.count")
-    expect(datapoints[:counters][0][:value]).to eql(1)
-    expect(datapoints[:counters][0][:dimensions]).to include(:env => "test")
-    expect(datapoints[:counters][0][:timestamp]).not_to be_nil
+    expect(datapoints[:gauges].size).to eql(1)
+    expect(datapoints[:gauges][0][:metric]).to eql("counter.testing.count")
+    expect(datapoints[:gauges][0][:value]).to eql(1)
+    expect(datapoints[:gauges][0][:dimensions]).to include(:env => "test")
+    expect(datapoints[:gauges][0][:timestamp]).not_to be_nil
   end
 
   it "timer" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metriks-addons
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.1.2
 platform: ruby
 authors:
 - Rajat Venkatesh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-23 00:00:00.000000000 Z
+date: 2015-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metriks
@@ -82,6 +82,7 @@ extra_rdoc_files:
 files:
 - Gemfile
 - LICENSE
+- NOTICE
 - README.md
 - Rakefile
 - lib/metriks-addons.rb
@@ -113,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 2
 summary: Reporters for Metriks.