prometheus-api-client 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ddd53e20644407d4d1a2a11b3e3116e967ac30f5
-  data.tar.gz: 0f659ddb1bbfb994550f353913c0dad214f70d6a
+  metadata.gz: 6fa60b4ccdbfed4c2141142a9588169498b2b403
+  data.tar.gz: 9033f3fc05d7beffcb794ddf427fb12b458ce187
 SHA512:
-  metadata.gz: fadfded50f9012c9d8e922765b078ba008c48d9ce6edf6742c4e96b1a39758b76ae1e7e3e2d0df6c7e1608ce78ed0b3d3a73266a2bc3ba39178b30c045fda9e7
-  data.tar.gz: d0680011ec2ca3fecda3e4daeb66fcd2db1bb92310b03c77842845fd482a7c21f6b455b77acb1e14431da10d1c8f392f022e72cc72319b5293cbfb3f2e41c3df
+  metadata.gz: 4bc1d913b47c48321189a7cd8d1d085f9f156d000735665a85aac89f1a26b1acb7b8638fad267bb40a9b671258f34b0f5fc32f1ccf1d72b85b8b94268e264ffb
+  data.tar.gz: 951b1b31db41c3152704eef094545578f0cb714067f4bfcdd8666d1998a5d742600b428e41b6ccc329754b2f3cdc1f46f971679ade1ad994855afae8836ef31f

data/README.md

@@ -7,9 +7,11 @@
 
 A Ruby library for reading Prometheus metrics API.
 
-### Authentication proxy
+## Install
 
-If an authentication proxy ( e.g. oauth2 ) is used in a layer above the prometheus REST server, this client can use ssl and authentication headears.
+```
+gem install prometheus-api-client
+```
 
 ## Usage
 
@@ -18,7 +20,7 @@ If an authentication proxy ( e.g. oauth2 ) is used in a layer above the promethe
 ```ruby
 require 'prometheus/api_client'
 
-# returns a default client
+# return a client for host http://localhost:9090/api/v1/
 prometheus = Prometheus::ApiClient.client
 
 prometheus.get(
@@ -30,6 +32,22 @@ prometheus.get(
 )
 ```
 
+#### Changing server hostname
+
+```ruby
+# return a client for host http://example.com:9090/api/v1/
+prometheus = Prometheus::ApiClient.client('example.com')
+```
+
+#### Authentication proxy
+
+If an authentication proxy ( e.g. oauth2 ) is used in a layer above the prometheus REST server, this client can use ssl and authentication headears.
+
+```ruby
+# return a client for host https://example.com/api/v1/
+prometheus = Prometheus::ApiClient.client('example.com', scheme: 'https', port: 443)
+```
+
 ## Tests
 
 Install necessary development gems with `bundle install` and run tests with

data/lib/prometheus/api_client.rb

@@ -1,46 +1,31 @@
 # encoding: UTF-8
 
 require 'uri'
-require 'faraday'
+require 'openssl'
+require 'prometheus/api_client/client'
 
 module Prometheus
   # Client is a ruby implementation for a Prometheus compatible api_client.
   module ApiClient
-    DEFAULT_HOST = 'localhost'.freeze
-    DEFAULT_SCHEME = 'http'.freeze
-    DEFAULT_PORT = 9090
-    DEFAULT_PATH = '/api/v1/'.freeze
-    DEFAULT_CREDENTIALS = {}.freeze
-    DEFAULT_OPTIONS = {}.freeze
+    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(host = DEFAULT_HOST, args = {})
-      args = {
-        scheme: DEFAULT_SCHEME,
-        port: DEFAULT_PORT,
-        path: DEFAULT_PATH,
-        credentials: DEFAULT_CREDENTIALS,
-        options: DEFAULT_OPTIONS,
-      }.merge(args)
+    def self.client(entrypoint = DEFAULT_ENTRYPOINT, args = {})
+      args = DEFAULT_ARGS.merge(args)
 
-      Faraday.new(
-        prometheus_args(host, args),
+      Client.new(
+        prometheus_args(entrypoint, args),
       )
     end
 
-    def self.prometheus_uri(host, scheme, port, path)
-      builder = {
-        http: URI::HTTP,
-        https: URI::HTTPS,
-      }[scheme.to_sym]
-
-      builder.build(
-        host: host,
-        port: port,
-        path: path,
-      ).to_s
-    end
-
     def self.prometheus_proxy(options)
       options[:http_proxy_uri] if options[:http_proxy_uri]
     end
@@ -62,15 +47,16 @@ module Prometheus
       }
     end
 
-    def self.prometheus_args(host, args = {})
+    def self.prometheus_args(entrypoint, args = {})
       {
-        url: prometheus_uri(
-          host, args[:scheme], args[:port], args[:path]
-        ),
+        url: entrypoint + args[:path],
         proxy: prometheus_proxy(args[:options]),
         ssl: prometheus_verify_ssl(args[:options]),
         headers: prometheus_headers(args[:credentials]),
-        request: { open_timeout: 2, timeout: 5 },
+        request: {
+          open_timeout: args[:options][:open_timeout],
+          timeout: args[:options][:timeout],
+        },
       }
     end
   end

data/lib/prometheus/api_client/client.rb

@@ -0,0 +1,42 @@
+# encoding: UTF-8
+
+require 'json'
+require 'faraday'
+
+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.
+    class Client
+      class RequestError < StandardError; end
+
+      def initialize(args)
+        @client = Faraday.new(args)
+      end
+
+      def query(options)
+        run_command('query', options)
+      end
+
+      def query_range(options)
+        run_command('query_range', options)
+      end
+
+      def label(tag, options)
+        run_command("label/#{tag}/values", options)
+      end
+
+      def get(command, options)
+        @client.get(command, options)
+      end
+
+      def run_command(command, options)
+        response = get(command, options)
+
+        JSON.parse(response.body)['data']
+      rescue
+        raise RequestError, 'Bad response from server'
+      end
+    end
+  end
+end

data/lib/prometheus/api_client/version.rb

@@ -2,6 +2,6 @@
 
 module Prometheus
   module ApiClient
-    VERSION = '0.0.2'
+    VERSION = '0.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prometheus-api-client
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Yaacov Zamir
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-04 00:00:00.000000000 Z
+date: 2017-08-06 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/client.rb
 - lib/prometheus/api_client/version.rb
 homepage: https://github.com/yaacov/prometheus_api_client_ruby
 licenses:
@@ -72,5 +73,5 @@ rubyforge_project:
 rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: A suite of reading metric valuesthat are exposed through an API interface.
+summary: A suite of reading metric values that are exposed through an API interface.
 test_files: []