Skip to content

Latest commit

 

History

History
103 lines (56 loc) · 6 KB

README.md

File metadata and controls

103 lines (56 loc) · 6 KB
Raw

RMap harvest/loader framework

Build Status

The RMap harvest/loader framework is a loosely coupled set of components for extracting source data, transforming it into RMap DiSCOs, and adding or updating these DiSCOs in RMap. Components may be read and write to durable message queues. As such, they are loosely coupled and may be implement any logic in any language to perform individual tasks. A simple and convenient java-based JMS client is provided, but clients may use any convenient messsaging library to interact with the queues (such as Apache Camel).

Message queues

The harvest framework relies on message queues to store raw, intermediate, and final documents as they are harvested, transformed, and ultimately loaded. Naming these queues follows a convention: rmap.harvest.${format}.*. In other words, all queue names begin with rmap.harvest, followed by a string representing the "format" of document contained in the message, followed optionally by additional string(s) that provide meaning to humans in telling queues apart based upon source, processing method, etc.

If records cannot be successfully processed, the convention is to put them in a queue named rmap.harvest.error.${format}.*

The RMap harvest/loader framework has been tested with the Apache ActiveMQ message broker. ActiveMQ supports wildcards in queue names in order to match multiple queues for consuming messages. Using wildcards important for ease of configuration. For example, relying on our queue naming convention; the following queue specification will consume from all queues containing DiSCOs:

rmap.harvest.disco.>

Example

Let's say that records are harvested from OAI, transformed into DiSCOs, and then loaded into RMap.

It would be reasonable for an OAI harvester service to place raw, individual OAI records into a queue:

rmap.harvest.oai_dc.the_source.2017-05-01.try01

Next, let's suppose we have a service that transforms oai_dc records into DiSCOs. It listens on a wildcard queue:

rmap.harvest.oai_dc.>

.. so it picks up messages our OAI harvester places on the queue. When it transforms, it places the results on the queue:

rmap.harvest.disco.transformed.oai_dc.xsl.the_source.2017-05-01.try01

Any failed transforms are thrown onto the queue:

rmap.harvest.error.disco.transformed.oai_dc.xsl.the_source.2017-05-01.try01

Now, our DiSCO loader service listens on:

rmap.harvest.disco.>

It uploads the discos from our queue (and any others).

We can later inspect the content of the error queue, and decide the fate of the failed records from the transform. If they are fixable, we fix them, and throw them back onto the queue they came from, or just create a new queue

rmap.harvest.disco.transformed.oai_dc.xsl.the_source.2017-05-01.try01.FIXED

Reporting and monitoring

There are several tools available for monitoring activeMQ queues. The built-in activemq web console is good start. Something like hawtio has more features. This is where a good naming convention for queues pays off. To be able to tell at a glance the significance of a given queue is quite helpful.

Services

Services are the things that read or write to queues. In this repository, they are distributed simply as executable jars that can be run whenever desired.

Extractors

  • zip - places all files contained within a zip file onto a queue

Transformers

  • xsl - Transforms files from a specified queue with the specified xslt file. Uses Saxon, and supports transforms that output multiple records for a given input document

Loaders

  • disco - Loads records from disco queues into RMap. Maintains a registry of deposited records so that it can decide whether an update is appropriate, or an add.

Deployment

The loader components are standalone applications that can be run as-necessary. State is kept in (a) activeMQ queues, and (b) a relational database which backs the harvest registry (to keep track of what has already been deposited, and map to DiSCO IDs for the purpose of updating discos, or skipping updates because).

You can use the provided docker-compose file to launch an instance of Apache ActiveMQ, and postgresql for local development, or for permanent infrastructure.

Example for development

This example shows how to use the rmap loader to deposit DiSCOs that have been externally generated, and provided to the loader in the form of zip files containing thousands of DiSCO files in rdf/xml format.

Run Docker

docker-compose up -d

Load the DiSCOs into a queue

java -Dcontent.type='application/vnd.rmap-project.disco+rdf+xml' \
     -Djms.queue.dest=rmap.harvest.disco.ieee.2018-01-11 \
     -jar /rmap-loader-extract-zip-0.0.1-SNAPSHOT-exe.jar /path/to/directory/*.zip

Pick an RMap instance, or start one from the integration module of RMap

mvn validate docker:start cargo:run

Later on, load them into RMap with the loader application (debug logging enabled in the example so request attempts can be seen)

java -Djdbc.url=jdbc:postgresql://localhost/loader \
     -Djdbc.username=pguser
     -Djdbc.password=pguser
     -Dthreads=4
     -Drmap.api.auth.token=abc123
     -Drmap.api.baseuri=http://rmap.host:port/api/
     -DLOG.info.rmapproject=DEBUG
     -jar rmap-loader-deposit-disco-0.0.1-SNAPSHOT-exe.jar

At any time, the state of the queues (how many messages are in which queue; how many consumers are processing, etc) can be seen via the ActiveMQ management console http://localhost:8161 (user: admin, pass: admin)