atsd 1.0.1

data/lib/atsd/services/alerts_service.rb

@@ -0,0 +1,88 @@
+require 'atsd/services/base_service'
+require 'atsd/models/alert'
+require 'atsd/models/alert_history'
+require 'atsd/queries/alerts_query'
+require 'atsd/queries/alerts_history_query'
+
+module ATSD
+  class AlertsService < BaseService
+    # Create query builder for alerts.
+    #
+    # @param [Hash] options query parameters
+    # @return [AlertsQuery]
+    def query(options = {})
+      query = AlertsQuery.new @client
+      options.each { |option, value| query[option] = value }
+      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
+    # @return [self]
+    # @raise [APIError]
+    def delete(alerts)
+      alerts = Utils.ensure_array(alerts).map do |alert|
+        { :id => id_for_alert(alert) }
+      end
+      return if alerts.count == 0
+      @client.alerts_update :action => 'delete',
+                            :alerts => alerts
+    end
+
+    # Create query builder for alert history.
+    #
+    # @param [Hash] options query parameters
+    # @return [AlertsHistoryQuery]
+    def history_query(options = {})
+      query = AlertsHistoryQuery.new @client
+      options.each { |option, value| query[option] = value }
+      query
+    end
+
+    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
+          alert
+        when Alert
+          alert.id
+        when Hash
+          alert[:id] || alert['id']
+        else
+          alert.id
+      end
+    end
+  end
+end

data/lib/atsd/services/base_service.rb

@@ -0,0 +1,15 @@
+module ATSD
+  # Base class for all services
+  # @abstract
+  class BaseService
+
+    # @param [Client] client ATSD client
+    def initialize(client)
+      @client = client
+    end
+
+    protected
+
+    attr_reader :client
+  end
+end

data/lib/atsd/services/entities_service.rb

@@ -0,0 +1,130 @@
+require 'atsd/services/base_service'
+require 'atsd/models/entity'
+require 'atsd/models/metric'
+
+module ATSD
+  # Entities service
+  class EntitiesService < BaseService
+
+    # Entities list
+    #
+    # @option options [Boolean] :active
+    #   Filter entities by last insert time. If `active = true`,
+    #   only entities with positive `last_insert_time` are included in the response
+    # @option options [String] :expression
+    #   Use `name` variable for entity name. Use `*` placeholder in `like` expresions
+    # @option options [Array<String>] :tags
+    #   Specify entity tags to be included in the response
+    # @option options [Integer] :limit
+    #   Limit response to first N entities, ordered by name.
+    # @return [Array<Entity>]
+    # @raise [APIError]
+    def list(options = {})
+      options = options.camelize_keys
+      @client.entities_list(options).map do |json|
+        Entity.new json
+      end
+    end
+
+    # Displays entity properties and all tags.
+    #
+    # @param [String, Entity] entity
+    # @return [Entity]
+    # @raise [APIError]
+    def get(entity)
+      Entity.new(@client.entities_get(name_for_entity entity))
+    end
+
+    # Create an entity with specified properties and tags
+    # or replace an existing entity. This method creates a new
+    # entity or replaces an existing entity.
+    #
+    # @note If only a subset of fields is provided for an existing entity,
+    #   the remaining properties will be set to default values and tags
+    #   will be deleted.
+    #
+    # @param [Hash, Entity] entity
+    # @return [self]
+    # @raise [APIError]
+    def create_or_replace(entity)
+      entity = Entity.new(entity) if entity.is_a? Hash
+      name = name_for_entity entity
+      raise ArgumentError unless name
+      @client.entities_create_or_replace(name, entity.to_request_hash)
+      self
+    end
+
+    # Update specified properties and tags for the given entity.
+    # @note updates specified properties and tags for an existing entity.
+    #   Properties and tags that are not specified are left unchanged.
+    #
+    # @param [Hash, Entity] entity
+    # @return [self]
+    # @raise [APIError]
+    def update(entity)
+      entity = Entity.new(entity) if entity.is_a? Hash
+      @client.entities_update(name_for_entity(entity), entity.to_request_hash)
+      self
+    end
+
+    # Delete the entity. Delete the entity from any Entity Groups that it
+    # belongs to. Data collected by the entity will be removed asynchronously
+    # in the background.
+    #
+    # @param [Hash, Entity, String] entity entity or name
+    # @return [self]
+    # @raise [APIError]
+    def delete(entity)
+      @client.entities_delete(name_for_entity entity)
+      self
+    end
+
+    # Returns an array of property types for the entity.
+    #
+    # @param [String, Hash, Entity] entity
+    # @param [Integer, Time] start_time
+    #   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 } : {}
+      @client.entities_property_types(name_for_entity(entity), params)
+    end
+
+    # Returns a list of metrics collected by the entity.
+    # The list is based on memory cache which is rebuilt on ATSD restart.
+    #
+    # @param [String, Hash, Entity] entity
+    # @option options [Boolean] :active
+    #   Filter metrics by last_insert_time. If active = true,
+    #   only metrics with positive last_insert_time are included in the response
+    # @option options [Array<String>] :tags
+    #   Specify metric tags to be included in the response
+    # @option options [Integer] :limit
+    #   Limit response to first N metrics, ordered by name.
+    # @return [Array<Metric>]
+    # @raise [APIError]
+    def metrics(entity, options = {})
+      options = options.camelize_keys
+      @client.entities_metrics(name_for_entity(entity), options).map do |json|
+        Metric.new json
+      end
+    end
+
+    private
+
+    def name_for_entity(entity)
+      case entity
+        when String
+          entity
+        when Hash
+          entity[:name] || entity['name']
+        when Entity
+          entity.name? ? entity.name : nil
+        else
+          entity.name
+      end
+    end
+  end
+end

data/lib/atsd/services/entity_groups_service.rb

@@ -0,0 +1,186 @@
+require 'atsd/services/base_service'
+require 'atsd/models/entity_group'
+
+module ATSD
+  class EntityGroupsService < BaseService
+    # Entity groups list.
+    #
+    # @option parameters [String] :expression
+    #   Use name variable for entity group name. Use * placeholder
+    #   in like expressions
+    # @option parameters [Array] :tags
+    #   Specify entity group tags to be included in the response
+    # @option parameters [Integer] :limit
+    #   Limit response to first N entity groups, ordered by name.
+    # @return [Array<EntityGroup>]
+    # @raise [APIError]
+    def list(parameters = {})
+      parameters = parameters.camelize_keys
+      @client.entity_groups_list(parameters).map do |json|
+        EntityGroup.new json
+      end
+    end
+
+    # Displays entity group properties and all tags.
+    #
+    # @param [String] entity_group
+    # @return [Array<EntityGroup>]
+    # @raise [APIError]
+    def get(entity_group)
+      EntityGroup.new(@client.entity_groups_get(name_for_entity_group entity_group))
+    end
+
+    # Create an entity group with specified properties and tags
+    # or replace an existing entity group. This method creates
+    # a new entity group or replaces an existing entity group.
+    #
+    # @note If only a subset of fields is provided for an
+    #   existing entity group, the remaining properties and
+    #   tags will be deleted.
+    #
+    # @param [Hash, EntityGroup, String] entity_group
+    # @return [self]
+    # @raise [APIError]
+    def create_or_replace(entity_group)
+      entity_group = EntityGroup.new(name: entity_group) if entity_group.is_a? String
+      entity_group = EntityGroup.new(entity_group) if entity_group.is_a? Hash
+      @client.entity_groups_create_or_replace(entity_group.name, entity_group.to_request_hash)
+      self
+    end
+
+    # Update specified properties and tags for the given entity
+    # group. This method updates specified properties and tags
+    # for an existing entity group.
+    #
+    # @note Properties and tags that are not specified are left
+    #   unchanged.
+    #
+    # @param [Hash, EntityGroup] entity_group
+    # @return [self]
+    # @raise [APIError]
+    def update(entity_group)
+      entity_group = EntityGroup.new(entity_group) if entity_group.is_a? Hash
+      @client.entity_groups_update(entity_group.name, entity_group.to_request_hash)
+      self
+    end
+
+    # Delete the entity group.
+    #
+    # @note Entities that are members of the group are retained.
+    #
+    # @param [String, EntityGroup, Hash] entity_group
+    # @return [self]
+    # @raise [APIError]
+    def delete(entity_group)
+      @client.entity_groups_delete(name_for_entity_group(entity_group))
+      self
+    end
+
+    # Get entities for entity group
+    #
+    # @param [String, EntityGroup, Hash] entity_group
+    # @option parameters [Boolean] :active
+    #   Filter entities by last_insert_time. If active = true, only entities
+    #   with positive last_insert_time are included in the response
+    # @option parameters [String] :expression
+    #   Use name variable for entity name. Use * placeholder in like expressions
+    # @option parameters [Array] :tags
+    #   Specify entity tags to be included in the response
+    # @option parameters [Integer] :limit
+    #   Limit response to first N entities, ordered by name.
+    # @return [Array<Entity>]
+    # @raise [APIError]
+    def entities(entity_group, parameters = {})
+      entity_group = name_for_entity_group(entity_group)
+      parameters = parameters.camelize_keys
+      @client.entity_groups_get_entities(entity_group, parameters).map do |json|
+        Entity.new json
+      end
+    end
+
+    # Add specified entities to entity group.
+    #
+    # @param [String, EntityGroup, Hash] entity_group
+    # @param [Hash, Entity, Array<Hash>, Array<Entity>] entities
+    # @option parameters [Boolean] :create_entities
+    #   Automatically create new entities from the submitted list
+    #   if such entities don’t already exist. Default value: true
+    # @return [self]
+    # @raise [APIError]
+    def add_entities(entity_group, entities, parameters = {})
+      entity_group = name_for_entity_group(entity_group)
+      parameters = parameters.camelize_keys
+      entities = Utils.ensure_array(entities).map do |e|
+        e = Entity.new(name: e) if e.is_a? String
+        e = Entity.new(e) if e.is_a? Hash
+        e = e.to_request_hash
+      end
+      @client.entity_groups_add_entities(entity_group, entities, parameters)
+      self
+    end
+
+    # Replace entities in the entity group with the specified collection.
+    #
+    # @note All existing entities that are not included in the collection
+    #   will be removed. If the specified collection is empty, all entities
+    #   are removed from the group (replace with empty collection).
+    #
+    # @param [String, EntityGroup, Hash] entity_group
+    # @param [Hash, Entity, Array<Hash>, Array<Entity>] entities
+    # @return [self]
+    # @raise [APIError]
+    def replace_entities(entity_group, entities)
+      entity_group = name_for_entity_group(entity_group)
+      entities = Utils.ensure_array(entities).map do |e|
+        e = Entity.new(name: e) if e.is_a? String
+        e = Entity.new(e) if e.is_a? Hash
+        e = e.to_request_hash
+      end
+      @client.entity_groups_replace_entities(entity_group, entities)
+      self
+    end
+
+    # Delete entities from entity group.
+    #
+    # @param [String, EntityGroup, Hash] entity_group
+    # @param [Hash, Entity, Array<Hash>, Array<Entity>] entities
+    # @return [self]
+    # @raise [APIError]
+    def delete_entities(entity_group, entities)
+      entity_group = name_for_entity_group(entity_group)
+      entities = Utils.ensure_array(entities).map do |e|
+        e = Entity.new(name: e) if e.is_a? String
+        e = Entity.new(e) if e.is_a? Hash
+        e = e.to_request_hash
+      end
+      @client.entity_groups_delete_entities(entity_group, entities)
+      self
+    end
+
+    # Delete all entities from entity group.
+    #
+    # @param [String, EntityGroup, Hash] entity_group
+    # @return [self]
+    # @raise [APIError]
+    def delete_all_entities(entity_group)
+      entity_group = name_for_entity_group(entity_group)
+      @client.entity_groups_delete_all_entities(entity_group)
+      self
+    end
+
+    private
+
+    def name_for_entity_group(entity_group)
+      case entity_group
+        when String
+          entity_group
+        when Hash
+          entity_group[:name] || entity_group['name']
+        when EntityGroup
+          entity_group.name? ? entity_group.name : nil
+        else
+          entity_group.name
+      end
+    end
+  end
+end

data/lib/atsd/services/metrics_service.rb

@@ -0,0 +1,122 @@
+require 'atsd/services/base_service'
+require 'atsd/models/metric'
+require 'atsd/models/entity'
+
+module ATSD
+  class MetricsService < BaseService
+    # Metrics list.
+    #
+    # @option parameters [String] :expression
+    #   Use name variable for metric name. Use * placeholder
+    #   in like expressions
+    # @option parameters [Boolean] :active
+    #   Filter metrics by last_insert_time. If active = true,
+    #   only metrics with positive last_insert_time are included in the response
+    # @option parameters [Array] :tags
+    #   Specify metric tags to be included in the response
+    # @option parameters [Integer] :limit
+    #   Limit response to first N metrics, ordered by name.
+    # @return [Array<Metric>]
+    # @raise [APIError]
+    def list(parameters = {})
+      parameters = parameters.camelize_keys
+      @client.metrics_list(parameters).map do |json|
+        Metric.new json
+      end
+    end
+
+    # Displays metric properties and its tags.
+    #
+    # @param [String] metric
+    # @return [Array<Metric>]
+    # @raise [APIError]
+    def get(metric)
+      Metric.new(@client.metrics_get(name_for_metric metric))
+    end
+
+    # Create a metric with specified properties and tags or replace
+    # an existing metric. This method creates a new metric or replaces
+    # an existing metric.
+    #
+    # @note If only a subset of fields is provided for an existing metric,
+    #   the remaining properties and tags will be deleted.
+    #
+    # @param [Hash, Metric, String] metric
+    # @return [self]
+    # @raise [APIError]
+    def create_or_replace(metric)
+      metric = Metric.new(name: metric) if metric.is_a? String
+      metric = Metric.new(metric) if metric.is_a? Hash
+      @client.metrics_create_or_replace(metric.name, metric.to_request_hash)
+      self
+    end
+
+    # Update specified properties and tags for the given metric.
+    # This method updates specified properties and tags for an existing metric.
+    #
+    # @note Properties and tags that are not specified are left unchanged.
+    #
+    # @param [Hash, Metric] metric
+    # @return [self]
+    # @raise [APIError]
+    def update(metric)
+      metric = Metric.new(metric) if metric.is_a? Hash
+      @client.metrics_update(metric.name, metric.to_request_hash)
+      self
+    end
+
+    # Delete the metric. Data collected for the metric will be removed
+    # asynchronously in the background.
+    #
+    # @param [String, Metric, Hash] metric
+    # @return [self]
+    # @raise [APIError]
+    def delete(metric)
+      @client.metrics_delete(name_for_metric(metric))
+      self
+    end
+
+    # Returns a list of unique series tags for the metric. The list is
+    # based on data stored on disk for the last 24 hours.
+    #
+    # @param [Hash, Metric, String] metric
+    # @param [Hash, Entity, String] entity
+    # @return [Array<Entity>]
+    # @raise [APIError]
+    def entity_and_tags(metric, entity = nil)
+      metric = name_for_metric(metric)
+      params = {}
+      params[:entity] = name_for_entity(entity) if entity
+      result = @client.metrics_entity_and_tags(metric, params)
+      result.map { |json| Entity.new json }
+    end
+
+    private
+
+    def name_for_metric(metric)
+      case metric
+        when String
+          metric
+        when Hash
+          metric[:name] || metric['name']
+        when Metric
+          metric.name? ? metric.name : nil
+        else
+          metric.name
+      end
+    end
+
+    def name_for_entity(entity)
+      case entity
+        when String
+          entity
+        when Hash
+          entity[:name] || entity['name']
+        when Entity
+          entity.name? ? entity.name : nil
+        else
+          entity.name
+      end
+    end
+  end
+end