atsd 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0166a8f99dff59d83cfb254463d9bdbacb48281
-  data.tar.gz: ffd582313131f72cfbdbe783445d2d3dd559f7bc
+  metadata.gz: bb6d450775a1e2535c2784af0377e160899f2bc1
+  data.tar.gz: a5b7413629c45872b82d571ac0c2608aedf0c525
 SHA512:
-  metadata.gz: 7971fd36026b618b11c71648d286fe90b945f66ed50fe86fa7cc22322ebd865dcaebc7067211b0b57a5aedced796908b259a838d040e3aa7b7c20b1924858a53
-  data.tar.gz: 2e23baf470fc966dc4876716dd9cbacdda922cc2ecc3344b0e9d34caec287c3b2240eeebd34cce58b3a941c03c4bc6107f784e3dc282c5dd4af0babdff651d66
+  metadata.gz: 634955edbc7dd7e51050591afac40796d24603be5a41aed533686e605ce466b7294dbfaef955d1e4e38080837e942ea073788befa777be88a3be98c7a57996d9
+  data.tar.gz: 4d0b69e1b4961a08cb69004797d6828d4819e2473c65ddaaeba6095d4c6a0698b3105d48e163bb99f70020a088ac479337ed4f2874638ea8d501698fcbf39fda

data/README.md

@@ -2,7 +2,7 @@
 
 The ATSD Client for Ruby enables Ruby developers 
 to easily read and write statistics and metadata 
-from Axibase Time-Series Database.
+from Axibase Time Series Database.
 
 API documentation: https://github.com/axibase/atsd-docs/blob/master/api/README.md
 
@@ -251,6 +251,21 @@ Inserting CSV data from file:
 series_service.csv_insert('sensor-1', File.read('/path/to/data.csv'), { :user => 'beta' })
 ```
 
+Retrieving series values CSV and JSON format:
+
+```ruby
+series_service.url_query('json','nurswgvml007','cpu_busy', :startDate => 'previous_minute')
+# => {"series"=>
+#  [{"entity"=>"nurswgvml007",
+#    "metric"=>"cpu_busy",
+#    "tags"=>{},
+#    "type"=>"HISTORY",
+#    "aggregate"=>{"type"=>"DETAIL"},
+#    "data"=>[{"t"=>1464688814000, "v"=>3.03}, {"t"=>1464688830000, "v"=>5}, {"t"=>1464688846000, "v"=>9}, {"t"=>1464688862000, "v"=>4.04}, {"t"=>1464688878000, "v"=>5.05}]}]}
+series_service.url_query('csv','nurswgvml007','cpu_busy', :startDate => 'previous_minute')
+=> "time,entity,metric,value\r\n1464688862000,nurswgvml007,cpu_busy,4.04\r\n1464688878000,nurswgvml007,cpu_busy,5.05\r\n1464688894000,nurswgvml007,cpu_busy,10.2\r\n1464688910000,nurswgvml007,cpu_busy,45.95\r\n1464688926000,nurswgvml007,cpu_busy,21.36\r\n1464688942000,nurswgvml007,cpu_busy,4.04\r\n"
+```
+
 #### Properties Service
 
 ```ruby
@@ -268,8 +283,22 @@ properties_service.query('sensor-1', 'sensor_type', :start_date => "2015-11-17T1
 #  :key=>{"id"=>"ch-15"}}]
 
 properties_service.delete(property)
-properties_service.query('sensor-1', 'sensor_type', :start_date => "2015-11-17T17:00:00Z").execute
+properties_service.query('sensor-1', 'sensor_type', :start_date => '2015-11-17T17:00:00Z').execute
 # => []
+
+properties_service.type_query('sensor-1')
+# => ["com.axibase.config",
+# "configuration",
+# "cpu",
+# "disk",
+# "sw.vmw.vm",
+# "system",
+
+properties_service.url_query('nurswgvml007','network')
+# => [{"type"=>"network", "entity"=>"nurswgvml007", "key"=>{"id"=>"eth1"}, "tags"=>{"network_i/o.read-kb/s"=>"261.9", "network_i/o.write-kb/s"=>"209.9", "network_packets.read/s"=>"354.4", "network_packets.write/s"=>"339.4"}, "timestamp"=>1464680627000},
+# {"type"=>"network", "entity"=>"nurswgvml007", "key"=>{"id"=>"lo"}, "tags"=>{"network_i/o.read-kb/s"=>"2.7", "network_i/o.write-kb/s"=>"2.7", "network_packets.read/s"=>"6.7", "network_packets.write/s"=>"6.7"}, "timestamp"=>1464680627000}]
+
+
 ```
 
 #### Alerts Service

data/atsd.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Axibase Corporation']
   spec.email         = ['atsd-api@axibase.com']
 
-  spec.summary       = %q{Axibase Time-Series Database Client for Ruby.}
-  spec.description   = %q{Axibase Time-Series Database Client for Ruby is an easy-to-use client for interfacing with ATSD metadata and data REST API services.}
+  spec.summary       = %q{Axibase Time Series Database Client for Ruby.}
+  spec.description   = %q{Axibase Time Series Database Client for Ruby is an easy-to-use client for interfacing with ATSD metadata and data REST API services.}
   spec.homepage      = 'https://github.com/axibase/atsd-api-ruby/'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

data/lib/atsd/client.rb

@@ -3,7 +3,7 @@ require 'active_support/core_ext/hash/keys'
 
 module ATSD
 
-  # HTTP(S) Client for Axibase Time-Series Database. Implements all REST methods
+  # HTTP(S) Client for Axibase Time Series Database. Implements all REST methods
   # of the API in a straightforward manner.
   class Client
 
@@ -47,6 +47,21 @@ module ATSD
       response.body
     end
 
+    # Retrieve series values for the specified entity, metric, and optional series tags in CSV and JSON format
+    #
+    # @param [String] format
+    # @param [String] entity
+    # @param [String] metric
+    # @param [Hash] parameters other query parameters
+    # @return [Array<Hash>] time series
+    # @raise [APIError]
+    def series_url_query(format, entity, metric, parameters)
+      url = "series/#{format}/#{entity}/#{metric}?"
+      parameters.each { |k, v| url << "&#{k}=#{v}" }
+      response = @connection.get url
+      response.body
+    end
+
     # Insert time series
     #
     # @param [Hash, Array<Hash>] series series or array of series
@@ -95,37 +110,27 @@ module ATSD
     # @return [Array<Hash>] array of properties
     # @raise [APIError]
     def properties_for_entity_and_type(entity, type)
-      response = @connection.get "properties/query/#{entity}/types#{type}"
+      response = @connection.get "properties/#{entity}/types/#{type}"
       response.body
     end
 
-    # Insert properties
+    # Returns array of property types for the entity.
     #
-    # @param [Hash, Array<Hash>] properties property or array of properties
-    # @return true
+    # @param [String] type
+    # @return [Array<Hash>] array of properties
     # @raise [APIError]
-    def properties_insert(properties)
-      @connection.post 'properties/insert', Utils.ensure_array(properties)
-      true
+    def properties_for_entity(entity)
+      response = @connection.get "properties/#{entity}/types"
+      response.body
     end
 
-    # Insert keys and delete keys by id or by partial key match in one request.
+    # Insert properties
     #
-    # @param [Hash, Array<Hash>] insert properties to insert
-    # @param [Hash, Array<Hash>] delete delete an array of properties for entity,
-    #   type, and optionally for specified keys
-    # @param [Hash, Array<Hash>] delete_matchers delete rows that partially match the specified key.
-    #   'createdBeforeTime’ specifies an optional time condition. The server should delete all keys
-    #   that have been created before the specified time. 'createdBeforeTime’ is specified in unix
-    #   milliseconds.
+    # @param [Hash, Array<Hash>] properties property or array of properties
     # @return true
     # @raise [APIError]
-    def properties_batch(insert, delete, delete_matchers)
-      @connection.patch 'properties', [
-          { :action => 'insert', :properties => Utils.ensure_array(insert) },
-          { :action => 'delete', :properties => Utils.ensure_array(delete) },
-          { :action => 'delete-match', :matchers => Utils.ensure_array(delete_matchers) }
-      ].select { |action| (action[:properties] || action[:matchers]).count > 0 }
+    def properties_insert(properties)
+      @connection.post 'properties/insert', Utils.ensure_array(properties)
       true
     end
 
@@ -135,16 +140,7 @@ module ATSD
     # @return true
     # @raise [APIError]
     def properties_delete(properties)
-      properties_batch [], properties, []
-    end
-
-    # Delete rows that partially match the specified key
-    #
-    # @param [Hash, Array<Hash>] matchers
-    # @return true
-    # @raise [APIError]
-    def properties_delete_match(matchers)
-      properties_batch [], [], matchers
+      @connection.post 'properties/delete', Utils.ensure_array(properties)
     end
 
     # Query alerts
@@ -157,13 +153,23 @@ module ATSD
       response.body
     end
 
-    # (De-)acknowledge and delete alerts
+    # (De-)acknowledge alerts
     #
     # @param [Hash, Array<Hash>] actions action or array of actions
     # @return [true]
     # @raise [APIError]
     def alerts_update(actions)
-      @connection.patch 'alerts', Utils.ensure_array(actions)
+      @connection.post 'alerts/update', Utils.ensure_array(actions)
+      true
+    end
+
+    # Delete alerts
+    #
+    # @param [Hash, Array<Hash>] actions action or array of actions
+    # @return [true]
+    # @raise [APIError]
+    def alerts_delete(actions)
+      @connection.post 'alerts/delete', Utils.ensure_array(actions)
       true
     end
 

data/lib/atsd/services/alerts_service.rb

@@ -16,24 +16,6 @@ module ATSD
       query
     end
 
-    # Acknowledge alerts
-    #
-    # @param [Array<Hash, Alert, Integer>, Hash, Alert, Integer] alerts
-    # @return [self]
-    # @raise [APIError]
-    def acknowledge(alerts)
-      alerts_acknowledge alerts, true
-    end
-
-    # De-acknowledge alerts
-    #
-    # @param [Array<Hash, Alert, Integer>, Hash, Alert, Integer] alerts
-    # @return [self]
-    # @raise [APIError]
-    def de_acknowledge(alerts)
-      alerts_acknowledge alerts, false
-    end
-
     # Delete alerts
     #
     # @param [Array<Hash, Alert>, Hash, Alert] alerts
@@ -44,8 +26,7 @@ module ATSD
         { :id => id_for_alert(alert) }
       end
       return if alerts.count == 0
-      @client.alerts_update :action => 'delete',
-                            :alerts => alerts
+      @client.alerts_delete alerts
     end
 
     # Create query builder for alert history.
@@ -60,18 +41,6 @@ module ATSD
 
     private
 
-    def alerts_acknowledge(alerts, acknowledge)
-      alerts = Utils.ensure_array(alerts).map do |alert|
-        alert[:acknowledged] = acknowledge if alert.is_a? Hash
-        { :id => id_for_alert(alert) }
-      end
-      return if alerts.count == 0
-      @client.alerts_update :action => 'update',
-                            :fields => {:acknowledge => acknowledge},
-                            :alerts => alerts
-      self
-    end
-
     def id_for_alert(alert)
       case alert
         when Integer

data/lib/atsd/services/properties_service.rb

@@ -33,6 +33,25 @@ module ATSD
       self
     end
 
+    # Returns an array of property types for the entity.
+    #
+    # @param [String] entity
+    # @return [self]
+    # @raise [APIError]
+    def type_query(entity)
+      @client.properties_for_entity(entity)
+    end
+
+    # Retrieve property records for the specified entity and type.
+    #
+    # @param [String] entity
+    # @param [String] type
+    # @return [self]
+    # @raise [APIError]
+    def url_query(entity, type)
+      @client.properties_for_entity_and_type(entity,type)
+    end
+
     # Delete properties.
     #
     # @param [Array<Property, Hash>, Property, Hash] properties
@@ -46,18 +65,5 @@ module ATSD
       @client.properties_delete(properties)
       self
     end
-
-    # Delete rows that partially match the specified key
-    #
-    # @param [Hash, Array<Hash>] matchers
-    # @return [self]
-    # @raise [APIError]
-    def delete_match(matchers)
-      matchers = Utils.ensure_array(matchers).map do |m|
-        m.camelize_keys
-      end
-      @client.properties_delete_match matchers
-      self
-    end
   end
 end

data/lib/atsd/services/series_service.rb

@@ -23,6 +23,17 @@ module ATSD
       query
     end
 
+    # Retrieve series values for the specified entity, metric, and optional series tags in CSV and JSON format.
+    #
+    # @param [String] format. Supported formats are csv and json
+    # @param [String] entity
+    # @param [String] metric
+    # @param [Hash] parameters other query parameters
+    # @return [Array<Hash>] time series
+    def url_query(format, entity, metric, parameters={})
+      @client.series_url_query(format, entity, metric, parameters)
+    end
+
     # Insert time series.
     #
     # @param [Array<Series, Hash>, Series, Hash] series
@@ -59,9 +70,9 @@ module ATSD
     # @param [String] payload Body - ready to be parsed by ATSD server
     # @return [Faraday::Response]
     # @raise [APIError]
-    def self.post_payload(config,payload)
+    def self.post_payload(config, payload)
       url = config[:url]
-      login, password = config[:login],config[:password]
+      login, password = config[:login], config[:password]
 
       @connection = Faraday.new url do |builder|
         builder.headers['User-Agent'] = "ATSD Ruby Client v#{VERSION}"

data/lib/atsd/version.rb

@@ -1,3 +1,3 @@
 module ATSD
-  VERSION = '1.0.6'
+  VERSION = '1.0.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atsd
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors:
 - Axibase Corporation
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-30 00:00:00.000000000 Z
+date: 2016-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -192,7 +192,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
-description: Axibase Time-Series Database Client for Ruby is an easy-to-use client
+description: Axibase Time Series Database Client for Ruby is an easy-to-use client
   for interfacing with ATSD metadata and data REST API services.
 email:
 - atsd-api@axibase.com
@@ -259,6 +259,6 @@ rubyforge_project:
 rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
-summary: Axibase Time-Series Database Client for Ruby.
+summary: Axibase Time Series Database Client for Ruby.
 test_files: []
 has_rdoc: