[PATCH] osmo-gsm-manuals[master]: logging: document alarms target

[Max]

Hello Jenkins Builder,

I'd like you to reexamine a change.  Please visit

    https://gerrit.osmocom.org/4155

to look at the new patch set (#2).

logging: document alarms target

Add subsection describing "log alarms" target.

Change-Id: I95ce5f3db38616608590e02ee79eb3a7e6e4ea14
Fixes: OS#1913
---
M common/chapters/logging.adoc
1 file changed, 17 insertions(+), 0 deletions(-)


  git pull ssh://gerrit.osmocom.org:29418/osmo-gsm-manuals refs/changes/55/4155/2

diff --git a/common/chapters/logging.adoc b/common/chapters/logging.adoc
index 94fa898..85975bb 100644
--- a/common/chapters/logging.adoc
+++ b/common/chapters/logging.adoc
@@ -127,6 +127,23 @@
 one only for logging, while the other is used for interacting with the
 system. Another option would be to use different log target.
 
+==== Logging to the ring buffer
+
+To avoid having separate VTY session just for logging output while still having immediate access to them,
+one can use `alarms` target. It lets you store the log messages inside the ring buffer of a given size which
+is available with `show alarms` command.
+
+It's configured as follows:
+----
+OsmoBSC> enable
+OsmoBSC# configure terminal
+OsmoBSC(config)# log alarms 98
+OsmoBSC(config-log)#
+----
+
+In the example above 98 is the desired size of the ring buffer (number of messages). Once it's filled,
+the incoming log messages will push out the oldest messages available in the buffer.
+
 ==== Logging to a file
 
 As opposed to Logging to the VTY, logging to files is persistent and

-- 
To view, visit https://gerrit.osmocom.org/4155
To unsubscribe, visit https://gerrit.osmocom.org/settings

Gerrit-MessageType: newpatchset
Gerrit-Change-Id: I95ce5f3db38616608590e02ee79eb3a7e6e4ea14
Gerrit-PatchSet: 2
Gerrit-Project: osmo-gsm-manuals
Gerrit-Branch: master
Gerrit-Owner: Max <msuraev at sysmocom.de>
Gerrit-Reviewer: Harald Welte <laforge at gnumonks.org>
Gerrit-Reviewer: Jenkins Builder