graphite-api 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f81b82a2dff25c88b118c8734da6711683cd3dbe4befa2d5faea3172d3c752b
-  data.tar.gz: f0c6278c05daba7691b3a854953b2a6f5d8abb0338298fddc76afa2ae8892d24
+  metadata.gz: '0595ca2197bbdfe81fd61a7fc06f4949adea392b2c3ca7aee0d4c461eccb7479'
+  data.tar.gz: 4a8df14d1e1f7a7a39fde283eae647668f08c6ce4005a5dc4e435153cba417d0
 SHA512:
-  metadata.gz: ea462f77942592a9b31067f091b417b3e6bc13a945f68e11c5d283744e7d585a3ee4136400175c5cd9778ccb012ccfca3bd3a9ed569eba3c7e83d861736dee89
-  data.tar.gz: 951db12f2528aeff81202121809c09d96394e25c65a2ca14a79297c0f3789c3f8109f931c28575303ae05d875b0edc0b24d9d5d2851d87f1735dec7cf4322e01
+  metadata.gz: 5373a60c92806962795637d6ab23bedf523db35a02fcaf6ae8f99b699c8f0e97e3aed3d952e03b891db1dde3c9388a7224a9753871b0b05f76be39bbd13730c5
+  data.tar.gz: 8148064e7eeeaa35847b8f50dc153cb33aa13277f2cab8b25a8c6d3570eb1bd33c59845550d2d7c25cdd58465305f24ee2d0d5df0e1362943b86a9ac2a40a287

data/README.md

@@ -175,6 +175,30 @@ client.every 52.minutes do |c|
 end
 ```
 
+Stopping the client loop
+```ruby
+require 'graphite-api'
+
+client = GraphiteAPI.new( graphite: 'tcp://graphite:2003' )
+
+# Lets send the metric every 2 minutes.
+client.every(2.minutes) do |c|
+  c.metrics("webServer.web01.uptime" => `uptime`.split.first.to_i)
+end
+
+sleep 2.minutes # Client will send one message.
+
+client.pause
+sleep 6.minutes # Client will not send any messages.
+
+client.resume
+sleep 4.minutes # Client will send 2 messages.
+
+client.cancel
+client.resume
+sleep 6.minutes # After cancel, client will not send any more messages.
+```
+
 Make your own custom metrics daemons, using `client#join`
 ```ruby
 require 'graphite-api'

data/lib/graphite-api.rb

@@ -1,4 +1,3 @@
-require 'zscheduler'
 require 'graphite-api/version'
 require 'graphite-api/client'
 require 'graphite-api/cache'

data/lib/graphite-api/buffer.rb

@@ -24,7 +24,10 @@ module GraphiteAPI
 
     IGNORE = ["\r"]
     END_OF_STREAM = "\n"
-    VALID_MESSAGE = /^[\w|\.|-]+ \d+(?:\.|\d)* \d+$/
+
+    # Matches the metric name (string with dots and dashes), at least one space, the metric value (int or float),
+    # at least one space and finally the metric timestamp (int)
+    VALID_MESSAGE = /^[\w.-]+ +\d+(?:\.\d+)? +\d+$/
 
     AGGREGATORS = {
       sum: ->(*args) { args.reduce(0) { |sum, x| sum + x } },
@@ -32,11 +35,11 @@ module GraphiteAPI
       replace: ->(*args) { args.last },
     }
 
-    def initialize options
+    def initialize options, timers=false
       @options = options
       @queue = Queue.new
       @streamer = Hash.new {|h,k| h[k] = ""}
-      @cache = Cache::Memory.new(options) if options[:cache]
+      @cache = Cache::Memory.new(options, timers) if options[:cache]
     end
 
     attr_reader :queue, :options, :streamer, :cache

data/lib/graphite-api/cache.rb

@@ -1,9 +1,12 @@
+require 'timers'
+
 module GraphiteAPI
   module Cache
     class Memory
+      extend Forwardable
 
-      def initialize options
-        Zscheduler.every(120) { clean(options[:cache]) }
+      def initialize options, timers=false
+        timers.every(120) { clean(options[:cache]) } if timers
       end
 
       def get time, key

data/lib/graphite-api/client.rb

@@ -1,22 +1,31 @@
 require 'forwardable'
 require 'thread'
+require 'timers'
 
 module GraphiteAPI
   class Client
     extend Forwardable
 
-    def_delegator Zscheduler, :loop, :stop
+    def_delegator :timers, :cancel
+    def_delegator :timers, :pause
+    def_delegator :timers, :resume
+
+    def_delegator :buffer, :stream
 
     attr_reader :options, :buffer, :connectors, :mu
     private     :options, :buffer, :connectors, :mu
 
     def initialize opt
       @options = build_options validate opt.clone
-      @buffer  = GraphiteAPI::Buffer.new options
+      @buffer  = GraphiteAPI::Buffer.new options, timers
       @connectors = GraphiteAPI::Connector::Group.new options
       @mu = Mutex.new
 
-      Zscheduler.every(options[:interval],&method(:send_metrics!)) unless options[:direct]
+      timers.every(options[:interval], true, &method(:send_metrics!)) unless options[:direct]
+    end
+
+    def timers
+      @timers ||= Timers::Group.new.tap {|t| Thread.new { loop { t.wait } } }
     end
 
     # throw exception on Socket error
@@ -25,7 +34,7 @@ module GraphiteAPI
     end
 
     def every interval, &block
-      Zscheduler.every( interval ) { block.arity == 1 ? block.call(self) : block.call }
+      @timers.every(interval) { block.arity == 1 ? block.call(self) : block.call }
     end
 
     def metrics metric, time = nil, aggregation_method = nil
@@ -73,14 +82,14 @@ module GraphiteAPI
 
     def build_options opt
       self.class.default_options.tap do |options_hash|
-        options_hash[:backends].push opt.delete :graphite
+        options_hash[:backends] = Array(opt.delete :graphite)
         options_hash.merge! opt
         options_hash[:direct] = options_hash[:interval] == 0
         options_hash[:slice] = 1 if options_hash[:direct]
       end
     end
 
-    def send_metrics!
+    def send_metrics! *_
       mu.synchronize { connectors.publish buffer.pull :string if buffer.new_records? }
     end
 

data/lib/graphite-api/core_ext/numeric.rb

@@ -1 +1,20 @@
-require 'zscheduler/core_ext/numeric'
+class Numeric
+  {
+    :year   => 365 * 24 * 3600,
+    :month  => 30 * 24 * 3600,
+    :week   => 7 * 24 * 3600,
+    :day    => 24 * 3600,
+    :hour   => 3600,
+    :minute => 60,
+    :second => 1
+  }.each do |m, val|
+    respond_to? m or define_method m do
+      self * val
+    end
+
+    "#{m}s".tap do |plural|
+      respond_to? plural or alias_method plural, m
+    end
+
+  end
+end

data/lib/graphite-api/version.rb

@@ -1,3 +1,3 @@
 module GraphiteAPI
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,43 +1,141 @@
 --- !ruby/object:Gem::Specification
 name: graphite-api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Eran Barak Levi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-19 00:00:00.000000000 Z
+date: 2019-03-25 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: timers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: eventmachine
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.3
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.3
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: zscheduler
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.7
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.7
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: Graphite API - A Simple ruby client, aggregator daemon and API tools
 email: eran@kontera.com
 executables: []