prometheus-api-client 0.3.4 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 417daaa76204d57bd000be9a56ed9ab8f0ef6f7c
-  data.tar.gz: 7880f323f43968220a424d50446763858407c7f1
+  metadata.gz: 326c02ee0f9c8cdde2bca091c94117e8d5c40079
+  data.tar.gz: a1f70967df54fe8bd24228d9292f807b5e7e2875
 SHA512:
-  metadata.gz: 177277cb8fa60af5cfd695b4e5582ec492b0312b56c56254eba4b0ef9f793042dbc199a3a4f624c430de1b74ba73c00c153dd8f7a1806d92cae1968381d68d4c
-  data.tar.gz: 2bf2797121bb33425b2617ce4c93323f79cbfaea9594bc002dde448c955b444d3a6f4131520bc6c5cad5bc50224c7079e0daadc02f624844a20865b683ebea5c
+  metadata.gz: 561e2bdbf187d4d99fc2758e522258b84e7f85a9777718b14cd9f45faa2977e3135116b0ba60c0a4b16cc3d55acce6e4b919cd4ecb3e00b81e94b04e3b2df480
+  data.tar.gz: ac533dd2ca2bae96e190eb06d74cca8d6dd104842b6b2e0123df21b9635244ef27594a422172bf8b2a7151e4c1cdce4d1211787359395f5ac623857a0af1d23b

data/README.md

@@ -22,15 +22,6 @@ require 'prometheus/api_client'
 
 # return a client for host http://localhost:9090/api/v1/
 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"
-)
 ```
 
 #### Changing server hostname
@@ -48,31 +39,64 @@ 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',
-                                          credentials: {token: 'TopSecret'})
+                                          credentials: { token: 'TopSecret' })
 ```
 
+#### Low lavel calls
+
+###### query
+
+```ruby
+require 'prometheus/api_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',
+)
+```
+```
+# response from server is a low level response struct including
+# fields like: method, body and request_headers
+# usually users will not need to use this law level calls
+   ...
+   method=:get,
+   body="{\"status\":\"success\",
+   ...
+```
 #### High level calls
 
+###### query
+
 ```ruby
 
 # 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',
 )
 ```
+```
+# response from server:
+{"resultType"=>"vector", "result"=>[{"metric"=>{}, "value"=>[1502350741.161, "6606.310387038"]}]}
+```
+###### query_range
 
 ```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',
 )
-
+```
+```
 # response from server:
 {"resultType"=>"matrix",
  "result"=>
@@ -104,36 +128,85 @@ prometheus.query_range(
                [1502086470.781, "53892.665282065"]]}]}
 ```
 
+###### label
+
 ```ruby
 # send a label request to server
 prometheus.label('__name__')
-
+```
+```
 # response from server:
-["kubernetes-apiservers", "kubernetes-cadvisor", "kubernetes-nodes",
- "kubernetes-service-endpoints"]
+["APIServiceRegistrationController_adds",
+ "APIServiceRegistrationController_depth",
+ ...
+
 ```
 
+###### targets
+
 ```ruby
 # send a targets request to server
 prometheus.targets()
 ```
+```
+# response from server:
+{"activeTargets"=>
+  [{"discoveredLabels"=>
+     {"__address__"=>"10.35.19.248:8443",
+      "__meta_kubernetes_endpoint_port_name"=>"https",
+      "__meta_kubernetes_endpoint_port_protocol"=>"TCP",
+      "__meta_kubernetes_endpoint_ready"=>"true",
+      "__meta_kubernetes_endpoints_name"=>"kubernetes",
+      "__meta_kubernetes_namespace"=>"default",
+      "__meta_kubernetes_service_label_component"=>"apiserver",
+      "__meta_kubernetes_service_label_provider"=>"kubernetes",
+      "__meta_kubernetes_service_name"=>"kubernetes",
+      "__metrics_path__"=>"/metrics",
+      "__scheme__"=>"https",
+      "job"=>"kubernetes-apiservers"},
+    "labels"=>{"instance"=>"10.35.19.248:8443", "job"=>"kubernetes-apiservers"},
+    "scrapeUrl"=>"https://10.35.19.248:8443/metrics",
+    "lastError"=>"",
+    "lastScrape"=>"2017-08-10T07:35:40.919376413Z",
+    "health"=>"up"},
+    ...
+
+```
 
 #### cAdvisor specialize client
 
+A cAdvisor client is a client that add object specific labels to each REST call,
+objects available are Node, Pod and Container.
+
+###### Node
+
+Add the instance label, user must declare the instance on client creation.
+
+###### Pod
+
+Add the pod_name label, user must declare the pod_name on client creation.
+
+###### Container
+
+Add the container_name and pod_name labels, user must declare container_name and pod_name on client creation.
+
+###### Example
+
 ```ruby
 
 # create a client for cAdvisor metrics of a Node instance 'example.com'
 # connected to a Prometheus server listening on http://example.com:8080
 prometheus = Prometheus::ApiClient::Cadvisor::Node.new(
   instance: 'example.com',
-  url: 'http://example.com:8080',
+  url:      'http://example.com:8080',
 )
 
 # send a query request to server
-prometheus.query(
-  query: "sum(container_cpu_usage_seconds_total)",
-  time:  "2015-07-01T20:10:30.781Z",
-)
+prometheus.query(query: 'sum(container_cpu_usage_seconds_total)')
+```
+```
+# response from server:
+{"resultType"=>"vector", "result"=>[{"metric"=>{}, "value"=>[1502350741.161, "6606.310387038"]}]}
 ```
 
 ## Tests

data/lib/prometheus/api_client.rb

@@ -14,11 +14,10 @@ module Prometheus
     # @option options [String] :url Server base URL.
     # @option options [Hash] :credentials Authentication credentials.
     # @option options [Hash] :options Options used to define connection.
-    # @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.
+    # @option options [String] :proxy Proxy url.
     #
     # A default client is created if options is omitted.
     def self.client(options = {})

data/lib/prometheus/api_client/client.rb

@@ -24,14 +24,13 @@ module Prometheus
       # Create a Prometheus API client:
       #
       # @param [Hash] options
-      # @option options [String] :url server base URL.
+      # @option options [String] :url Server base URL.
       # @option options [Hash] :credentials Authentication credentials.
       # @option options [Hash] :options Options used to define connection.
-      # @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.
+      # @option options [String] :proxy Proxy url.
       #
       # A default client is created if options is omitted.
       def initialize(options = {})
@@ -109,39 +108,58 @@ module Prometheus
 
       # Helper function to evalueate the low level proxy option
       def faraday_proxy(options)
-        options[:http_proxy_uri] if options[:http_proxy_uri]
+        return options[:proxy] if options[:proxy]
+
+        proxy = options[:options]
+        proxy[:http_proxy_uri] if proxy[:http_proxy_uri]
       end
 
       # Helper function to evalueate the low level ssl option
-      def faraday_verify_ssl(options)
-        return unless options[:verify_ssl]
-
-        {
-          verify: options[:verify_ssl] != OpenSSL::SSL::VERIFY_NONE,
-          cert_store: options[:ssl_cert_store],
-        }
+      def faraday_ssl(options)
+        return options[:ssl] if options[:ssl]
+
+        ssl = options[:options]
+        if ssl[:verify_ssl] || ssl[:ssl_cert_store]
+          {
+            verify: ssl[:verify_ssl] != OpenSSL::SSL::VERIFY_NONE,
+            cert_store: ssl[:ssl_cert_store],
+          }
+        end
       end
 
       # Helper function to evalueate the low level headers option
-      def faraday_headers(credentials)
-        return unless credentials[:token]
+      def faraday_headers(options)
+        return options[:headers] if options[:headers]
+
+        headers = options[:credentials]
+        if headers[:token]
+          {
+            Authorization: 'Bearer ' + headers[:token].to_s,
+          }
+        end
+      end
 
-        {
-          Authorization: 'Bearer ' + credentials[:token].to_s,
-        }
+      # Helper function to evalueate the low level headers option
+      def faraday_request(options)
+        return options[:request] if options[:request]
+
+        request = options[:options]
+        if request[:open_timeout] || request[:timeout]
+          {
+            open_timeout: request[:open_timeout],
+            timeout: request[:timeout],
+          }
+        end
       end
 
       # Helper function to create the args for the low level client
       def faraday_options(options)
         {
           url: options[:url] + options[:path],
-          proxy: faraday_proxy(options[:options]),
-          ssl: faraday_verify_ssl(options[:options]),
-          headers: faraday_headers(options[:credentials]),
-          request: {
-            open_timeout: options[:options][:open_timeout],
-            timeout: options[:options][:timeout],
-          },
+          proxy: faraday_proxy(options),
+          ssl: faraday_ssl(options),
+          headers: faraday_headers(options),
+          request: faraday_request(options),
         }
       end
     end

data/lib/prometheus/api_client/version.rb

@@ -2,6 +2,6 @@
 
 module Prometheus
   module ApiClient
-    VERSION = '0.3.4'
+    VERSION = '0.4.1'
   end
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: prometheus-api-client
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.1
 platform: ruby
 authors:
 - Yaacov Zamir
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-08 00:00:00.000000000 Z
+date: 2017-08-10 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: quantile
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.2.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement