prometheus-api-client 0.1.1 → 0.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a557e4448ade4360c97b1467ccf8a5afc23c244
-  data.tar.gz: 255437c66a4bfbc9b5129519234006b44536b1b3
+  metadata.gz: 7248e7525d856f9fbf407b8e15b6f761e84115af
+  data.tar.gz: a590b35b49f625b63bc572948f2dbd4292b08a8c
 SHA512:
-  metadata.gz: 3b1463359dae9bbbde9c7ceff7a23db40f03d92a9c6b30d33a80fcfaccf76560038acbbad48858b229e03f61f1f93041582c037269a373be58642ea59ac4fd9b
-  data.tar.gz: 149728f4c861090bdbeda63d7356708743803269861aa3448207d281b8391f74c335aaa39b1d098b84b9057885bc09032fdb9ad36de1e477efc1a8215934c319
+  metadata.gz: c7df2b7fd83c373290b1fa2bbe8335dda983f376b4371b90f34d78b12ee68e3c66e81314193ec8e5c93d1ed7da0a8f8072906733d54a42906a501164e222e8ab
+  data.tar.gz: 8153bee7639544c55f133216e295d10f23ad82fca6045bf0686fd76268bd3cc59cac62e02fe69e580b39daf03f782214dd8ecc39edafe5c107dd71e9096a8032

data/README.md

@@ -36,7 +36,7 @@ prometheus.get(
 
 ```ruby
 # return a client for host http://example.com:9090/api/v1/
-prometheus = Prometheus::ApiClient.client('http://example.com:9090')
+prometheus = Prometheus::ApiClient.client(url: 'http://example.com:9090')
 ```
 
 #### Authentication proxy
@@ -45,7 +45,7 @@ If an authentication proxy ( e.g. oauth2 ) is used in a layer above the promethe
 
 ```ruby
 # return a client for host https://example.com/api/v1/ using a Bearer token "TopSecret"
-prometheus = Prometheus::ApiClient.client('https://example.com:443', credentials: {token: 'TopSecret'})
+prometheus = Prometheus::ApiClient.client(url: 'https://example.com:443', credentials: {token: 'TopSecret'})
 ```
 
 #### High level calls
@@ -55,8 +55,7 @@ prometheus = Prometheus::ApiClient.client('https://example.com:443', credentials
 # send a query request to server
 prometheus.query(
   :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"
+  :time => "2015-07-01T20:10:30.781Z",
 )
 
 # send a query_range request to server
@@ -70,6 +69,23 @@ prometheus.query_range(
 # send a label request to server
 prometheus.label('__name__')
 ```
+
+#### cAdvisor specialize client
+
+```ruby
+
+# create a client for cAdvisor metrics of a Node instance 'example.com'
+prometheus = Prometheus::ApiClient::Cadvisor::Node.new(
+  instance: 'example.com',
+  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",
+)
+
 ## Tests
 
 Install necessary development gems with `bundle install` and run tests with

data/lib/prometheus/api_client.rb

@@ -3,61 +3,24 @@
 require 'uri'
 require 'openssl'
 require 'prometheus/api_client/client'
+require 'prometheus/api_client/cadvisor'
 
 module Prometheus
-  # Client is a ruby implementation for a Prometheus compatible api_client.
+  # Api Client is a ruby implementation for a Prometheus compatible api_client.
   module ApiClient
-    DEFAULT_ENTRYPOINT = 'http://localhost:9090'.freeze
-    DEFAULT_ARGS = {
-      path: '/api/v1/',
-      credentials: {},
-      options: {
-        open_timeout: 2,
-        timeout: 5,
-      },
-    }.freeze
-
-    # Returns a default client object
-    def self.client(entrypoint = DEFAULT_ENTRYPOINT, args = {})
-      args = DEFAULT_ARGS.merge(args)
-
-      Client.new(
-        prometheus_args(entrypoint, args),
-      )
-    end
-
-    def self.prometheus_proxy(options)
-      options[:http_proxy_uri] if options[:http_proxy_uri]
-    end
-
-    def self.prometheus_verify_ssl(options)
-      return unless options[:verify_ssl]
-
-      {
-        verify: options[:verify_ssl] != OpenSSL::SSL::VERIFY_NONE,
-        cert_store: options[:ssl_cert_store],
-      }
-    end
-
-    def self.prometheus_headers(credentials)
-      return unless credentials[:token]
-
-      {
-        Authorization: 'Bearer ' + credentials[:token].to_s,
-      }
-    end
-
-    def self.prometheus_args(entrypoint, args = {})
-      {
-        url: entrypoint + args[:path],
-        proxy: prometheus_proxy(args[:options]),
-        ssl: prometheus_verify_ssl(args[:options]),
-        headers: prometheus_headers(args[:credentials]),
-        request: {
-          open_timeout: args[:options][:open_timeout],
-          timeout: args[:options][:timeout],
-        },
-      }
+    # Create a Prometheus API client:
+    #
+    # @param [Hash] options
+    # @option options [Hash] :url String 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.
+    def self.client(options = {})
+      Client.new(options)
     end
   end
 end

data/lib/prometheus/api_client/cadvisor.rb

@@ -0,0 +1,92 @@
+# encoding: UTF-8
+
+require 'prometheus/api_client/client'
+
+module Prometheus
+  # Client is a ruby implementation for a Prometheus compatible api_client.
+  module ApiClient
+    # 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 [Hash] :url String 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(instance:, **options)
+          region = options[:region] || 'infra'
+          zone = options[:zone] || 'default'
+
+          @labels = "job=\"kubernetes-cadvisor\",region=\"#{region}\"," \
+            "zone=\"#{zone}\",instance=\"#{instance}\""
+          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 pod cadvisor metrics
+      class Pod < Client
+        def initialize(pod_name:, **options)
+          namespace = options[:namespace] || 'default'
+          region = options[:region] || 'infra'
+          zone = options[:zone] || 'default'
+
+          @labels = "job=\"kubernetes-cadvisor\",region=\"#{region}\"," \
+            "zone=\"#{zone}\",namespace=\"#{namespace}\"," \
+            "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
+        def initialize(container_name:, pod_name:, **options)
+          namespace = args[:namespace] || 'default'
+          region = options[:region] || 'infra'
+          zone = options[:zone] || 'default'
+
+          @labels = "job=\"kubernetes-cadvisor\",region=\"#{region}\"," \
+            "zone=\"#{zone}\",namespace=\"#{namespace}\"," \
+            "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
+end

data/lib/prometheus/api_client/client.rb

@@ -10,26 +10,93 @@ module Prometheus
     class Client
       class RequestError < StandardError; end
 
-      def initialize(args)
-        @client = Faraday.new(args)
+      # Default paramters for creating default client
+      DEFAULT_ARGS = {
+        url: 'http://localhost:9090',
+        path: '/api/v1/',
+        credentials: {},
+        options: {
+          open_timeout: 2,
+          timeout: 5,
+        },
+      }.freeze
+
+      # Create a Prometheus API client:
+      #
+      # @param [Hash] options
+      # @option options [Hash] :url String 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.
+      def initialize(options)
+        options = DEFAULT_ARGS.merge(options)
+
+        @client = Faraday.new(
+          faraday_options(options),
+        )
       end
 
+      # Evaluates an instant query at a single point in time:
+      #
+      # @param [Hash] options
+      # @option options [String] :query Prometheus expression query string.
+      # @option options [String] :time  <rfc3339 | unix_timestamp> Evaluation
+      #   timestamp. Optional.
+      # @option options [String] :timeout Evaluation timeout. Optional.
+      #   Defaults to and is capped by the value of the -query.timeout flag.
+      #
+      # The current server time is used if the time parameter is omitted.
       def query(options)
         run_command('query', options)
       end
 
+      # Evaluates an expression query over a range of time:
+      #
+      # @param [Hash] options
+      # @option options [String] :query Prometheus expression query string.
+      # @option options [String] :start  <rfc3339 | unix_timestamp> Start
+      #   timestamp.
+      # @option options [String] :end  <rfc3339 | unix_timestamp> End timestamp.
+      # @option options [String] :step  <duration> Query resolution step width.
+      # @option options [String] :timeout Evaluation timeout. Optional.
+      #   Defaults to and is capped by the value of the -query.timeout flag.
+      #
+      # The current server time is used if the time parameter is omitted.
       def query_range(options)
         run_command('query_range', options)
       end
 
-      def label(tag, options = {})
-        run_command("label/#{tag}/values", options)
+      # Returns an overview of the current state of the Prometheus target
+      # discovery:
+      #
+      # @param [Hash] options
+      #
+      # No options used.
+      def targets(options = {})
+        run_command('targets', options)
+      end
+
+      # Returns a list of label values for a provided label name:
+      #
+      # @param [String] label Label name
+      # @param [Hash] options
+      #
+      # No options used.
+      def label(label, options = {})
+        run_command("label/#{label}/values", options)
       end
 
+      # Issues a get request to the low level client.
       def get(command, options)
         @client.get(command, options)
       end
 
+      # Issues a get request to the low level client, and evalueate the
+      # response JSON.
       def run_command(command, options)
         response = get(command, options)
 
@@ -37,6 +104,57 @@ module Prometheus
       rescue
         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]
+      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],
+        }
+      end
+
+      # Helper function to evalueate the low level headers option
+      def faraday_headers(credentials)
+        return unless credentials[:token]
+
+        {
+          Authorization: 'Bearer ' + credentials[:token].to_s,
+        }
+      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],
+          },
+        }
+      end
     end
   end
 end

data/lib/prometheus/api_client/version.rb

@@ -2,6 +2,6 @@
 
 module Prometheus
   module ApiClient
-    VERSION = '0.1.1'
+    VERSION = '0.2.10'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prometheus-api-client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.10
 platform: ruby
 authors:
 - Yaacov Zamir
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-06 00:00:00.000000000 Z
+date: 2017-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: quantile
@@ -48,6 +48,7 @@ files:
 - README.md
 - lib/prometheus.rb
 - lib/prometheus/api_client.rb
+- lib/prometheus/api_client/cadvisor.rb
 - lib/prometheus/api_client/client.rb
 - lib/prometheus/api_client/version.rb
 homepage: https://github.com/yaacov/prometheus_api_client_ruby