Class: Cabin::Channel

A wonderful channel for logging.

You can log normal messages through here, but you should be really shipping structured data. A message is just part of your data. "An error occurred" - in what? when? why? how?

Logging channels support the usual ‘info’ ‘warn’ and other logger methods provided by Ruby‘s stdlib Logger class

It additionally allows you to store arbitrary pieces of data in it like a hash, so your call stack can do be this:

    @logger = Cabin::Channel.new
    rubylog = Logger.new(STDOUT) # ruby's stlib logger
    @logger.subscribe(rubylog)

    def foo(val)
      context = @logger.context()
      context[:foo] = val
      context[:example] = 100
      bar()

      # Clear any context we just wanted bar() to know about
      context.clear()

      @logger.info("Done in foo")
    end

    def bar
      @logger.info("Fizzle")
    end

The result:

    I, [2011-10-11T01:00:57.993200 #1209]  INFO -- : {:timestamp=>"2011-10-11T01:00:57.992353-0700", :foo=>"Hello", :example=>100, :message=>"Fizzle", :level=>:info}
    I, [2011-10-11T01:00:57.993575 #1209]  INFO -- : {:timestamp=>"2011-10-11T01:00:57.993517-0700", :message=>"Done in foo", :level=>:info}

External Aliases

actions	->	filters
action	->	filter
actions	->	filters
action	->	filter

Attributes

metrics	[RW]	All channels come with a metrics provider.
metrics	[RW]	All channels come with a metrics provider.

Public Class methods

action(&block)

actions()

Get a list of actions included in this class.

actions()

Get a list of actions included in this class.

allow_event?(event, subscription)

Decide to publish the event based on conditions and subscription options

allow_event?(event, subscription)

Decide to publish the event based on conditions and subscription options

condition(&block)

Register a new condition. The block must expect an event and a subscription. It is expected to either return true (allow the event) or false (reject it).

condition(&block)

Register a new condition. The block must expect an event and a subscription. It is expected to either return true (allow the event) or false (reject it).

conditions()

Get a list of conditions included in this class.

conditions()

Get a list of conditions included in this class.

each() {|identifier, channel| ...}

get(identifier=$0)

Get a channel for a given identifier. If this identifier has never been used, a new channel is created for it. The default identifier is the application executable name.

This is useful for using the same Cabin::Channel across your entire application.

get(identifier=$0)

Get a channel for a given identifier. If this identifier has never been used, a new channel is created for it. The default identifier is the application executable name.

This is useful for using the same Cabin::Channel across your entire application.

new()

Create a new logging channel. The default log level is ‘info‘

new()

Create a new logging channel. The default log level is ‘info‘

set(identifier, channel)

Public Instance methods

[](key)

Get a context value by name.

[](key)

Get a context value by name.

[]=(key, value)

Set some contextual map value

[]=(key, value)

Set some contextual map value

context()

publish(data, &block)

Publish data to all outputs. The data is expected to be a hash or a string.

A new hash is generated based on the data given. If data is a string, then it will be added to the new event hash with key :message.

A special key :timestamp is set at the time of this method call. The value is a string ISO8601 timestamp with microsecond precision.

publish(data, &block)

Publish data to all outputs. The data is expected to be a hash or a string.

A new hash is generated based on the data given. If data is a string, then it will be added to the new event hash with key :message.

A special key :timestamp is set at the time of this method call. The value is a string ISO8601 timestamp with microsecond precision.

remove(key)

Remove a context value by name.

remove(key)

Remove a context value by name.

subscribe(output, options = {})

Subscribe a new input New events will be sent to the subscriber using the ’<<’ method

  foo << event

Returns a subscription id you can use later to unsubscribe