hg-api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 707dd430082262283db96436e1b07a8c0cca779a
-  data.tar.gz: aeaf032ff4ca32998942c0b928e1a30e0715070b
+  metadata.gz: b4d586a9dc6008c4b2850fb6222040b334fdd3c1
+  data.tar.gz: 0191a6b0e33a137be05b4044275297099bfd6ecc
 SHA512:
-  metadata.gz: 0b60ca7188810a394c264785f9f20a2fab5bfd81f13f9eb401bb904439c649494c2ef1f70221f18e66ff8d17fed9a3d331e703c319b82217d6b6ab6b2df9038e
-  data.tar.gz: b29693de3c2080a4faab643d20cb51eacbac2a1fe7e25604a395e879e1edbbe5d9c1e9b89497075b6d4a33f130398d8bd9c5bad9a8e94bb9de3203b16215921b
+  metadata.gz: ffb639122d85d49bbcefa9216d4325eb6c627e2a9000d99cba14a2fb3247179597c2ea2ae3c2c720d9b34aaf9dccd50fba520820a485f9f94209c7d07435164c
+  data.tar.gz: c2e75bdfb457a5408c53109030f6da6c6a0232595ca8646bd4e6c570ef98365738295cf68c5fb2513dd1478ef74a1a206d44dc55235e720d9319e8c6c89c0dd9

data/README.md

@@ -24,7 +24,7 @@ client.metric("signup", 1)
 client.metric("load", 100, via: :tcp)
 ```
 
-Default transport is udp, it can be changed by passing options hash while
+Default transport is UDP, it can be changed by passing options hash while
 constructing client:
 
 ```ruby
@@ -34,7 +34,21 @@ client.metric("this.metric.send.over.http", 5)
 
 Supported transports: udp, tcp, http.
 
-API KEY must be present as environmental variable HOSTED_GRAPHITE_API_KEY.
+API KEY must be present as environmental variable `HOSTED_GRAPHITE_API_KEY`.
+
+Host and port for UDP also can be configured via env vars, `HOSTED_GRAPHITE_HOST`
+and `HOSTED_GRAPHITE_PORT` respectively, as well as URI for HTTP - `HOSTED_GRAPHITE_PORT`.
+
+Default settings are `carbon.hostedgraphite.com` host and `2003` port, http uri `https://hostedgraphite.com/api/v1/sink`.
+
+Also you can pass prefix, which will be added to each key:
+
+
+```ruby
+client = HGAPI.new(prefix: ["apps", "yourappname"])
+# or:
+client = HGAPI.new(prefix: "apps.yourappname")
+```
 
 ## Contributing
 

data/lib/hg_api/client.rb

@@ -8,19 +8,38 @@ module HGAPI
     HOST = 'carbon.hostedgraphite.com'
     PORT = 2003
 
+    attr_reader :disabled, :settings
+
     def initialize(options = {})
-      @default_transport = check_transport!(options[:via]) || :udp
-      @api_key = ENV["HOSTED_GRAPHITE_API_KEY"]
-      @disabled = @api_key.nil?
+      @settings = build_settings(options)
+      @disabled = @settings[:api_key].nil?
     end
 
     def metric(key, value, options = {})
       return if @disabled
-      send_metric(key, value, check_transport!(options[:via]) || @default_transport)
+      send_metric(key, value, check_transport!(options[:via]) || settings[:default_transport])
+    end
+
+    def time(key, options = {})
+      start = Time.now
+      result = yield
+      metric(key, ((Time.now - start) * 1000).round, options)
+      result
     end
 
     private
 
+    def build_settings(options)
+      {
+        :api_key           => ENV["HOSTED_GRAPHITE_API_KEY"],
+        :host              => ENV["HOSTED_GRAPHITE_HOST"] || HOST,
+        :port              => ENV["HOSTED_GRAPHITE_PORT"] || PORT,
+        :http_uri          => ENV["HOSTED_GRAPHITE_HTTP_URI"] || HTTP_URI,
+        :default_transport => check_transport!(options[:via]) || :udp,
+        :prefix            => options[:prefix]
+      }
+    end
+
     def check_transport!(transport)
       if transport && !SUPPORTED_TRANSPORTS.include?(transport.to_sym)
         raise "#{transport} is unsupported transport"
@@ -34,26 +53,34 @@ module HGAPI
 
     def send_metric_udp(key, value)
       sock = UDPSocket.new
-      sock.send "#{@api_key}.#{key} #{value}\n", 0, HOST, PORT
+      sock.send "#{@settings[:api_key]}.#{prefix}#{key} #{value}\n", 0, @settings[:host], @settings[:port]
       sock.close
     end
 
     def send_metric_tcp(key, value)
-      conn = TCPSocket.new HOST, PORT
-      conn.puts "#{@api_key}.#{key} #{value}\n"
+      conn = TCPSocket.new @settings[:host], @settings[:port]
+      conn.puts "#{@settings[:api_key]}.#{prefix}#{key} #{value}\n"
       conn.close
     end
 
     def send_metric_http(key, value)
-      uri = URI(HTTP_URI)
+      uri = URI(@settings[:http_uri])
 
       req = Net::HTTP::Post.new(uri.request_uri)
-      req.basic_auth @api_key, nil
-      req.body = "#{key} #{value}"
+      req.basic_auth @settings[:api_key], nil
+      req.body = "#{prefix}#{key} #{value}"
 
       res = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
         http.request(req)
       end
     end
+
+    def prefix
+      @prefix ||= if settings[:prefix] && !settings[:prefix].empty?
+        Array(settings[:prefix]).join('.') << '.'
+      else
+        ""
+      end
+    end
   end
 end

data/lib/hg_api/version.rb

@@ -1,3 +1,3 @@
 module HGAPI
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hg-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Artyom Keydunov