MQTT-XES

MQTT-XES is a lightweight library for real-time logging over MQTT, for process mining purposes. The MQTT-XES library is described in the corresponding paper:

MQTT-XES: Real-time Telemetry for Process Event Data
A. Burattin, M. Eigenmann, R. Seiger, B. Weber
In Online Proceedings of the BPM Demo Track 2020; Sevilla, Spain; September, 13-18 2020; CEUR-WS.org 2020.

Installing the library

To use the library in your Maven project it is necessary to include, in the pom.xml file, the package repository:

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

Then you can include the dependency to the version you are interested, for example:

<dependency>
    <groupId>com.github.beamline</groupId>
    <artifactId>mqtt-xes</artifactId>
    <version>0.3.5</version>
</dependency>

See https://jitpack.io/#beamline/mqtt-xes for further details (e.g., using it with Gradle).

Sending events

To generate events to be sent using MQTT-XES it is possible to use the following code snippet, first to create the client:

XesMqttProducer client = new XesMqttProducer("broker.hivemq.com", "BASE");

It is also necessary to create the event that has to be sent:

XesMqttEvent event = new XesMqttEvent("source-id", "case-id", "activity")
    .addTraceAttribute("name", "value")
    .addEventAttribute("name", "value");

Finally, it is possible to send the event using the client object previously defined:

client.connect();
client.send(event);
client.disconnect();

Consuming events

To consume events, it is first necessary to create a consumer client, using the following code snippet:

XesMqttConsumer client = new XesMqttConsumer("broker.hivemq.com", "BASE");

Once the client is set, it is possible to subscribe to the MQTT-XES events being sent and a callback class need to be provided. Please note that the accept method of XesMqttEventCallback receives a XesMqttEvent:

client.subscribe(new XesMqttEventCallback() {
    @Override
    public void accept(XesMqttEvent e) {
        System.out.println(e.getProcessName() + " - " + e.getCaseId() + " - " + e.getActivityName());
    }
});