The Asynchronous Message Tool Kit. Utilities for the AMQP.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
amtk
.gitignore
CHANGELOG.md
LICENSE.txt
README.md
setup.cfg
setup.py

README.md

amtk

The Asynchronous Message Tool Kit. Utilities for the AMQP.

Currently three tools are supported; record, play and merge.

Installation

The AMTK is a Python package and can be found on PyPI: https://pypi.python.org/pypi/amtk

To install the package, use pip:

pip install amtk

Record

The record tool reads messages from the exchange and prints them to stdout. You can use pipes to send the data to a file, which you can play back later.

Messages are recorded in json format. One message should occupy one line in the output.

usage: amtk.record [-h] [--queue QUEUE] [--user USER] [--password PASSWORD]
                   [--host HOST] [--port PORT] [--virtual_host VIRTUAL_HOST]
                   [--prefetch_size PREFETCH_SIZE]
                   [--prefetch_count PREFETCH_COUNT] [--version]
                   exchange routing_key [output]

Reads messages from the queue and prints them. The exchange should be created
before this tool is used.

positional arguments:
  exchange              The messaging exchange.
  routing_key           The routing key used to extract messages.
  output                The output data file. Defaults to stdout.

optional arguments:
  -h, --help            show this help message and exit
  --queue QUEUE         The name of the queue.
  --user USER           The rabbitmq user.
  --password PASSWORD   The rabbitmq password.
  --host HOST           The rabbitmq address.
  --port PORT           The rabbitmq port.
  --virtual_host VIRTUAL_HOST
                        The rabbitmq virtual host.
  --prefetch_size PREFETCH_SIZE
                        The prefetch window size.
  --prefetch_count PREFETCH_COUNT
                        The prefetch message count.
  --version             show program's version number and exit

Play

The play tool reads messages from a file and sends them to the target exchange. You can use the record tool to determine the format required for play.

Messages are recorded in json format. One message should occupy one line in the input.

usage: amtk.play [-h] [--routing_key ROUTING_KEY] [--user USER]
                 [--password PASSWORD] [--host HOST] [--port PORT]
                 [--virtual_host VIRTUAL_HOST] [--mandatory {yes,no}]
                 [--immediate {yes,no}] [--timing TIMING] [--version]
                 exchange [input]

Reads messages from stdin and publishes them. The exchange should be created
before this tool is used.

positional arguments:
  exchange              The messaging exchange.
  input                 The input data file. Defaults to stdin.

optional arguments:
  -h, --help            show this help message and exit
  --routing_key ROUTING_KEY
                        Override the routing key found when recording.
  --user USER           The rabbitmq user.
  --password PASSWORD   The rabbitmq password.
  --host HOST           The rabbitmq address.
  --port PORT           The rabbitmq port.
  --virtual_host VIRTUAL_HOST
                        The rabbitmq virtual host.
  --mandatory {yes,no}  Delivery of the message is mandatory.
  --immediate {yes,no}  Raise an exception if the message cannot be delivered.
  --timing TIMING       Configures the time interval between messages. Can be
                        one of record, create or the number of seconds between
                        messages. If record is specified, the original record
                        timing is used. If create is specified, the created on
                        timestamp is used; note that this timing is only
                        accurate to the second. If no timing is specified,
                        record is used.
  --version             show program's version number and exit

Merge

The merge tool uses message_ids to merge multiple recordings into a single file. The merge results are printed directly to stdout.

Messages are recorded in json format. One message should occupy one line in the output.

usage: amtk.merge [-h] [--order {record,created}] [--version]
                  files [files ...]

Merge a number of recorded data files and print the result. Note that the
message id is used to merge the data sets. Messages that cannot be parsed or
lack a message id are ignored.

positional arguments:
  files                 The source data files.

optional arguments:
  -h, --help            show this help message and exit
  --order {record,created}
                        The order of the messages in the merge.
  --version             show program's version number and exit