Class: Sensu::Transport::Base

Inherits:
Object
  • Object
show all
Includes:
EM::Deferrable
Defined in:
lib/sensu/transport/base.rb

Direct Known Subclasses

RabbitMQ, Redis

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Base

Returns a new instance of Base.



17
18
19
20
21
 
# File 'lib/sensu/transport/base.rb', line 17

def initialize
  @on_error = Proc.new {}
  @before_reconnect = Proc.new {}
  @after_reconnect = Proc.new {}
end

Instance Attribute Details

#logger ⇒ Logger

Returns the Sensu logger object.

Returns:

  • (Logger) —

    the Sensu logger object.



15
16
17
 
# File 'lib/sensu/transport/base.rb', line 15

def logger
  @logger
end

Class Method Details

.descendants ⇒ Object

Discover available transports (Subclasses)



138
139
140
141
142
 
# File 'lib/sensu/transport/base.rb', line 138

def self.descendants
  ObjectSpace.each_object(Class).select do |klass|
    klass < self
  end
end

Instance Method Details

#ack(*args, &callback) ⇒ Object

Alias for acknowledge(). This should be superseded by a proper alias via alias_method in the transport class.



122
123
124
 
# File 'lib/sensu/transport/base.rb', line 122

def ack(*args, &callback)
  acknowledge(*args, &callback)
end

#acknowledge(info) {|info| ... } ⇒ Object

Acknowledge the delivery of a message from the transport.

Parameters:

  • info (Hash) —

    message information, eg. contains its id.

Yields:

  • (info) —

    passes acknowledgment info to an optional callback/block.



116
117
118
 
# File 'lib/sensu/transport/base.rb', line 116

def acknowledge(info)
  yield(info) if block_given?
end

#after_reconnect(&callback) ⇒ Proc

Set the after reconnect callback.

Parameters:

  • callback (Proc) —

    called after reconnecting to the transport.

Returns:

  • (Proc) —

    the after reconnect callback.



46
47
48
 
# File 'lib/sensu/transport/base.rb', line 46

def after_reconnect(&callback)
  @after_reconnect = callback
end

#before_reconnect(&callback) ⇒ Proc

Set the before reconnect callback.

Parameters:

  • callback (Proc) —

    called before attempting to reconnect to the transport.

Returns:

  • (Proc) —

    the before reconnect callback.



37
38
39
 
# File 'lib/sensu/transport/base.rb', line 37

def before_reconnect(&callback)
  @before_reconnect = callback
end

#close ⇒ Object

Close the transport connection.



68
 
# File 'lib/sensu/transport/base.rb', line 68

def close; end

#connect(options = {}) ⇒ Object

Transport connection setup.

Parameters:

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


53
 
# File 'lib/sensu/transport/base.rb', line 53

def connect(options={}); end

#connected? ⇒ TrueClass, FalseClass

Indicates if connected to the transport.

Returns:

  • (TrueClass, FalseClass) 


63
64
65
 
# File 'lib/sensu/transport/base.rb', line 63

def connected?
  false
end

#on_error(&callback) ⇒ Proc

Set the error callback.

Parameters:

  • callback (Proc) —

    called in the event of a transport error, the exception object should be passed as a parameter.

Returns:

  • (Proc) —

    the error callback.



28
29
30
 
# File 'lib/sensu/transport/base.rb', line 28

def on_error(&callback)
  @on_error = callback
end

#publish(type, pipe, message, options = {}) {|info| ... } ⇒ Object

Publish a message to the transport.

Parameters:

  • type (Symbol) —

    the transport pipe type, possible values are: :direct and :fanout.

  • pipe (String) —

    the transport pipe name.

  • message (String) —

    the message to be published to the transport.

  • options (Hash) (defaults to: {}) —

    the options to publish the message with.

Yields:

  • (info) —

    passes publish info to an optional callback/block.

Yield Parameters:

  • info (Hash) —

    contains publish information, which may contain an error object (:error).



80
81
82
83
 
# File 'lib/sensu/transport/base.rb', line 80

def publish(type, pipe, message, options={})
  info = {:error => nil}
  yield(info) if block_given?
end

#reconnect(force = false) ⇒ Object

Reconnect to the transport.

Parameters:

  • force (Boolean) (defaults to: false) —

    the reconnect.



58
 
# File 'lib/sensu/transport/base.rb', line 58

def reconnect(force=false); end

#stats(funnel, options = {}) {|info| ... } ⇒ Object

Transport funnel stats, such as message and consumer counts.

Parameters:

  • funnel (String) —

    the transport funnel to get stats for.

  • options (Hash) (defaults to: {}) —

    the options to get funnel stats with.

Yields:

  • (info) —

    passes funnel stats a callback/block.

Yield Parameters:

  • info (Hash) —

    contains funnel stats.



132
133
134
135
 
# File 'lib/sensu/transport/base.rb', line 132

def stats(funnel, options={})
  info = {}
  yield(info) if block_given?
end

#subscribe(type, pipe, funnel = nil, options = {}) {|info, message| ... } ⇒ Object

Subscribe to a transport pipe and/or funnel.

Parameters:

  • type (Symbol) —

    the transport pipe type, possible values are: :direct and :fanout.

  • pipe (String) —

    the transport pipe name.

  • funnel (String) (defaults to: nil) —

    the transport funnel, which may be connected to multiple pipes.

  • options (Hash) (defaults to: {}) —

    the options to consume messages with.

Yields:

  • (info, message) —

    passes message info and content to the consumer callback/block.

Yield Parameters:

  • info (Hash) —

    contains message information.

  • message (String) —

    message.



97
98
99
100
101
 
# File 'lib/sensu/transport/base.rb', line 97

def subscribe(type, pipe, funnel=nil, options={})
  info = {}
  message = ''
  yield(info, message)
end

#unsubscribe {|info| ... } ⇒ Object

Unsubscribe from all transport pipes and/or funnels.

Yields:

  • (info) —

    passes info to an optional callback/block.

Yield Parameters:

  • info (Hash) —

    contains unsubscribe information.



107
108
109
110
 
# File 'lib/sensu/transport/base.rb', line 107

def unsubscribe
  info = {}
  yield(info) if block_given?
end