This recorder forms part of the Data Insight Platform. It listens for the latest content for the narrative and exposes that information via an HTTP api for use by the dashboards.
The recorder listens to messages on the following topic:
*.narrative
The queue name defaults to narrative but can be overridden using the QUEUE environment variable.
The expected format from the collector is:
{
"envelope":{
"collected_at":"2012-07-31T10:46:25+01:00",
"collector":"narrative"
},
"payload":{
"content":"Some content of interest went up 20%",
"author":"Gareth Rushgrove"
}
}
Bundler manages the ruby dependencies so you'll want a quick:
bundle install
If you're using the run command you'll need a message queue listening. This defaults to listening on localhost on 5672 but can be overridden with the AMQP environment variable.
The recorder provides a command which will listen for messages on the topic store the latest message locally for use by the API.
bundle exec bin/narrative-recorder run
Full help details can be found with:
bundle exec bin/narrative-recorder help
Once you have recorded the latest narrative the web application which exposes that information can be started.
bundle exec rackup
This starts a web application which exposes one URL at /narrative which returns a JSON document of the following format:
{"content":"Content goes here"}