Ruby Agents

MCollective RPC works because it makes a lot of assumptions about how you write agents, we’ll try to capture those assumptions here and show you how to apply them to our Echo agent.

This section of the documentation have recently been migrated from the old mcollective documentation, we are still in the process of verifying every example works in modern mcollective. If you find any issues please get in touch.

Conventions regarding Incoming Data

As you’ve seen in the client documentation our clients will send requests like:

mc.echo(:msg => "Welcome to MCollective RPC")

A more complex example might be:

exim.setsender(:msgid => "1NOTVx-00028U-7G", :sender => "")

Effectively this creates a hash with the members :msgid and :sender and invokes the setsender action.

You cannot use the a data item called :process_results as this has special meaning to the agent and client. This will indicate to the agent that the client isn’t going to be waiting to process results. You might choose not to send back a reply based on this.

Sample Agent

Here’s our sample Echo agent:

# $libdir/mcollective/agent/echo.ddl
metadata :name        => "echo",
         :description => "Echo service for MCollective",
         :author      => "R.I.Pienaar",
         :license     => "GPLv2",
         :version     => "1.1",
         :url         => "",
         :timeout     => 60

action "echo", :description => "Echos back any message it receives" do
    display :always

    input :msg,
          :prompt      => "Message",
          :description => "Your message",
          :type        => :string,
          :validation  => ".*",
          :optional    => false,
          :maxlength   => 1024

    output :msg,
        :description => "Your message",
        :display_as  => "Message",
        :default     => ""
# $libdir/mcollective/agent/echo.rb
module MCollective
  module Agent
    class Echo<RPC::Agent
      # Basic echo server
      action "echo" do
        reply[:msg] = request[:msg]

You’ll notice it comes in two parts, the agent definition in the DDL file, and the implementation in the ruby class.

Agent Name

The agent name is derived from the class name, the example code creates the ruby class MCollective::Agent::Echo, the agent name for this would be echo.

Help and the Data Description Language

We have a file that goes together with an agent implementation which is used to describe the agent in detail. This is referred to as the ddl file, $libdir/mcollective/agent/echo.ddl in the previous example.

The DDL file can be used to generate help texts, and to declare the validation that arguments must pass. This information helps us in making more robust clients and can be used to auto generate user interfaces.

We’ll not say much more about the DDL here, for more details read the DDL reference.


Actions are the individual tasks that your agent can do, we declare them in the DDL file, and put their implementation in the ruby class named for the agent (ie MCollective::Agent::Echo for the echo agent).

Declaring Actions

Actions with their inputs and outputs are declared in the DDL for the agent. From our echo example here’s the declaration of the echo action again:

# $libdir/mcollective/agent/echo.ddl - incomplete fragment
action "echo", :description => "Echos back any message it receives" do
    display :always

    input :msg,
          :prompt      => "Message",
          :description => "Your message",
          :type        => :string,
          :validation  => ".*",
          :optional    => false,
          :maxlength   => 1024

    output :msg,
        :description => "Your message",
        :display_as  => "Message",
        :default     => ""

Implementing Actions

The implementation of an action is added to the agent class:

# $libdir/mcollective/agent/echo.rb
module MCollective
  module Agent
    class Echo<RPC::Agent
      action "echo" do
        reply[:msg] = request[:msg]

Accessing the Input

As you see from the echo example our input is easy to get to by just looking in request, this would be a Hash of exactly what was sent in by the client in the original request.

The request object is in instance of MCollective::RPC::Request, you can also gain access to the following:

Property Description
time The time the message was sent
action The action it is directed at
data The actual hash of data
sender The id of the sender
agent Which agent it was directed at

Since data is the actual Hash you can gain access to your input like:[:msg]

Accessing via will give you full access to all the normal Hash methods, eg


Accesing via request[] will only give you access to include? like behaviour, nil will be returned for unknown keys or data that is not supplied.

Running Shell Commands

A helper function exist that makes it easier to run shell commands and gain access to their STDOUT and STDERR.

We recommend everyone use this method for calling to shell commands as it forces _LCALL to C as well as wait on all the children and avoids zombies, you can set unique working directories and shell environments that would be impossible using simple system that is provided with Ruby.

The simplest case is just to run a command and send output back to the client:

reply[:status] = run("echo 'hello world'", :stdout => :out, :stderr => :err)

Here you will have set reply[:out], reply[:err] and reply[:status] based on the output from the command.

You can append the output of the command to any string:

out = []
err = ""
status = run("echo 'hello world'", :stdout => out, :stderr => err)

Here the STDOUT of the command will be saved in the variable out and not sent back to the caller. The only caveat is that the variables out and err should have the << method, so if you supplied an array each line of output will be a single member of the array. In the example out would be an array of lines while err would just be a big multi line string.

By default any trailing new lines will be included in the output and error:

reply[:status] = run("echo 'hello world'", :stdout => :out, :stderr => :err)

You can shorten this to:

reply[:status] = run("echo 'hello world'", :stdout => :out, :stderr => :err, :chomp => true)

This will remove a trailing new line from the reply[:out] and reply[:err].

If you wanted this command to run from the /tmp directory:

reply[:status] = run("echo 'hello world'", :stdout => :out, :stderr => :err, :cwd => "/tmp")

Or if you wanted to include a shell Environment variable:

reply[:status] = run("echo 'hello world'", :stdout => :out, :stderr => :err, :environment => {"FOO" => "BAR"})

The status returned will be the exit code from the program you ran, if the program completely failed to run in the case where the file doesn’t exist, resources were not available etc the exit code will be -1

You have to set the cwd and environment through these options, do not simply call chdir or adjust the ENV hash in an agent as that will not be safe in the context of a multi threaded Ruby application.

Actions in external scripts

Actions can also be implemented using other programming languages as long as they support JSON.

action "test" do
  implemented_by "/some/external/script"

The script /some/external/script will be called with 2 arguments:

  • The path to a file with the request in JSON format
  • The path to a file where you should write your response as a JSON hash

You can also access these 2 file paths in the _MCOLLECTIVE_REPLYFILE and _MCOLLECTIVE_REQUESTFILE environment variables

Simply write your reply as a JSON hash into the reply file.

The exit code of your script should correspond to the ones in [ResultsandExceptions][]. Any text in STDERR will be logged on the server at error level and used in the text for the fail text.

Any text to STDOUT will be logged on the server at level info.

These scripts can be placed in a standard location:

action "test" do
  implemented_by ""

This will search each configured libdir for _mcollective/agent/$agentname/ and _agent/$agentname/, and will use the former if found. If you specified a full path it will not try to find the file in libdirs.

Constructing Replies

Reply Data

The reply data is in the reply variable and is an instance of MCollective::RPC::Reply.

reply[:msg] = request[:msg]

Reply Status

Replies have a strong concept of success or failure indicating the overall success of the request, the table below shows the valid statusses:

Status Code Description Exception Class
0 OK
1 OK, failed. All the data parsed ok, we have a action matching the request but the requested action could not be completed. RPCAborted
2 Unknown action UnknownRPCAction
3 Missing data MissingRPCData
4 Invalid data InvalidRPCData
5 Other error UnknownRPCError
action "rmmsg" do
  validate :msg, String
  validate :msg, /[a-zA-Z]+-[a-zA-Z]+-[a-zA-Z]+-[a-zA-Z]+/"No such message #{request[:msg]}", 1) unless have_msg?(request[:msg])

  # check all the validation passed before doing any work
  return unless reply.statuscode == 0

  # now remove the message from the queue

The number in corresponds to the codes in the table above it would default to 1 so you could just say: "No such message #{request[:msg]}" unless have_msg?(request[:msg])

This is hypothetical action that is supposed to remove a message from some queue, if we do have a String as input that matches our message id’s we then check that we do have such a message and if we don’t we fail with a helpful message.

Technically this will just set statuscode and statusmsg fields in the reply to appropriate values.

It won’t actually raise exceptions or exit your action though you should do that yourself as in the example here.

There is also a fail! instead of just fail it does the same basic function but also raises exceptions. This lets you abort processing of the agent immediately without performing your own checks on statuscode as above later on.

Sharing code between agents

Sometimes you have code that is needed by multiple agents or shared between the agent and client. MCollective has name space called MCollective::Util for this kind of code and the packagers and so forth supports it.

Create a class with your shared code given a name like MCollective::Util::Yourco and save this file in the libdir in util/yourco.rb

A sample class can be seen here:

module MCollective
  module Util
    class Yourco
      def dosomething

You can now use it in your agent or clients by first loading it from the MCollective lib directories:


helpers =


You can write a fine grained Authorization system to control access to actions and agents, please see Choria AAA for full details.


The actions that agents perform can be Audited by code you provide, potentially creating a centralized audit log of all actions. See Choria AAA for full details.


You can write to the server log file using the normal logger class:

Log.debug("Hello from your agent")

You can log at levels info, warn, debug, fatal or error.

Processing Hooks

We provide a few hooks into the processing of a message, you’ve already used this earlier to set metadata.

You’d use these hooks to add some functionality into the processing chain of agents, maybe you want to add extra logging for audit purposes of the raw incoming message and replies, these hooks will let you do that.

Hook Function Name Description
startup_hook Called at the end of the initialize method of the RPC::Agent base class
before_processing_hook(msg, connection) Before processing of a message starts, pass in the raw message and the MCollective::Connector class
after_processing_hook Just before the message is dispatched to the client


Called at the end of the RPC::Agent standard initialize method. Use this to adjust meta parameters, timeouts and any setup you need to do.

This will not be called right when the daemon starts up, we use lazy loading and initialization so it will only be called the first time a request for this agent arrives.


Called just after a message was received from the middleware before it gets passed to the handlers. request and reply will already be set, the msg passed is the message as received from the normal MCollective runner and the connection is the actual connector.

You can in theory send off new messages over the connector maybe for auditing or something, probably limited use case in simple agents.


Called at the end of processing just before the response gets sent to the middleware.

This gets run outside of the main exception handling block of the agent so you should handle any exceptions you could raise yourself. The reason it is outside of the block is so you’ll have access to even status codes set by the exception handlers. If you do raise an exception it will just be passed onto the runner and processing will fail.

Agent Configuration

You can save configuration for your agents in the main server config file:

plugin.helloworld.setting = foo

In your code you can retrieve the config setting like this:

setting = config.pluginconf.fetch("helloworld.setting", "")

This will set the setting to whatever is in the config file or “” if unset.