Phoebus Olog Kafka Integration

This is an optional module for the Phoebus Olog electronic logbook service, see https://github.com/Olog/phoebus-olog. Its purpose is to broadcast a message whenever a new log entry is created. The message is handled by a Kafka message broker and clients subscribing to the message topic - named "olog-notify" - will then be able to take suitable action when new messages arrive, e.g. send email or notify through a collaboration tool like Slack.

Prerequisites

In order for this module to act as a Kafka producer, a Kafka message broker must be available on the host name or address defined in the runtime property kafka.bootstrap.servers, e.g. localhost:9092.

Message structure

The Kafka message payload that subscribers will receive is a JSON-formatted object like so:

{
  "url":"http://localhost:8080/Olog/12345",
  "logbooks":["logbook1", "logbook2"],
  "title":"Log Entry Title",
  "author":"John Doe",
  "body":"Log entry body"
}

The url field is useful only if a Phoebus Olog web client has been deployed, see https://github.com/Olog/phoebus-olog-web-client. A subscriber client can use this url to present a direct link to the created log entry.

The actual address and port of the Phoebus Olog web client is configured in the runtime property olog.web.rootURL.