atsd 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c1e74266e6d628df2501eedbbc39fe0ce37f610
-  data.tar.gz: f896ec4ccd576751340ca6bf6b28a4637aea06b7
+  metadata.gz: a0166a8f99dff59d83cfb254463d9bdbacb48281
+  data.tar.gz: ffd582313131f72cfbdbe783445d2d3dd559f7bc
 SHA512:
-  metadata.gz: b886e56f95a5af7f3020e2bcf4babefffccb776b9e4e64521ed48f6eb7276cf5eb34613f8a985a8bdbb7b23fc5ea7128bc31221cef88aaa17d76ce661c88bc88
-  data.tar.gz: d1548660eda809448fcd76a30c2ece2887dfe2eac3483f70a76dedaeb5c355048e0dc391d4a8cbe699ae259c20e0790e97b9ff59be6694b97dfb9829759cf85f
+  metadata.gz: 7971fd36026b618b11c71648d286fe90b945f66ed50fe86fa7cc22322ebd865dcaebc7067211b0b57a5aedced796908b259a838d040e3aa7b7c20b1924858a53
+  data.tar.gz: 2e23baf470fc966dc4876716dd9cbacdda922cc2ecc3344b0e9d34caec287c3b2240eeebd34cce58b3a941c03c4bc6107f784e3dc282c5dd4af0babdff651d66

data/README.md

@@ -1,10 +1,10 @@
-# Axibase Time-Series Database Client for Ruby
+# Axibase Time Series Database Client for Ruby
 
 The ATSD Client for Ruby enables Ruby developers 
 to easily read and write statistics and metadata 
 from Axibase Time-Series Database.
 
-API documentation: https://axibase.com/atsd/api
+API documentation: https://github.com/axibase/atsd-docs/blob/master/api/README.md
 
 ## Installation
 
@@ -120,8 +120,8 @@ Basic query:
 require 'time'
 series_service = atsd.series_service
 # => #<ATSD::SeriesService:0x007f82a4446c08
-query = series_service.query('sensor-1', 'temperature', Time.parse("2015-11-17T12:00:00Z"), Time.parse("2015-11-17T19:00:00Z"))
-# => {:entity=>"sensor-1", :metric=>"temperature", :start_time=>1447750800000, :end_time=>1447776000000}
+query = series_service.query('sensor-1', 'temperature', "2015-11-17T12:00:00Z", "2015-11-17T19:00:00Z")
+# => {:entity=>"sensor-1", :metric=>"temperature", :start_date=>"2015-11-17T12:00:00Z", :end_date=>"2015-11-17T19:00:00Z"}
 
 query.class
 # => ATSD::SeriesQuery
@@ -169,11 +169,11 @@ Query with Versions:
 ```ruby
 query = atsd.series_service.query("sensor-2", "pressure", Time.parse("2015-11-17T12:00:00Z"), Time.parse("2015-11-17T19:00:00Z"), {:versioned => true})
 query.execute
-template = "%23s,   %13s,   %23s,   %17s,   %17s\n"
-output = sprintf(template, "sample_time", "sample_value", "version_time", "version_source", "version_status")
+template = "%24s,   %13s,   %24s,   %17s,   %17s\n"
+output = sprintf(template, "sample_date", "sample_value", "version_date", "version_source", "version_status")
 query.result.each do |data|
-    samples = data.data.sort_by{|sample| sample["version"]["t"]}
-    samples.each {|sample| output << sprintf(template, Time.at(sample["t"]/1000).strftime("%Y-%m-%dT%H:%M:%SZ"), sample["v"], Time.at(sample["version"]["t"]/1000).strftime("%Y-%m-%dT%H:%M:%SZ"), sample["version"]["source"], sample["version"]["status"])  }
+    samples = data.data.sort_by{|sample| sample["version"]["d"]}
+    samples.each {|sample| output << sprintf(template, sample["d"], sample["v"], sample["version"]["d"], sample["version"]["source"], sample["version"]["status"])  }
 end
 puts output
             sample_time,    sample_value,              version_time,      version_source,      version_status
@@ -205,7 +205,7 @@ Inserting series:
 s = Series.new
 s.entity = 'sensor-1'
 s.metric = 'temperature'
-s.data = [ {t: Time.now.to_i*1000, v: 22} ]
+s.data = [ {d: Time.now.iso8601, v: 22} ]
 atsd.series_service.insert(s)
 ```
 
@@ -215,7 +215,7 @@ Inserting series using Sample class:
 s = Series.new
 s.entity = 'sensor-1'
 s.metric = 'pressure'
-sample = Sample.new :time => Time.parse("2015-11-17T17:00:00Z"), :value => 7, :version => {:status => "normal", :source => "gateway-1"}
+sample = Sample.new :date => "2015-11-17T17:00:00Z", :value => 7, :version => {:status => "normal", :source => "gateway-1"}
 s.data = [ sample ]
 series_service.insert(s)
 ```
@@ -223,8 +223,8 @@ series_service.insert(s)
 Inserting Series with Versions:
 
 ```ruby
-sample_1 = Sample.new :time => Time.parse("2015-11-17T17:00:00Z"), :value => 7, :version => {:status => "normal", :source => "gateway-1"}
-sample_2 = Sample.new :time => Time.parse("2015-11-17T18:00:00Z"), :value => 17, :version => {:status => "error", :source => "gateway-1"}
+sample_1 = Sample.new :date => Time.parse("2015-11-17T17:00:00Z"), :value => 7, :version => {:status => "normal", :source => "gateway-1"}
+sample_2 = Sample.new :date => Time.parse("2015-11-17T18:00:00Z"), :value => 17, :version => {:status => "error", :source => "gateway-1"}
 series = Series.new :entity => "sensor-1", :metric => "pressure", :data => [sample_1, sample_2]
 atsd.series_service.insert(series)
 ```
@@ -257,22 +257,18 @@ series_service.csv_insert('sensor-1', File.read('/path/to/data.csv'), { :user =>
 properties_service = atsd.properties_service
 # => #<ATSD::PropertiesService:0x007f82a456e6f8
 
-property = Property.new
-property.entity = 'sensor-1'
-property.type = 'sensor_type'
-property.tags = {"location":"NUR","site":"building-1"}
-property.keys = {"id": "ch-15"}
+property = Property.new :entity => 'sensor-1', :type => 'sensor_type', :tags => {"location":"NUR","site":"building-1"}, :key => {"id": "ch-15"}
 properties_service.insert(property)
 
-properties_service.query('sensor-1', 'sensor_type').execute
+properties_service.query('sensor-1', 'sensor_type', :start_date => "2015-11-17T17:00:00Z").execute
 # => [{:type=>"sensor_type",
 #  :entity=>"sensor-1",
 #  :tags=>{"location"=>"NUR", "site"=>"building-1"},
-#  :timestamp=>1428304255068,
-#  :keys=>{"id"=>"ch-15"}}]
+#  :d=>"2016-05-30T12:16:31Z",
+#  :key=>{"id"=>"ch-15"}}]
 
 properties_service.delete(property)
-properties_service.query('sensor-1', 'sensor_type').execute
+properties_service.query('sensor-1', 'sensor_type', :start_date => "2015-11-17T17:00:00Z").execute
 # => []
 ```
 
@@ -282,28 +278,21 @@ properties_service.query('sensor-1', 'sensor_type').execute
 alerts_service = atsd.alerts_service
 # => #<ATSD::AlertsService:0x007faf7c0efdc0
 
+alerts_service.query(:entity => "sensor-1", :metrics => ["meminfo.active"], :start_date => "2015-11-17T17:00:00Z").execute
 alerts_service.query.execute
-# => [{:value=>447660.0,
-#     :id=>4,
-#     :text_value=>"447660",
-#     :tags=>{},
-#     :metric=>"meminfo.active",
-#     :entity=>"sensor-1",
-#     :severity=>3,
-#     :rule=>"My rule!",
-#     :repeat_count=>5,
-#     :open_time=>1428330612667,
-#     :open_value=>445144.0,
-#     :acknowledged=>false,
-#     :last_event_time=>1428330687440},
-#    {:value=>447660.0,
-#     :id=>6,
-#     :text_value=>"447660",
-#     :tags=>{},
-#     :metric=>"meminfo.active",
-#     :entity=>"sensor-1",
-#     :severity=>3,
-# ...
+# => [{"entity"=>"sensor-1",
+#  "tags"=>{},
+#  "repeatCount"=>79,
+#  "textValue"=>"21.9",
+#  "metric"=>"meminfo.active",
+#  "severity"=>3,
+#  "rule"=>"memory info",
+#  "openDate"=>"2016-05-30T12:33:07Z",
+#  "lastEventDate"=>"2016-05-30T13:52:11Z",
+#  "acknowledged"=>false,
+#  "openValue"=>100.0,
+#  :v=>21.9,
+#  "id"=>8}]
 ```
 #### Metrics Service
 
@@ -311,7 +300,7 @@ alerts_service.query.execute
 metrics_service = atsd.metrics_service
 # => #<ATSD::MetricsService:0x007fbb548d9548
 
-metrics_service.list
+metrics_service.list(:limit => 10)
 # => [{:name=>"activemq_metrics_count",
 #     :enabled=>true,
 #     :data_type=>"FLOAT",

data/lib/atsd/client.rb

@@ -43,8 +43,8 @@ module ATSD
     # @return [Array<Hash>] time series
     # @raise [APIError]
     def series_query(queries)
-      response = @connection.post 'series', :queries => Utils.ensure_array(queries)
-      response.body['series']
+      response = @connection.post 'series/query', Utils.ensure_array(queries)
+      response.body
     end
 
     # Insert time series
@@ -84,7 +84,7 @@ module ATSD
     # @return [Array<Hash>] array of properties
     # @raise [APIError]
     def properties_query(queries = nil)
-      response = @connection.post 'properties', :queries => Utils.ensure_array(queries)
+      response = @connection.post 'properties/query', Utils.ensure_array(queries)
       response.body
     end
 
@@ -95,7 +95,7 @@ module ATSD
     # @return [Array<Hash>] array of properties
     # @raise [APIError]
     def properties_for_entity_and_type(entity, type)
-      response = @connection.get "properties/#{entity}/types#{type}"
+      response = @connection.get "properties/query/#{entity}/types#{type}"
       response.body
     end
 
@@ -153,7 +153,7 @@ module ATSD
     # @return [Array<Hash>] alerts
     # @raise [APIError]
     def alerts_query(queries = nil)
-      response = @connection.post 'alerts', :queries => Utils.ensure_array(queries)
+      response = @connection.post 'alerts/query', Utils.ensure_array(queries)
       response.body
     end
 
@@ -173,7 +173,7 @@ module ATSD
     # @return [Array<Hash>] history records
     # @raise [APIError]
     def alerts_history_query(queries = nil)
-      response = @connection.post 'alerts/history', :queries => Utils.ensure_array(queries)
+      response = @connection.post 'alerts/history/query', Utils.ensure_array(queries)
       response.body
     end
 

data/lib/atsd/models/base_model.rb

@@ -24,13 +24,13 @@ module ATSD
     # Converts time and value keys as t and v respectively
     # for the rest operates as a superclass method
     def []=(key,value)
-      if key.to_s == 'time'
-        key = :t
+      if key.to_s == 'date'
+        key = :d
         case value
           when Time
-            value = value.to_i * 1_000
+            value = value.iso8601
           else
-            value = value.to_i
+            value = value
         end
       end
       key = :v if key.to_s == 'value'

data/lib/atsd/models/series.rb

@@ -7,24 +7,20 @@ module ATSD
 
   class Sample < BaseModel
 
-    def set_time(time)
-      self["t"] = time
-    end
-
-    def get_time()
-      self.send("t")
+    def set_date(date)
+      self['d'] = date
     end
 
     def get_date()
-      Time.at(self.send("t")/1000)
+      self.send('d')
     end
 
     def set_value(value)
-      self["v"] = value
+      self['v'] = value
     end
 
     def get_value()
-      self.send("v")
+      self.send('v')
     end
 
   end
@@ -32,19 +28,19 @@ module ATSD
   class Version < BaseModel
 
     def set_source(source)
-      self["source"] = source
+      self['source'] = source
     end
 
     def get_source()
-      self.send("source")
+      self.send('source')
     end
 
     def set_status(status)
-      self["status"] = status
+      self['status'] = status
     end
 
     def get_status()
-      self.send("status")
+      self.send('status')
     end
   end
 end

data/lib/atsd/queries/alerts_history_query.rb

@@ -4,17 +4,17 @@ module ATSD
   # Class for building and executing Alerts History Query
   # @see https://axibase.com/atsd/api/#alerts:-history-query
   class AlertsHistoryQuery < BaseQuery
-    TO_MILLISECONDS_LAMBDA = ->(v) do
+    TO_ISO_LAMBDA = ->(v) do
       case v
         when Time
-          v.to_i * 1_000
+          v.iso8601
         else
-          v.to_i
+          v
       end
     end
 
-    coerce_key :end_time, TO_MILLISECONDS_LAMBDA
-    coerce_key :start_time, TO_MILLISECONDS_LAMBDA
+    coerce_key :end_date, TO_ISO_LAMBDA
+    coerce_key :start_date, TO_ISO_LAMBDA
 
     # @return [Array<AlertHistory>]
     def result

data/lib/atsd/queries/base_query.rb

@@ -18,12 +18,12 @@ module ATSD
     #   @param [String] type see {Type} for possible values
     #   @return [self]
 
-    TO_MILLISECONDS_LAMBDA = ->(v) do
+    TO_ISO_LAMBDA = ->(v) do
       case v
         when Time
-          v.to_i * 1_000
+          v.iso8601
         else
-          v.to_i
+          v
       end
     end
 

data/lib/atsd/queries/properties_query.rb

@@ -4,17 +4,17 @@ module ATSD
   # Class for building and executing Properties Query
   # @see https://axibase.com/atsd/api/#properties:-query
   class PropertiesQuery < BaseQuery
-    TO_MILLISECONDS_LAMBDA = ->(v) do
+    TO_ISO_LAMBDA = ->(v) do
       case v
         when Time
-          v.to_i * 1_000
+          v.iso8601
         else
-          v.to_i
+          v
       end
     end
 
-    coerce_key :end_time, TO_MILLISECONDS_LAMBDA
-    coerce_key :start_time, TO_MILLISECONDS_LAMBDA
+    coerce_key :end_date, TO_ISO_LAMBDA
+    coerce_key :start_date, TO_ISO_LAMBDA
 
     # @return [Array<Property>]
     def result

data/lib/atsd/queries/series_query.rb

@@ -5,8 +5,8 @@ module ATSD
   # @see https://axibase.com/atsd/api/#series:-query
   class SeriesQuery < BaseQuery
 
-    coerce_key :end_time, TO_MILLISECONDS_LAMBDA
-    coerce_key :start_time, TO_MILLISECONDS_LAMBDA
+    coerce_key :end_date, TO_ISO_LAMBDA
+    coerce_key :start_date, TO_ISO_LAMBDA
 
     # @return [Array<Series>]
     def result

data/lib/atsd/services/entities_service.rb

@@ -82,13 +82,13 @@ module ATSD
     # Returns an array of property types for the entity.
     #
     # @param [String, Hash, Entity] entity
-    # @param [Integer, Time] start_time
+    # @param [Integer, Time] start_date
     #   Return only property types that have been collected after the specified time.
     # @return [Array<String>]
     # @raise [APIError]
-    def property_types(entity, start_time = nil)
-      start_time = start_time.to_i * 1000 if start_time.is_a? Time
-      params = start_time ? { :start_time => start_time } : {}
+    def property_types(entity, start_date = nil)
+      start_date = start_date.iso8601 if start_date.is_a? Time
+      params = start_date ? { :start_date => start_date } : {}
       @client.entities_property_types(name_for_entity(entity), params)
     end
 

data/lib/atsd/services/series_service.rb

@@ -10,15 +10,15 @@ module ATSD
     #
     # @param [String, Entity] entity
     # @param [String, Metric] metric
-    # @param [Fixnum] start_time
-    # @param [Fixnum] end_time
+    # @param [String] start_date
+    # @param [String] end_date
     # @param [Hash] options other query parameters
     # @return [SeriesQuery]
-    def query(entity, metric, start_time, end_time, options = {})
+    def query(entity, metric, start_date, end_date, options = {})
       query = SeriesQuery.new @client
       entity = entity.name if entity.is_a? Entity
       metric = metric.name if metric.is_a? Metric
-      options.merge! entity: entity, metric: metric, start_time: start_time, end_time: end_time
+      options.merge! entity: entity, metric: metric, start_date: start_date, end_date: end_date
       options.each { |option, value| query[option] = value }
       query
     end

data/lib/atsd/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atsd
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Axibase Corporation
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-22 00:00:00.000000000 Z
+date: 2016-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -256,7 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Axibase Time-Series Database Client for Ruby.