openbmctool : Add documentation for remote logging
Document commands to enable/disable and query remote logging
configuration.
Change-Id: Ie63d3733619288ca59496da926d522afd55db1a7
Signed-off-by: Deepak Kodihalli <dkodihal@in.ibm.com>
diff --git a/thalerj/README.md b/thalerj/README.md
index 929d725..fb1dfb4 100644
--- a/thalerj/README.md
+++ b/thalerj/README.md
@@ -36,3 +36,46 @@
```
openbmctool <connection options> local_users enableall
```
+
+## Remote logging via rsyslog
+
+The BMC has the ability to stream out local logs (that go to the systemd journal)
+via [rsyslog](https://www.rsyslog.com/).
+
+The BMC will send everything. Any kind of filtering and appropriate storage will
+have to be managed on the rsyslog server. Various examples are available on the
+internet. Here are few pointers:
+https://www.rsyslog.com/storing-and-forwarding-remote-messages/
+https://www.rsyslog.com/doc/rsyslog%255Fconf%255Ffilter.html
+https://www.thegeekdiary.com/understanding-rsyslog-filter-options/
+
+### Configuring rsyslog server for remote logging
+
+```
+openbmctool <connection options> logging remote_logging_config -a <IP address> -p <port>
+```
+
+The IP address and port to be provided are of the remote rsyslog server.
+Once this command is run, the remote rsyslog server will start receiving logs
+from the BMC.
+
+Hostname can be specified instead of IP address, if DNS is configured on the BMC.
+
+### Disabling remote logging
+
+```
+openbmctool <connection options> logging remote_logging disable
+```
+
+It is recommended to disable remote logging before switching remote logging from
+an existing remote server to a new one (i.e before re-running the remote_logging_config
+option).
+
+### Querying remote logging config
+
+```
+openbmctool <connection options> logging remote_logging view
+```
+
+This will print out the configured remote rsyslog server's IP address and port,
+in JSON format.