Review fedmsg-introduction SOP

Signed-off-by: Michal Konečný <mkonecny@redhat.com>
This commit is contained in:
Michal Konečný 2021-08-19 12:53:08 +02:00
parent c43693340d
commit 2efa4980b5
2 changed files with 8 additions and 8 deletions

View file

@ -15,17 +15,17 @@ Purpose::
== Description
fedmsg is a system that links together most of our webapps and services
_fedmsg_ is a system that links together most of our webapps and services
into a message mesh or net (often called a "bus"). It is built on top of
the zeromq messaging library.
fedmsg has its own developer documentation that is a good place to check
_fedmsg_ has its own developer documentation that is a good place to check
if this or other SOPs don't provide enough information -
http://fedmsg.rtfd.org
== Tools
Generally, fedmsg-tail and fedmsg-logger are the two most commonly used
Generally, _fedmsg-tail_ and _fedmsg-logger_ are the two most commonly used
tools for debugging and testing. To see if bus-connectivity exists
between two machines, log onto each of them and run the following on the
first:
@ -42,16 +42,16 @@ $ fedmsg-tail --really-pretty
== Configuration
fedmsg configuration lives in /etc/fedmsg.d/
_fedmsg_ configuration lives in `/etc/fedmsg.d/`
`/etc/fedmsg.d/endpoints.py` keeps the list of every possible fedmsg
endpoint. It acts as a global index that defines the bus.
See fedmsg.readthedocs.org/en/latest/config/ for a full glossary of
See https://fedmsg.readthedocs.org/en/stable/configuration/ for a full glossary of
configuration values.
== Logs
fedmsg daemons keep their logs in /var/log/fedmsg. fedmsg message hooks
_fedmsg_ daemons keep their logs in `/var/log/fedmsg`. _fedmsg_ message hooks
in existing apps (like bodhi) will log any errors to the logs of the app
they've been added to (like /var/log/httpd/error_log).
they've been added to (like `/var/log/httpd/error_log`).