hawkular-client 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9dff0c0c4a4cf26161263ef21f06e0962f94fbf0
-  data.tar.gz: 665dd8784d3495ec6da84849b702ef105498ae59
+  metadata.gz: cc8f82c57d113d57a96488d3d5537e7e20449435
+  data.tar.gz: 365a613e0f23108b62d87fbb1bf78cc0ac7db08a
 SHA512:
-  metadata.gz: caa40d7fc69a01af67584e1a1f2c821043a54955c647746d176ffba1c0bf3600690fb7667b11632c5a915ac6e3b761efa8e3c47ecf35538a62c5178e60a1b43a
-  data.tar.gz: 2a236c3bc8117a808aa91948378f33f6fc86afb10ce889eade4b9f11ac26ed89fe1d7dc46f3115fe12f4787045faf78fdd69cf58d56cc54740b16908aa1c874f
+  metadata.gz: e072263ba50864dc2c3e7a5bdcd3e4bb4975f2dde4157fa31ddcb2498d5889ed83473c76186ba20b47cb80730e9d4f803ec1f2374b82d9ca9c49a16feb299f7a
+  data.tar.gz: acd1aef7ed3c8a2282a355efd8d9e1a06b4968c5a5e113e388dadd0d8bc5a5d24e309745beaf0078d4d0db121aeaf7b9dbd8ecb3ccb622c4d15da40bfd170fc2

data/.travis.yml

@@ -1,6 +1,23 @@
+sudo: required
+
 language: ruby
 rvm:
-  - 2.0
-  - 2.1
   - 2.2
   - 2.3.0
+env:
+  global:
+    - ADMIN_TOKEN=4f4a1434-8cb3-11e6-ae22-56b6b6499611
+  matrix:
+    - RUN_ON_LIVE_SERVER=1 \
+      VCR_UPDATE=1 \
+      SKIP_SSL_WITHOUT_CERTIFICATE_TEST=1 \
+      SKIP_SECURE_CONTEXT=1 \
+      SKIP_V8_METRICS=1 \
+    - RUN_ON_LIVE_SERVER=0
+services:
+  - docker
+before_install:
+  - (test $RUN_ON_LIVE_SERVER = 1 && docker-compose up -d && ./.travis/wait_for_services.rb) || echo "Skipping live server"
+# Lets wait a bit for the agent to load everything it needs.
+before_script:
+  - (test $RUN_ON_LIVE_SERVER = 1 && sleep 20s) || true

data/.travis/wait_for_services.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+require 'net/http'
+
+uris = [
+  'http://localhost:8080/hawkular/status',
+  'http://localhost:8080/hawkular/metrics/status',
+  'http://localhost:8080/hawkular/alerts/status',
+  'http://localhost:8080/hawkular/inventory/status'
+]
+
+uris.each do |uri_string|
+  loop do
+    uri = URI(uri_string)
+    begin
+      response = Net::HTTP.get_response(uri)
+      break if response.code == '200'
+      puts "Waiting for: #{uri_string}"
+    rescue
+      puts 'Waiting for Hawkular-Services to accept connections'
+    end
+    sleep 5
+  end
+end

data/CHANGES.rdoc

@@ -3,6 +3,17 @@
 This document describes the relevant changes between releases of the
 _hawkular-client_ project.
 
+=== V 2.8.0
+
+* Allow to list tags in Hawkular-Metrics
+* Adding support for Hawkular-Admin-Token via admin_token
+* Use the new "ackBy" mechanism in Hawkular Alerts. The Ruby-client API stayed the same.
+* Support for string metrics
+* Exposes metric-id property if it exists and follow internal renaming
+* Addition of 'delete_event' on the client.
+
+Full list of changes can be found at https://github.com/hawkular/hawkular-client-ruby/milestone/13?closed=1
+
 === V 2.7.0
 
 * Support for SSL connections

data/docker-compose.yml

@@ -0,0 +1,15 @@
+hawkular:
+  image: "pilhuhn/hawkular-services:latest"
+  ports:
+    - "8080:8080"
+    - "8443:8443"
+    - "9990:9990"
+  links:
+    - myCassandra
+  environment:
+    - CASSANDRA_NODES=myCassandra
+    - ADMIN_TOKEN
+myCassandra:
+  image: cassandra:3.7
+  environment:
+    - CASSANDRA_START_RPC=true

data/lib/hawkular/alerts/alerts_api.rb

@@ -318,6 +318,10 @@ module Hawkular::Alerts
 
       http_post('/events', event)
     end
+
+    def delete_event(id)
+      http_delete "/events/#{id}"
+    end
   end
 
   # Representation of one Trigger
@@ -519,9 +523,29 @@ module Hawkular::Alerts
   # server and not 'rubyfied'. So 'alertId' and not 'alert_id'
   # Check http://www.hawkular.org/docs/rest/rest-alerts.html#Alert for details
   class Alert < OpenStruct
+    attr_accessor :lifecycle
+
     def initialize(alert_hash)
       super(alert_hash)
+      @lifecycle = alert_hash['lifecycle']
+    end
+
+    def ack_by
+      status_by('ACKNOWLEDGED')
     end
+
+    def resolved_by
+      status_by('RESOLVED')
+    end
+
+    def status_by(status)
+      a = @lifecycle.nil? ? [] : @lifecycle.select { |l| l['status'].eql? status }
+      a.empty? ? nil : a.last['user']
+    end
+
+    # for some API back compatibility
+    alias_method :ackBy, :ack_by
+    alias_method :resolvedBy, :resolved_by
   end
 
   # Representation of one event.

data/lib/hawkular/base_client.rb

@@ -25,6 +25,7 @@ module Hawkular
       }.merge(credentials)
       @options = {
         tenant: nil,
+        admin_token: nil,
         ssl_ca_file: nil,
         verify_ssl: OpenSSL::SSL::VERIFY_PEER,
         ssl_client_cert: nil,
@@ -174,6 +175,12 @@ module Hawkular
     class HawkularConnectionException < HawkularException
     end
 
+    def admin_header
+      headers = {}
+      headers[:'Hawkular-Admin-Token'] = @options[:admin_token] unless @options[:admin_token].nil?
+      headers
+    end
+
     private
 
     def token_header

data/lib/hawkular/inventory/entities.rb

@@ -102,6 +102,8 @@ module Hawkular::Inventory
     include MetricFields
 
     attr_reader :type_id
+    # @return [String] metric id used in Hawkular Metrics
+    attr_reader :hawkular_metric_id
 
     def initialize(metric_hash)
       super(metric_hash)
@@ -110,6 +112,7 @@ module Hawkular::Inventory
       @type_id = metric_hash['type']['id']
       @unit = metric_hash['type']['unit']
       @collection_interval = metric_hash['type']['collectionInterval']
+      @hawkular_metric_id = @properties.key?('hawkular-metric-id') ? @properties['hawkular-metric-id'] : @id
     end
   end
 

data/lib/hawkular/metrics/metric_api.rb

@@ -30,11 +30,12 @@ module Hawkular::Metrics
     # @example push gauge and availability datapoints
     #    client.push_data(gauges: [{:id => "gauge1", :data => [{:value => 1}, {:value => 2}]}],
     #                           availabilities: [{:id => "avail1", :data => [{:value => "up"}]}])
-    def push_data(gauges: [], counters: [], availabilities: [])
+    def push_data(gauges: [], counters: [], availabilities: [], strings: [])
       gauges.each { |g| default_timestamp g[:data] }
       counters.each { |g| default_timestamp g[:data] }
       availabilities.each { |g| default_timestamp g[:data] }
-      data = { gauges: gauges, counters: counters, availabilities: availabilities }
+      strings.each { |g| default_timestamp g[:data] }
+      data = { gauges: gauges, counters: counters, availabilities: availabilities, strings: strings }
       path = '/metrics/'
       @legacy_api ? path << 'data' : path << 'raw'
       http_post(path, data)
@@ -68,6 +69,18 @@ module Hawkular::Metrics
       http_post(path, data)
     end
 
+    # Fetch all tags for metrics definitions
+    # @return [Hash{String=>String}]
+    def tags
+      tags = []
+      http_get('/metrics/').map do |g|
+        g['tags'].map do |k, v|
+          tags << { k => v }
+        end unless g['tags'].nil?
+      end
+      tags.uniq!
+    end
+
     # Base class for accessing metric definition and data of all
     # types (counters, gauges, availabilities).
     class Metrics
@@ -249,7 +262,7 @@ module Hawkular::Metrics
       # @return [Array[Hash]] rate points
       def get_rate(id, starts: nil, ends: nil, bucket_duration: nil)
         path = "/#{@resource}/#{ERB::Util.url_encode(id)}/rate"
-        path << '/stats' unless bucket_duration.nil? && @legacy_api
+        path << '/stats' unless bucket_duration.nil? || @legacy_api
         params = { start: starts, end: ends, bucketDuration: bucket_duration }
         resp = @client.http_get(path + '?' + encode_params(params))
         # API returns no content (empty Hash) instead of empty array
@@ -257,6 +270,28 @@ module Hawkular::Metrics
       end
     end
 
+    # Class that interacts with "string" metric types
+    class Strings < Metrics
+      # @param client [Client]
+      def initialize(client)
+        super(client, 'string', 'strings')
+      end
+
+      # Retrieve metric datapoints
+      # @param id [String] metric definition id
+      # @param starts [Integer] optional timestamp (default now - 8h)
+      # @param ends [Integer] optional timestamp (default now)
+      # @param distinct [String] optional set to true to return only distinct, contiguous values
+      # @param limit [Integer] optional limit the number of data points returned
+      # @param order [String] optional Data point sort order, based on timestamp (ASC, DESC)
+      # @return [Array[Hash]] datapoints
+      # @see #push_data #push_data for datapoint detail
+      def get_data(id, starts: nil, ends: nil, distinct: nil, limit: nil, order: nil)
+        params = { start: starts, end: ends, distinct: distinct, limit: limit, order: order }
+        get_data_helper(id, params)
+      end
+    end
+
     # Class that interacts with "availability" metric types
     class Availability < Metrics
       # @param client [Client]

data/lib/hawkular/metrics/metrics_client.rb

@@ -25,6 +25,8 @@ module Hawkular::Metrics
     attr_reader :counters
     # @return [Gauges] access gauges API
     attr_reader :gauges
+    # @return [Strings] access strings API
+    attr_reader :strings
     # @return [Availability] access counters API
     attr_reader :avail
 
@@ -61,6 +63,7 @@ module Hawkular::Metrics
       @counters = Client::Counters.new self
       @gauges = Client::Gauges.new self
       @avail = Client::Availability.new self
+      @strings = Client::Strings.new self
     end
   end
 end

data/lib/hawkular/metrics/tenant_api.rb

@@ -11,13 +11,13 @@ module Hawkular::Metrics
       # Create new tenant
       # @param id [String] tenant ID/Name
       def create(id)
-        @client.http_post("/#{@resource}", id: id)
+        @client.http_post("/#{@resource}", { id: id }, @client.admin_header)
       end
 
       # Query existing tenants
       # @return [Array[Tenant]]
       def query
-        @client.http_get("/#{@resource}").map do |t|
+        @client.http_get("/#{@resource}", @client.admin_header).map do |t|
           Hawkular::Metrics::Tenant.new(t)
         end
       end

data/lib/hawkular/version.rb

@@ -4,5 +4,5 @@
 # @see https://github.com/hawkular
 module Hawkular
   # Version of the Hawkular Ruby Gem
-  VERSION = '2.7.0'.freeze
+  VERSION = '2.8.0'.freeze
 end

data/spec/integration/alert-resources/alerts-test-data.json

@@ -0,0 +1,40 @@
+{
+  "triggers":[
+    {
+      "trigger": {
+        "id": "hello-world-trigger",
+        "name": "Hello World Trigger",
+        "description": "A mandatory Hello World Trigger",
+        "severity": "HIGH",
+        "enabled": true
+      },
+      "conditions":[
+        {
+          "triggerMode": "FIRING",
+          "type": "threshold",
+          "dataId": "data-x",
+          "operator": "LT",
+          "threshold": 5
+        }
+      ]
+    },
+    {
+      "trigger": {
+        "id": "a-trigger",
+        "name": "A trigger name",
+        "description": "Just a trigger",
+        "severity": "HIGH",
+        "enabled": true
+      },
+      "conditions":[
+        {
+          "triggerMode": "FIRING",
+          "type": "threshold",
+          "dataId": "data-x",
+          "operator": "LT",
+          "threshold": 5
+        }
+      ]
+    }
+  ]
+}

data/spec/integration/alert-resources/events-test-data.json

@@ -0,0 +1,78 @@
+{
+  "events": [
+    {
+      "id": "my-event-01",
+      "category": "general-category",
+      "text": "some text for this event",
+      "extras": {
+        "ctime": 2000
+      }
+    },
+    {
+      "id": "my-event-02",
+      "category": "my-category-01",
+      "text": "some text for this event",
+      "extras": {}
+    },
+    {
+      "id": "my-event-03",
+      "category": "my-category-01",
+      "text": "some text for this event",
+      "extras": {}
+    },
+    {
+      "id": "my-event-04",
+      "category": "general-category",
+      "text": "some text for this event",
+      "extras": {}
+    },
+    {
+      "id": "my-event-05",
+      "category": "my-category-02",
+      "text": "some text for this event",
+      "extras": {}
+    },
+    {
+      "id": "my-event-06",
+      "category": "general-category",
+      "text": "some text for this event",
+      "extras": {}
+    },
+    {
+      "id": "my-event-07",
+      "category": "my-category-01",
+      "text": "some text for this event",
+      "extras": {}
+    },
+    {
+      "id": "my-event-08",
+      "category": "general-category",
+      "text": "some text for this event",
+      "extras": {}
+    },
+    {
+      "id": "my-event-09",
+      "category": "general-category",
+      "text": "some text for this event",
+      "extras": {}
+    },
+    {
+      "id": "my-event-10",
+      "category": "general-category",
+      "text": "some text for this event",
+      "extras": {}
+    },
+    {
+      "id": "my-event-11",
+      "category": "general-category",
+      "text": "some text for this event",
+      "extras": {}
+    },
+    {
+      "id": "my-event-12",
+      "category": "general-category",
+      "text": "some text for this event",
+      "extras": {}
+    }
+  ]
+}

data/spec/integration/alert-resources/triggers-test-data.json

@@ -0,0 +1,66 @@
+{
+  "triggers":[
+    {
+      "trigger": {
+        "id": "my-trigger-01",
+        "tags": {
+          "resourceId": "my-resource01",
+          "app": "MyShop"
+        }
+      },
+      "conditions":[
+        {
+          "triggerMode": "FIRING",
+          "type": "threshold",
+          "dataId": "data-x",
+          "operator": "LT",
+          "threshold": 5
+        }
+        ],
+      "dampenings":[
+        {
+          "dampeningId": "my-trigger-01-my-dampening-id"
+        }
+      ]
+    },
+    {
+      "trigger": {
+        "id": "my-trigger-02",
+        "tags": {
+          "resourceId": "my-resource01"
+        }
+      }
+    },
+    {
+      "trigger": {
+        "id": "my-trigger-03",
+        "tags": {
+          "app": "MyShop"
+        }
+      }
+    },
+    {
+      "trigger": {
+        "id": "my-trigger-04",
+        "tags": {
+          "resourceId": "my-resource01",
+          "app": "MyShop"
+        }
+      }
+    },
+    {
+      "trigger": {
+        "id": "my-trigger-05"
+      }
+    },
+    {
+      "trigger": {
+        "id": "my-trigger-06",
+        "tags": {
+          "resourceId": "my-resource01",
+          "app": "MyShop"
+        }
+      }
+    }
+  ]
+}