The component system is designed to provide an easy interface to developing plug-ins for Adhearsion that may be easily shared among the Adhearsion community.

I recently had to create a new component for my app, Queue-Tip. This component takes the result of the AMI command QueueStatus (ManagerInterface#send_action ‘QueueStatus’) via DRb and sorts it into a hash so that it can easily be used pragmatically.

To create a new component, type the following below in your current working directory of your Adhearsion app:

$ ahn create component queue_status

The directory components/queue_status should now exist with 2 files; queue_status.rb and queue_status.yml.
We are only concerned with queue_status.rb for now.

Open up queue_status.rb with your favorite editor and insert the following code:

methods_for :rpc do

  def queue_status
    if VoIP::Asterisk.manager_interface
      result = VoIP::Asterisk.manager_interface.send_action 'queuestatus'
    else
      ahn_log.ami_remote.error "AMI has not been enabled in startup.rb!"
    end
    prag_hash = {}
    result.each do |x|
        prag_hash[x['Queue']] = { :members => {}, :callers => {} } .merge(x.headers) if x.name =~ /queueparams/i
        prag_hash[x['Queue']][:members].merge!(x.headers['Name'] => {}.merge(x.headers)) if x.name =~ /queuemember/i
        prag_hash[x['Queue']][:callers].merge!(x.headers['Position'] => {}.merge(x.headers)) if x.name =~ /queueentry/i
    end
    return prag_hash
  end

end

Now you can start up your Adhearsion app

$ ahn start /path/to/app

Assuming you are using DRb to talk with Adhearsion and the DRb listener is configured for host localhost and port 9050, you can now do the following:

require 'drb'
require 'rubygems'
require 'adhearsion'
require 'adhearsion/voip/asterisk/manager_interface'

asterisk = DRbObject.new_with_uri 'druby://localhost:9050'
result = asterisk.queue_status

Now result contains the, well result, of asterisk.queue_status.
Let’s say you want to find out the names of all the queues returned.

irb(main):01:0> result.keys
=> ["ebo-mgr", "it", "healthcare-sp", "admin", "insurance", "healthcare", "insurance-mgr", "healthcare-mgr", "hc-standby", "ebo", "hr"]
irb(main):02:0>

The names of the queues are the keys for the hash. Let’s say I want to find out all agents logged into the healthcare queue

irb(main):02:0> result["healthcare"][:members].keys
=> ["SIP/3409", "SIP/3410", "SIP/3421", "SIP/3411", "SIP/3422", "SIP/3401", "SIP/3412", "SIP/3423", "SIP/3414", "SIP/3415", "SIP/3426", "SIP/3405", "SIP/3406", "SIP/3419"]
irb(main):03:0>

As you can see above, the agent’s channel is the key the agent’s hash. Now let’s look at a specific agent’s stats in the queue healthcare

irb(main):03:0> result["healthcare"][:members]["SIP/3421"]
=> {"Membership"=>"dynamic", "Penalty"=>"0", "LastCall"=>"0", "Status"=>"1", "Name"=>"SIP/3421", "Location"=>"SIP/3421", "Paused"=>"0", "ActionID"=>"QQ16Gm3e-utlZ-01LM-ILfq-lqVDncPDEkhM", "CallsTaken"=>"0", "Queue"=>"healthcare"}
irb(main):04:0>

This pattern also applies to callers waiting in the queues, except the caller’s position is the key for the caller hash.

irb(main):04:0> result["healthcare"][:callers].key
=> ["1"]
irb(main):05:0>

The above tells us we have one caller waiting in the healthcare queue. Now let’s take a look at that caller:

irb(main):05:0> result["healthcare"][:callers]["1"]
=> {"Position"=>"1", "Channel"=>"Zap/25-1", "Wait"=>"2", "CallerID"=>"903XXXXXX", "CallerIDName"=>"DOE,JOHN", "ActionID"=>"3aOnPOvE-MPwr-zpm1-b3dH-x26FOpmYcIlU", "Queue"=>"healthcare"}
irb(main):06:0>

Enjoy!

About

• Queue-Tip is an Asterisk Queue monitoring and reporting tool designed with the Ruby on Rails and Adhearsion frameworks.

Features

• Real-time, live view, of Asterisk queues updated seamlessly using Javascript
• Queue stats are collected in real-time using Adhearsion
• Load Asterisk’s queue_log file into a database
• Run reports on agent and queue stats.
• Partition agents in to “groups” for reporting needs..
• Export reports in csv format

Queue-Tip @ Rubyforge
Queue-Tip @ GitHub