prometheus-alert-buffer-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed1108215a4174f4c8f44c3508af348ac27853d6
+  data.tar.gz: c4a056afaacb9a5815a7a7aef8ab58097580c908
+SHA512:
+  metadata.gz: 0c848caab706f6c103c7a6896b1383f670e5861b1139c59f781d7aaf74fa6090ccd0a0aff73e6f623895e859ac1ba2ecd56b2767810cadb9845e171c2f7ab62c
+  data.tar.gz: 6db2df7aa5389aa3b7765e52addfa4b985bb313692ea92b4b358ae5426b12fec914cb6621bfaeed2a535ccd02f57c1a544fd98bce469985a22426e9fb54a62e8

data/README.md

@@ -0,0 +1,38 @@
+# Prometheus Alert Buffer Ruby Client
+A Ruby library for reading alerts stored on a Prometheus Alert Buffer server.
+
+## Usage
+### Overview
+
+require 'prometheus/alert_buffer_client'
+
+\# return a client for host http://example.com:9099/topics/alerts
+
+prometheus = Prometheus::AlertBufferClient.client(url: 'http://example.com:9099')
+
+### Changing alerts path
+
+\# return a client for host http://example.com:9099/topics/topic1
+
+prometheus = Prometheus::AlertBufferClient.client(url: 'http://example.com:9090', path: '/topics/topic1')
+
+### Authentication proxy
+
+If an authentication proxy ( e.g. oauth2 ) is used in a layer above the prometheus-alert-buffer REST server, this client can use ssl and authentication headers.
+
+\# return a client for host https://example.com/topics/alerts using a Bearer token "TopSecret"
+
+prometheus = Prometheus::AlertBufferClient.client(url: 'https://example.com:443',
+                                          credentials: { token: 'TopSecret' })
+
+### Api calls
+
+#### Reading alerts
+\# get all the alerts from server
+
+alerts = prometheus.get()
+
+#### Reading latest alerts
+\# get all the alerts with generation_id='12497ca8-b597-4590-ac5d-d55af7f3d185' and index >= 34
+
+alerts = prometheus.get(generation_id: '12497ca8-b597-4590-ac5d-d55af7f3d185', from_index: 34)

data/lib/prometheus.rb

@@ -0,0 +1,5 @@
+# encoding: UTF-8
+
+# Prometheus is a generic time-series collection and computation server.
+module Prometheus
+end

data/lib/prometheus/alert_buffer_client.rb

@@ -0,0 +1,17 @@
+# encoding: UTF-8
+
+require 'uri'
+require 'openssl'
+require 'prometheus/alert_buffer_client/client'
+
+module Prometheus
+
+  # Alert Client is a ruby implementation for a Prometheus-alert-buffer client.
+  module AlertBufferClient
+
+    def self.client(options = {})
+      Client.new(options)
+    end
+
+  end
+end

data/lib/prometheus/alert_buffer_client/client.rb

@@ -0,0 +1,121 @@
+# encoding: UTF-8
+
+require 'json'
+require 'faraday'
+
+module Prometheus
+  # Alert Client is a ruby implementation for a Prometheus-alert-buffer client.
+  module AlertBufferClient
+    # Client contains the implementation for a Prometheus-alert-buffer client.
+    class Client
+      class RequestError < StandardError; end
+
+      # Default parameters for creating default client
+      DEFAULT_ARGS = {
+        path: '/topics/alerts',
+        credentials: {},
+        options: {
+          open_timeout: 2,
+          timeout: 5,
+        },
+      }.freeze
+
+
+      # Create a Prometheus Alert client:
+      #
+      # @param [Hash] options
+      # @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.
+      #
+      # A default client is created if options is omitted.
+      def initialize(options = {})
+        options = DEFAULT_ARGS.merge(options)
+
+        @client = Faraday.new(
+          faraday_options(options),
+        )
+      end
+
+
+      # Get alerts:
+      #
+      # @param [Hash] options
+      # @option options [String] :generation_id Database generation Id.
+      # @option options [Integer] :from_index Minimal index of alerts to fetch.
+      #
+      # All alerts will be fetched if options are omitted.
+      def get(options = {})
+        response = @client.get do |req|
+          req.params['generationID'] = options[:generation_id]
+          req.params['fromIndex'] = options[:from_index]
+        end
+
+        JSON.parse(response.body)['messages']
+      end
+
+      # Helper function to evalueate the low level proxy option
+      def faraday_proxy(options)
+        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_ssl(options)
+        return options[:ssl] if options[:ssl]
+
+        ssl = options[:options]
+        return unless ssl[:verify_ssl] || ssl[:ssl_cert_store]
+
+        {
+          verify: ssl[:verify_ssl] != OpenSSL::SSL::VERIFY_NONE,
+          cert_store: ssl[:ssl_cert_store],
+        }
+      end
+
+      # Helper function to evalueate the low level headers option
+      def faraday_headers(options)
+        return options[:headers] if options[:headers]
+
+        headers = options[:credentials]
+        return unless headers && headers[:token]
+
+        {
+          Authorization: "Bearer #{headers[:token].to_s}",
+        }
+      end
+
+      # Helper function to evalueate the low level headers option
+      def faraday_request(options)
+        return options[:request] if options[:request]
+
+        request = options[:options]
+        return unless request[:open_timeout] || request[:timeout]
+
+        {
+          open_timeout: request[:open_timeout],
+          timeout: request[:timeout],
+        }
+      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),
+          ssl: faraday_ssl(options),
+          headers: faraday_headers(options),
+          request: faraday_request(options),
+        }
+      end
+
+    end
+  end
+end

data/lib/prometheus/alert_buffer_client/version.rb

@@ -0,0 +1,7 @@
+# encoding: UTF-8
+
+module Prometheus
+  module AlertBufferClient
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: prometheus-alert-buffer-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zohar Galor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+description: 
+email:
+- zgalor@redhat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/prometheus.rb
+- lib/prometheus/alert_buffer_client.rb
+- lib/prometheus/alert_buffer_client/client.rb
+- lib/prometheus/alert_buffer_client/version.rb
+homepage: https://github.com/openshift/prometheus-alert-buffer-client-ruby
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: A suite of reading alerts stored on a Prometheus Alert Buffer server.
+test_files: []