graphite-api 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7f26c3b31d445c4e11d556609f0c3b600c60fe7
-  data.tar.gz: 657df67acbef98202c7278e473994b4bd47841f9
+  metadata.gz: 971a57f1632c01fa383fcafd604fb0c020e55039
+  data.tar.gz: b49356560ef58767756cb38c5110685307ec5113
 SHA512:
-  metadata.gz: 4e464886000e85f88d21dd6351d60e3160a3dc9b4e66b4d98f72f7fd3ae1f50556494843c21b3430d1d26aa11ed2c7c9d23dcf36bd8b7177a1dc804e07811d91
-  data.tar.gz: 8cba41ac302987b045af13b8ef025ff08b9c93e49353442e38edbd7b8db66ec70c4f538ec4f6aff4d125e2f777972aef5bc1b7b5a20b2104863e1803573e183a
+  metadata.gz: 0a31a71042953ac8b4cee6c23f29b934f6202b2e0f609a6b80b99d20b122683461f2a6e2bdb8ae25fb8fb07ebe5d6239499390c8beee2f329003656e8cdbc29d
+  data.tar.gz: 4e4d60ccf3f79cf80af1efad3018731f99e252c02ec0e281e6ec6414ee53c7e9b4fe66a8e19ad5f906a33ca7d9b25ec897d0c5299afd794ff5115a8ea97f92ac

data/README.md

@@ -41,19 +41,40 @@ rake install
 ```
 
 ## Client Usage
-Creating a new client instance
+
+Creating a new UDP client
 
 ```ruby
 require 'graphite-api'
 
-GraphiteAPI.new(
-  graphite: "udp://graphite.example.com:2003", # required argument
-  prefix: ["example","prefix"],                # add example.prefix to each key
-  slice: 60,                                   # results are aggregated in 60 seconds slices
-  interval: 60,                                # send to graphite every 60 seconds
-                                               # default is 0 ( direct send )
-  cache: 4 * 60 * 60                           # set the max age in seconds for records reanimation
-)
+options = {
+  # Required: valid URI {udp,tcp}://host:port/?timeout=seconds
+  graphite: "udp://graphite.example.com:2003", 
+  
+  # Optional: add example.prefix to each key
+  prefix: ["example","prefix"],
+  
+  # Optional: results are aggregated in 60 seconds slices ( default is 60 )
+  slice: 60,
+  
+  # Optional: send to graphite every 60 seconds ( default is 0 - direct send )
+  interval: 60,
+  
+  # Optional: set the max age in seconds for records reanimation ( default is 12 hours )
+  cache: 4 * 60 * 60
+}
+
+client = GraphiteAPI.new options 
+```
+
+TCP Client
+```ruby
+client = GraphiteAPI.new graphite: "tcp://graphite.example.com:2003"
+```
+
+TCP Client with 30 seconds timeout
+```ruby
+client = GraphiteAPI.new graphite: "tcp://graphite.example.com:2003?timeout=30"
 ```
 
 Adding simple metrics
@@ -226,11 +247,6 @@ client.bla.bla.value2 27
 <br/>
 <img src="https://raw.github.com/kontera-technologies/graphite-api/master/examples/middleware_t1.png" align="center">
 
-## TODO:
-* Better documentation
-* Use Redis for caching
-* Multiple backends via client as well
-
 ## Bugs
 
 If you find a bug, feel free to report it @ our [issues tracker](https://github.com/kontera-technologies/graphite-api/issues) on github.

data/lib/graphite-api/connector.rb

@@ -45,7 +45,7 @@ module GraphiteAPI
       def socket
         @socket ||= begin
           host, port = @uri.host, @uri.port
-          timeout = Hash[URI.decode_www_form(@uri.query.to_s)].fetch("timeout", 1)
+          timeout = Hash[URI.decode_www_form(@uri.query.to_s)].fetch("timeout", 1).to_f
           addr = Socket.getaddrinfo host, nil, :INET
           sockaddr = Socket.pack_sockaddr_in port, addr[0][3]
 
@@ -79,7 +79,7 @@ module GraphiteAPI
       end
 
       def publish messages
-        Logger.debug [:connector_group, :publish, messages, @connectors]
+        Logger.debug [:connector_group, :publish, messages.size, @connectors]
         Array(messages).each { |msg| @connectors.map {|c| c.puts msg} }
       end
     end
@@ -94,7 +94,7 @@ module GraphiteAPI
     def puts message
       counter = 0
       begin
-        Logger.debug [:connector, :puts, @uri, message]
+        Logger.debug [:connector, :puts, @uri.to_s, message]
         socket.puts message + "\n"
       rescue Exception
         @socket = nil
@@ -102,11 +102,14 @@ module GraphiteAPI
       end
     end
 
+    def inspect
+      "#<#{self.class}:#{object_id}: #{@uri}>"
+    end
+
     private 
 
     def socket
       if @socket.nil? || @socket.closed?
-        Logger.debug [:connector, :init, @uri]
         @socket = @uri.scheme.eql?("tcp") ? TCPSocket.new(@uri) : UDPSocket.new(@uri)
       end
       @socket

data/lib/graphite-api/version.rb

@@ -1,3 +1,3 @@
 module GraphiteAPI
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphite-api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Eran Barak Levi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-25 00:00:00.000000000 Z
+date: 2018-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine