prometheus-api-client 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 905999226f7bda4a27b8a4919b4483e297c363eb
-  data.tar.gz: d4765428ac8620f0b9629d47359bb702a25abdcd
+  metadata.gz: 9da5dea98ff711d07aa783e2f5b3b0b161de5b7b
+  data.tar.gz: b4e8224c8c64ac20f3cf198a3e220939776cc09c
 SHA512:
-  metadata.gz: '08df780379f2a4e2d7b099931f936fc02d36351dd8452f4b5627fee2f8f68df83bfc4c474e6ea634cd6ca7b40e5c36fb3d15fb43bd744cbd04cd333e577bd0dd'
-  data.tar.gz: 8ebe88a2fce0fe01fe4428972ea881aae45538f508fdba7caabe98b27521d42def3dc4201dcb43ea292079bfa258726a0c3b9df4f15ed557b3e95195a793010b
+  metadata.gz: 63bfbf3c0fd54a06618d612baedf24d53172034b5a9addc9a6564427030cd01d6dfd553f159a94938bb52b5aa2212169c6afc4e448529ca0bd3d7a63fc83675b
+  data.tar.gz: 04eb576c2927b15caa82fde48e3c8b094935897957927096d271c5488ea01313e4915fa500d9913d05f1647666d314324fb58a528335ef0ffa6844ae771da57d

data/README.md

@@ -25,11 +25,11 @@ prometheus = Prometheus::ApiClient.client
 
 prometheus.get(
   "query_range",
-  :query => "sum(container_cpu_usage_seconds_total" \
-            "{container_name=\"prometheus-hgv4s\",job=\"kubernetes-nodes\"})",
-  :start => "2015-07-01T20:10:30.781Z",
-  :end   => "2015-07-02T20:10:30.781Z",
-  :step  => "120s"
+  query: "sum(container_cpu_usage_seconds_total" \
+         "{container_name=\"prometheus-hgv4s\",job=\"kubernetes-nodes\"})",
+  start: "2015-07-01T20:10:30.781Z",
+  end:   "2015-07-02T20:10:30.781Z",
+  step:  "120s"
 )
 ```
 
@@ -47,7 +47,7 @@ prometheus REST server, this client can use ssl and authentication headears.
 
 ```ruby
 # return a client for host https://example.com/api/v1/ using a Bearer token "TopSecret"
-prometheus = Prometheus::ApiClient.client(url: 'https://example.com:443',
+prometheus = Prometheus::ApiClient.client(url:         'https://example.com:443',
                                           credentials: {token: 'TopSecret'})
 ```
 
@@ -57,25 +57,23 @@ prometheus = Prometheus::ApiClient.client(url: 'https://example.com:443',
 
 # send a query request to server
 prometheus.query(
-  :query => "sum(container_cpu_usage_seconds_total" \
-            "{container_name=\"prometheus-hgv4s\",job=\"kubernetes-nodes\"})",
-  :time => "2015-07-01T20:10:30.781Z",
+  query: "sum(container_cpu_usage_seconds_total" \
+         "{container_name=\"prometheus-hgv4s\",job=\"kubernetes-nodes\"})",
+  time:  "2015-07-01T20:10:30.781Z",
 )
 ```
 
 ```ruby
 # send a query_range request to server
 prometheus.query_range(
-  :query => "sum(container_cpu_usage_seconds_total" \
-            "{container_name=\"prometheus-hgv4s\",job=\"kubernetes-nodes\"})",
-  :start => "2015-07-01T20:10:30.781Z",
-  :end   => "2015-07-02T20:10:30.781Z",
-  :step  => "120s"
+  query: "sum(container_cpu_usage_seconds_total" \
+         "{container_name=\"prometheus-hgv4s\",job=\"kubernetes-nodes\"})",
+  start: "2015-07-01T20:10:30.781Z",
+  end:   "2015-07-02T20:10:30.781Z",
+  step:  "120s"
 )
-```
 
-Example of response to metrics request:
-```
+# response from server:
 {"resultType"=>"matrix",
  "result"=>
   [{"metric"=>
@@ -109,10 +107,8 @@ Example of response to metrics request:
 ```ruby
 # send a label request to server
 prometheus.label('__name__')
-```
 
-Example of response to a label request:
-```
+# response from server:
 ["kubernetes-apiservers", "kubernetes-cadvisor", "kubernetes-nodes",
  "kubernetes-service-endpoints"]
 ```
@@ -135,8 +131,8 @@ prometheus = Prometheus::ApiClient::Cadvisor::Node.new(
 
 # send a query request to server
 prometheus.query(
-  :query => "sum(container_cpu_usage_seconds_total)",
-  :time => "2015-07-01T20:10:30.781Z",
+  query: "sum(container_cpu_usage_seconds_total)",
+  time:  "2015-07-01T20:10:30.781Z",
 )
 ```
 

data/lib/prometheus/api_client/cadvisor.rb

@@ -8,39 +8,42 @@ module Prometheus
     # Client contains the implementation for a Prometheus compatible api_client,
     # With special labels for the cadvisor job.
     module Cadvisor
-      # Create a Prometheus API client:
-      #
-      # @param [Hash] options
-      # @option options [String] :url Server base URL.
-      # @option options [Hash] :params URI query unencoded key/value pairs.
-      # @option options [Hash] :headers Unencoded HTTP header key/value pairs.
-      # @option options [Hash] :request Request options.
-      # @option options [Hash] :ssl SSL options.
-      # @option options [Hash] :proxy Proxy options.
-      #
-      # A default client is created if options is omitted.
-      class Node < Client
-        def initialize(options = {})
-          instance = options[:instance]
-
-          @labels = "job=\"kubernetes-cadvisor\",instance=\"#{instance}\"," \
-            'id="/"'
-          super(options)
+      # A client with special labels for cadvisor metrics
+      class CadvisorClient < Client
+        # Add labels to simple query variables.
+        #
+        # Example:
+        #     "cpu_usage" => "cpu_usage{labels...}"
+        #     "sum(cpu_usage)" => "sum(cpu_usage{labels...})"
+        #     "rate(cpu_usage[5m])" => "rate(cpu_usage{labels...}[5m])"
+        #
+        # Note:
+        #     Not supporting more complex queries.
+        def update_query(query, labels)
+          query.sub(/(?<r>\[.+\])?(?<f>[)])?$/, "{#{labels}}\\k<r>\\k<f>")
         end
 
-        def query(options)
+        # Issues a get request to the low level client.
+        # Update the query options to use specific labels
+        def get(command, options)
           options[:query] = update_query(options[:query], @labels)
-          super(options)
+          @client.get(command, options)
         end
+      end
 
-        def query_range(options)
-          options[:query] = update_query(options[:query], @labels)
+      # A client with special labels for node cadvisor metrics
+      class Node < CadvisorClient
+        def initialize(options = {})
+          instance = options[:instance]
+
+          @labels = "job=\"kubernetes-cadvisor\",instance=\"#{instance}\"," \
+            'id="/"'
           super(options)
         end
       end
 
       # A client with special labels for pod cadvisor metrics
-      class Pod < Client
+      class Pod < CadvisorClient
         def initialize(options = {})
           pod_name = options[:pod_name]
           namespace = options[:namespace] || 'default'
@@ -49,20 +52,10 @@ module Prometheus
             "pod_name=\"#{pod_name}\",container_name=\"POD\""
           super(options)
         end
-
-        def query(options)
-          options[:query] = update_query(options[:query], @labels)
-          super(options)
-        end
-
-        def query_range(options)
-          options[:query] = update_query(options[:query], @labels)
-          super(options)
-        end
       end
 
       # A client with special labels for container cadvisor metrics
-      class Container < Client
+      class Container < CadvisorClient
         def initialize(options = {})
           container_name = args[:container_name]
           pod_name = args[:pod_name]
@@ -72,16 +65,6 @@ module Prometheus
             "pod_name=\"#{pod_name}\",container_name=\"#{container_name}\""
           super(options)
         end
-
-        def query(options)
-          options[:query] = update_query(options[:query], @labels)
-          super(options)
-        end
-
-        def query_range(options)
-          options[:query] = update_query(options[:query], @labels)
-          super(options)
-        end
       end
     end
   end

data/lib/prometheus/api_client/client.rb

@@ -105,19 +105,6 @@ module Prometheus
         raise RequestError, 'Bad response from server'
       end
 
-      # Add labels to simple query variables.
-      #
-      # Example:
-      #     "cpu_usage" => "cpu_usage{labels...}"
-      #     "sum(cpu_usage)" => "sum(cpu_usage{labels...})"
-      #     "rate(cpu_usage[5m])" => "rate(cpu_usage{labels...}[5m])"
-      #
-      # Note:
-      #     Not supporting more complex queries.
-      def update_query(query, labels)
-        query.sub(/(?<r>\[.+\])?(?<f>[)])?$/, "{#{labels}}\\k<r>\\k<f>")
-      end
-
       # Helper function to evalueate the low level proxy option
       def faraday_proxy(options)
         options[:http_proxy_uri] if options[:http_proxy_uri]

data/lib/prometheus/api_client/version.rb

@@ -2,6 +2,6 @@
 
 module Prometheus
   module ApiClient
-    VERSION = '0.3.2'
+    VERSION = '0.3.3'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prometheus-api-client
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Yaacov Zamir
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-07 00:00:00.000000000 Z
+date: 2017-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: quantile