Class: ATSD::MessagesService

Inherits:
BaseService show all
Defined in:
lib/atsd/services/messages_service.rb

Instance Method Summary collapse

Methods inherited from BaseService

#initialize

Constructor Details

This class inherits a constructor from ATSD::BaseService

Instance Method Details

#insert(messages) ⇒ self

Insert messages.

Parameters:

Returns:

  • (self)

Raises:



26
27
28
29
30
31
32
33
 
# File 'lib/atsd/services/messages_service.rb', line 26

def insert(messages)
  messages = Utils.ensure_array(messages).map do |s|
    s = Message.new(s) if s.is_a? Hash
    s.to_request_hash
  end
  @client.messages_insert messages
  self
end

#query(entity, options = {}) ⇒ MessagesQuery

Create query builder for messages.

Parameters:

  • entity (String, Entity)
  • options (Hash) (defaults to: {}) —

    other query parameters

Returns:



13
14
15
16
17
18
19
 
# File 'lib/atsd/services/messages_service.rb', line 13

def query(entity, options = {})
  query = MessagesQuery.new @client
  entity = entity.name if entity.is_a? Entity
  options.merge! entity: entity
  options.each { |option, value| query[option] = value }
  query
end

#stats_query(options) ⇒ self

Retrieve message counters for the specified filters as series.

Parameters:

  • options (Hash) —

    parameters

Returns:

  • (self)

Raises:



40
41
42
43
44
45
46
47
48
 
# File 'lib/atsd/services/messages_service.rb', line 40

def stats_query(options)
  options[:metric] = 'message-count'
  options = Utils.ensure_array(options).map do |s|
    s = Message.new(s) if s.is_a? Hash
    s.to_request_hash
  end
  result = @client.messages_stat_query(options)
  result.map { |json| Series.new json }
end