hawkular-client 0.1.2 → 0.2.0

data/lib/metrics/metrics_client.rb

@@ -0,0 +1,52 @@
+
+require 'hawkular'
+require 'json'
+require 'rest-client'
+require 'English'
+
+require 'metrics/types'
+require 'metrics/tenant_api'
+require 'metrics/metric_api'
+
+# Metrics module provides access to Hawkular Metrics REST API
+# @see http://www.hawkular.org/docs/rest/rest-metrics.html Hawkular Metrics REST API Documentation
+# @example Create Hawkular-Metrics client and start pushing some metric data
+#  # create client instance
+#  client = Hawkular::Metrics::Client::new("http://server","username",
+#                "password",{"tenant" => "your tenant ID"})
+#  # push gauge metric data for metric called "myGauge" (no need to create metric definition
+#  # unless you wish to specify data retention)
+#  client.gauges.push_data("myGauge", {:value => 3.1415925})
+module Hawkular::Metrics
+  class Client < Hawkular::BaseClient
+    # @return [Tenants] access tenants API
+    attr_reader :tenants
+    # @return [Counters] access counters API
+    attr_reader :counters
+    # @return [Gauges] access gauges API
+    attr_reader :gauges
+    # @return [Availability] access counters API
+    attr_reader :avail
+
+    # Construct a new Hawkular Metrics client class.
+    # optional parameters
+    # @param entrypoint [String] Base url of the Hawkular (metrics) server
+    # @param credentials Hash of username, password, token(optional)
+    # @param options [Hash{String=>String}] client options
+    # @example initialize with Hawkular-tenant option
+    #   Hawkular::Metrics::Client::new("http://server",
+    #     {username:"username",password:"password"},
+    #                          {"tenant" => "your tenant ID"})
+    #
+    def initialize(entrypoint = 'http://localhost:8080/hawkular/metrics',
+                   credentials = {},
+                   options = {})
+
+      super(entrypoint, credentials, options)
+      @tenants = Client::Tenants.new self
+      @counters = Client::Counters.new self
+      @gauges = Client::Gauges.new self
+      @avail = Client::Availability.new self
+    end
+  end
+end

data/lib/metrics/tenant_api.rb

@@ -1,5 +1,5 @@
 module Hawkular::Metrics
-  class Client
+  class Client < Hawkular::BaseClient
     # Provides access to tenants API
     class Tenants
       # @param client [Client]

data/lib/metrics/version.rb

@@ -1,5 +1,7 @@
+require 'hakwular'
+
 module Hawkular
   module Metrics
-    VERSION = '0.1.2'
+    VERSION = Hawkular.VERSION
   end
 end

data/lib/version.rb

@@ -0,0 +1,8 @@
+# Module to talk to Hawkular (http://hawkular.org) components.
+# Submodules are provided for individual components
+# @see http://hawkular.org
+# @see https://github.com/hawkular
+module Hawkular
+  # Version of the Hawkular Ruby Gem
+  VERSION = '0.2.0'
+end

data/spec/integration/alerts_spec.rb

@@ -0,0 +1,143 @@
+require "#{File.dirname(__FILE__)}/../vcr/vcr_setup"
+require "#{File.dirname(__FILE__)}/../spec_helper"
+
+module Hawkular::Alerts::RSpec
+  ALERTS_BASE = 'http://localhost:8080/hawkular/alerts'
+  creds = { username: 'jdoe', password: 'password' }
+
+  describe 'Alert/Triggers', :vcr do
+    it 'Should List Triggers' do
+      client = Hawkular::Alerts::AlertsClient.new(ALERTS_BASE, creds)
+
+      triggers = client.list_triggers
+
+      expect(triggers.size).to be(3)
+    end
+
+    it 'Should List Triggers for Tag' do
+      client = Hawkular::Alerts::AlertsClient.new(ALERTS_BASE, creds)
+
+      triggers = client.list_triggers [], ['resourceId|75bfdd05-d03d-481e-bf32-c724c7719d8b~Local']
+
+      expect(triggers.size).to be(7)
+    end
+
+    it 'Should List Triggers for Tags' do
+      client = Hawkular::Alerts::AlertsClient.new(ALERTS_BASE, creds)
+
+      triggers = client.list_triggers [], ['resourceId|75bfdd05-d03d-481e-bf32-c724c7719d8b~Local',
+                                           'app|MyShop']
+
+      expect(triggers.size).to be(7)
+    end
+
+    it 'Should List Triggers for ID' do
+      client = Hawkular::Alerts::AlertsClient.new(ALERTS_BASE, creds)
+
+      triggers = client.list_triggers ['75bfdd05-d03d-481e-bf32-c724c7719d8b~Local_jvm_pheap']
+
+      expect(triggers.size).to be(1)
+    end
+
+    it 'Should get a single metric Trigger' do
+      client = Hawkular::Alerts::AlertsClient.new(ALERTS_BASE, creds)
+
+      trigger = client.get_single_trigger('snert~Local_jvm_nheap')
+
+      expect(trigger).not_to be_nil
+    end
+
+    it 'Should get a single Trigger with conditions' do
+      client = Hawkular::Alerts::AlertsClient.new(ALERTS_BASE, creds)
+
+      trigger = client.get_single_trigger 'snert~Local_jvm_nheap', true
+
+      expect(trigger).not_to be_nil
+      expect(trigger.conditions.size).to be(1)
+      expect(trigger.dampenings.size).to be(1)
+    end
+  end
+
+  describe 'Alert/Alerts', :vcr do
+    it 'Should list alerts' do
+      client = Hawkular::Alerts::AlertsClient.new(ALERTS_BASE, creds)
+
+      alerts = client.list_alerts
+
+      expect(alerts).to_not be_nil
+      expect(alerts.size).to be(2)
+    end
+
+    it 'Should list alerts for trigger' do
+      client = Hawkular::Alerts::AlertsClient.new(ALERTS_BASE, creds)
+
+      alerts = client.get_alerts_for_trigger '75bfdd05-d03d-481e-bf32-c724c7719d8b~Local_jvm_pheap'
+
+      expect(alerts).to_not be_nil
+      expect(alerts.size).to be(1)
+    end
+
+    it 'Should list alerts for unknown trigger' do
+      client = Hawkular::Alerts::AlertsClient.new(ALERTS_BASE, creds)
+
+      alerts = client.get_alerts_for_trigger 'does-not-exist'
+
+      expect(alerts).to_not be_nil
+      expect(alerts.size).to be(0)
+    end
+
+    it 'Should fetch single alert' do
+      client = Hawkular::Alerts::AlertsClient.new(ALERTS_BASE, creds)
+
+      alert = client.get_single_alert(
+        '28026b36-8fe4-4332-84c8-524e173a68bf-snert~Local_jvm_garba-1446977734134')
+
+      expect(alert).to_not be_nil
+      expect(alert.alertId)
+        .to eql('28026b36-8fe4-4332-84c8-524e173a68bf-snert~Local_jvm_garba-1446977734134')
+    end
+
+    it 'Should resolve an alert' do
+      client = Hawkular::Alerts::AlertsClient.new(ALERTS_BASE, creds)
+
+      alert_id = '28026b36-8fe4-4332-84c8-524e173a68bf-snert~Local_jvm_garba-1446977734134'
+      alert = client.get_single_alert alert_id
+
+      expect(alert.status).to eql('OPEN')
+
+      client.resolve_alert(alert_id, 'Heiko', 'Hello Ruby World :-)')
+
+      alert = client.get_single_alert alert_id
+      expect(alert.status).to eql('RESOLVED')
+    end
+
+    # # TODO enable when the semantics on the server side is known
+    #     it 'Should resolve an alert2' do
+    #       client = Hawkular::Alerts::AlertsClient.new(ALERTS_BASE,creds)
+    #
+    #       alert_id = '28026b36-8fe4-4332-84c8-524e173a68bf-snert~Local_jvm_garba-1446977734134'
+    #       client.resolve_alert alert_id
+    #
+    #     end
+
+    it 'Should acknowledge an alert' do
+      client = Hawkular::Alerts::AlertsClient.new(ALERTS_BASE, creds)
+
+      alert_id = '28026b36-8fe4-4332-84c8-524e173a68bf-snert~Local_jvm_garba-1446977734134'
+      client.get_single_alert alert_id
+
+      client.acknowledge_alert(alert_id, 'Heiko', 'Hello Ruby World :-)')
+
+      alert = client.get_single_alert alert_id
+      expect(alert.ackBy).to eql('Heiko')
+    end
+  end
+
+  # TODO: enable when alerts supports it
+  # describe 'Alerts' do
+  #   it 'Should return the version' do
+  #     data = @client.get_version_and_status
+  #     expect(data).not_to be_nil
+  #   end
+  # end
+end

data/spec/integration/inventory_spec.rb

@@ -0,0 +1,191 @@
+require "#{File.dirname(__FILE__)}/../vcr/vcr_setup"
+require "#{File.dirname(__FILE__)}/../spec_helper"
+
+module Hawkular::Inventory::RSpec
+  INVENTORY_BASE = 'http://localhost:8080/hawkular/inventory'
+  describe 'Tenants', :vcr do
+    it 'Should Get Tenant For Explicit Credentials' do
+      creds = { username: 'jdoe', password: 'password' }
+
+      client = Hawkular::Inventory::InventoryClient.new(INVENTORY_BASE, creds)
+
+      tenant = client.get_tenant(creds)
+
+      expect tenant.nil?
+      expect tenant.eql?('28026b36-8fe4-4332-84c8-524e173a68bf')
+    end
+
+    it 'Should Get Tenant For Implicit Credentials' do
+      creds = { username: 'jdoe', password: 'password' }
+
+      client = Hawkular::Inventory::InventoryClient.new(INVENTORY_BASE, creds)
+
+      tenant = client.get_tenant
+
+      expect tenant.nil?
+
+      expect tenant.eql?('28026b36-8fe4-4332-84c8-524e173a68bf')
+    end
+  end
+
+  describe 'Inventory', :vcr do
+    it 'Should list feeds' do
+      creds = { username: 'jdoe', password: 'password' }
+
+      client = Hawkular::Inventory::InventoryClient.new(INVENTORY_BASE, creds)
+      client.impersonate
+
+      feeds = client.list_feeds
+
+      expect(feeds.size).to be(1)
+    end
+
+    it 'Should list types without feed' do
+      creds = { username: 'jdoe', password: 'password' }
+
+      client = Hawkular::Inventory::InventoryClient.new(INVENTORY_BASE, creds)
+      client.impersonate
+
+      types = client.list_resource_types
+
+      expect(types.size).to be(17)
+    end
+
+    it 'Should list types with feed' do
+      creds = { username: 'jdoe', password: 'password' }
+
+      client = Hawkular::Inventory::InventoryClient.new(INVENTORY_BASE, creds)
+      client.impersonate
+
+      types = client.list_resource_types('snert')
+
+      expect(types.size).to be(16)
+    end
+
+    it 'Should list types with bad feed' do
+      creds = { username: 'jdoe', password: 'password' }
+
+      client = Hawkular::Inventory::InventoryClient.new(INVENTORY_BASE, creds)
+      client.impersonate
+
+      type = 'does not exist'
+      types = client.list_resource_types(type)
+      expect(type).to eq('does not exist')
+
+      expect(types.size).to be(0)
+    end
+
+    it 'Should list WildFlys' do
+      creds = { username: 'jdoe', password: 'password' }
+
+      client = Hawkular::Inventory::InventoryClient.new(INVENTORY_BASE, creds)
+      client.impersonate
+
+      resources = client.list_resources_for_type('snert', 'WildFly Server')
+
+      expect(resources.size).to be(1)
+      wf = resources.first
+      expect(wf.properties.size).to be(0)
+    end
+
+    it 'Should list WildFlys with props' do
+      creds = { username: 'jdoe', password: 'password' }
+
+      client = Hawkular::Inventory::InventoryClient.new(INVENTORY_BASE, creds)
+      client.impersonate
+
+      resources = client.list_resources_for_type('snert', 'WildFly Server', true)
+
+      expect(resources.size).to be(1)
+      wf = resources.first
+      expect(wf.properties['Hostname']).to eq('snert')
+    end
+
+    it 'Should List datasources with no props' do
+      creds = { username: 'jdoe', password: 'password' }
+
+      client = Hawkular::Inventory::InventoryClient.new(INVENTORY_BASE, creds)
+      client.impersonate
+
+      resources = client.list_resources_for_type('snert', 'Datasource', true)
+
+      expect(resources.size).to be(2)
+      wf = resources.first
+      expect(wf.properties.size).to be(0) # They have no props
+    end
+
+    it 'Should list URLs' do
+      creds = { username: 'jdoe', password: 'password' }
+
+      client = Hawkular::Inventory::InventoryClient.new(INVENTORY_BASE, creds)
+      client.impersonate
+
+      resources = client.list_resources_for_type(nil, 'URL')
+
+      expect(resources.size).to be(1)
+      resource = resources[0]
+      expect(resource.instance_of? Hawkular::Inventory::Resource).to be_truthy
+      expect(resource.properties.size).to be(5)
+      expect(resource.properties['url']).to eq('http://bsd.de')
+    end
+
+    it 'Should list metrics for WildFlys' do
+      creds = { username: 'jdoe', password: 'password' }
+
+      client = Hawkular::Inventory::InventoryClient.new(INVENTORY_BASE, creds)
+      client.impersonate
+
+      resources = client.list_resources_for_type('snert', 'WildFly Server')
+      expect(resources.size).to be(1)
+
+      wild_fly = resources[0]
+
+      metrics = client.list_metrics_for_resource(wild_fly)
+
+      expect(metrics.size).to be(14)
+    end
+
+    it 'Should list children of WildFly' do
+      creds = { username: 'jdoe', password: 'password' }
+
+      client = Hawkular::Inventory::InventoryClient.new(INVENTORY_BASE, creds)
+      client.impersonate
+
+      resources = client.list_resources_for_type('snert', 'WildFly Server')
+      expect(resources.size).to be(1)
+
+      wild_fly = resources[0]
+
+      metrics = client.list_child_resources(wild_fly)
+
+      expect(metrics.size).to be(21)
+    end
+
+    it 'Should list heap metrics for WildFlys' do
+      creds = { username: 'jdoe', password: 'password' }
+
+      client = Hawkular::Inventory::InventoryClient.new(INVENTORY_BASE, creds)
+      client.impersonate
+
+      resources = client.list_resources_for_type('snert', 'WildFly Server')
+      expect(resources.size).to be(1)
+
+      wild_fly = resources[0]
+
+      metrics = client.list_metrics_for_resource(wild_fly, type: 'GAUGE', match: 'Metrics~Heap')
+      expect(metrics.size).to be(3)
+
+      metrics = client.list_metrics_for_resource(wild_fly, match: 'Metrics~Heap')
+      expect(metrics.size).to be(3)
+
+      metrics = client.list_metrics_for_resource(wild_fly, type: 'GAUGE')
+      expect(metrics.size).to be(10)
+    end
+
+    # TODO: enable when inventory supports it
+    # it 'Should return the version' do
+    #   data = @client.get_version_and_status
+    #   expect(data).not_to be_nil
+    # end
+  end
+end

data/spec/integration/metric_spec.rb

@@ -350,4 +350,37 @@ describe 'Gauge metrics' do
       expect(data[0][1]).to eql(now)
     end
   end
+
+  it 'Should return platform memory def' do
+    tenant_id = '28026b36-8fe4-4332-84c8-524e173a68bf'
+    setup_client tenant: tenant_id
+
+    VCR.use_cassette('Gauge_metrics/Platform mem def') do
+      # The next id is not a real one, but shortened for rubocpo
+      mem_id = 'MI~R~[snert~platform~/OP_SYSTEM=Apple (Capitan) 42/MEMORY=Mem]~MT~Total Memory'
+      data = @client.gauges.get(mem_id)
+
+      expect(data).not_to be_nil
+      expect(data.id).not_to be_nil
+      expect(data.tenant_id).to eq(tenant_id)
+    end
+  end
+
+  it 'Should return platform memory' do
+    setup_client tenant: '28026b36-8fe4-4332-84c8-524e173a68bf'
+
+    VCR.use_cassette('Gauge_metrics/Platform mem') do
+      # The next id is not a real one, but shortened for rubocpo
+      mem_id = 'MI~R~[snert~platform~/OP_SYSTEM=Apple (Capitan) 42/MEMORY=Mem]~MT~Total Memory'
+      data = @client.gauges.get_data(mem_id)
+      expect(data.size).to be 71
+    end
+  end
+
+  it 'Should return the version' do
+    VCR.use_cassette('Metrics/Status') do
+      data = @client.fetch_version_and_status
+      expect(data).not_to be_nil
+    end
+  end
 end