opendev
/
germqtt
Code Issues Proposed changes
Publish a gerrit event stream on MQTT
10 Commits 1 Branch 2 Tags 122 KiB
Go to file
Matthew Treinish 71f062b6a1
Add config option to set QOS of published messages 
This commit adds a new config option to germqtt to set the QOS level
for messages published. By default it'll use 0, but if operating in
an environment where more guarantees are needed on delivery you can
set this to be higher now.

Change-Id: I7bf07921ce2f94a9a34f468294a1a5f1da2673af
 		2016-09-29 18:28:49 -04:00
doc/source Fix all things tox 2016-07-27 01:06:13 -04:00
etc Add config option to set QOS of published messages 2016-09-29 18:28:49 -04:00
germqtt Add config option to set QOS of published messages 2016-09-29 18:28:49 -04:00
.gitignore Initial commit 2016-05-25 21:46:29 -04:00
.gitreview Add missing .gitreview file 2016-07-27 01:06:13 -04:00
.testr.conf Fix all things tox 2016-07-27 01:06:13 -04:00
CONTRIBUTING.rst Initial commit 2016-05-25 21:46:29 -04:00
LICENSE Initial commit 2016-05-25 21:46:29 -04:00
README.rst Add config option to set QOS of published messages 2016-09-29 18:28:49 -04:00
requirements.txt Fix all things tox 2016-07-27 01:06:13 -04:00
setup.cfg Initial commit 2016-05-25 21:46:29 -04:00
setup.py Initial commit 2016-05-25 21:46:29 -04:00
test-requirements.txt Fix all things tox 2016-07-27 01:06:13 -04:00
tox.ini Fix all things tox 2016-07-27 01:06:13 -04:00

README.rst

germqtt

Germqtt, like its name implies, is a tool for publish a gerrit event stream into MQTT. It will publish all the capture events from the gerrit event stream and publish them to MQTT into topics split by project and event type. For example a commented added to a project name foo would be published as an event on the topic: base_topic/foo/commented-added

By default germqtt is setup as a daemon however if you need to run it interactively you can use the --foreground option to do this.

MQTT Topics

germqtt will push gerrit events to topics broken by project and event type. The formula used is:

<base topic>/<project>/<event type>

For example, if gerrit emits a comment-added event for the openstack/nova project germqtt will push that event to the topic:

gerrit/openstack/nova/comment-added

assuming the base topic is configured to be gerrit. For more information on topics in MQTT refer to: https://mosquitto.org/man/mqtt-7.html

Configuration

There are a few required pieces of information to make germqtt work properly. These settings are specified in the config file.

Gerrit

You need to provide credentials and connection information for connecting to gerrit to get the event stream. Germqtt uses the gerritlib library to establish a connection to gerrit over ssh and listen to the event stream. All these options live in the [gerrit] section. The 3 required options for gerrit are:

  • username - The username to login with
  • hostname - The hostname for your gerrit server
  • key - The path to your ssh key to use for connecting to gerrit

There is also an optional config option, port, which is used to specify the port to connect to gerrit with. By default this is set to 29418, which is the gerrit default. If your gerrit server uses a non-default port you'll need to set this option.

MQTT

Just as with gerrit there are a few required options for talking to MQTT, which is the other axis of communication in germqtt. The options for configuring MQTT communication go in the [mqtt] section. The 2 required options are:

  • hostname - The hostname for the MQTT broker
  • topic - The base topic name to use for the gerrit events

There are also a couple optional settings for communicating with mqtt that you can set:

  • port - The port to communicate to the MQTT broker on. By default this

    is set to 1883, the default MQTT port. This only needs to be set if your broker uses a non-default port.

  • keepalive - Used to set the keepalive time for connections to the MQTT

    broker. By default this is set to 60 seconds.

  • username - Used to set the auth username to connect to the MQTT broker

    with.

  • password - Used to set the auth password to connect to the MQTT broker

    with. A username must be set for this option to be used.

  • qos - Used to set the QOS level for the messages published by germqtt.

    For more information on the different QOS levels refer to: https://mosquitto.org/man/mqtt-7.html

Other Settings

By default germqtt will use /var/run/germqtt.pid for it's PID file, if however you'd like to use a different file for storing the PID you can use the pidfile option in the [default] section of the configuration file.