summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarcus Müller <mmueller@gnuradio.org>2020-04-13 16:08:23 +0200
committerMartin Braun <martin@gnuradio.org>2021-02-18 23:44:18 -0800
commit9a26bd88d5f73458f0f3aa40145f796d61a1ae48 (patch)
treed8c31372a61fb0b1ddd03d3b0cf1fe957e82d15e
parent0c16f319c32ecf8e5bf2328ba844269b21a1332b (diff)
uhd: documented logging changes, interval configuration option
Signed-off-by: Marcus Müller <mmueller@gnuradio.org>
-rw-r--r--CHANGELOG.md12
-rw-r--r--gr-uhd/docs/uhd.dox14
2 files changed, 26 insertions, 0 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
index ccded73ed4..af5e1c76c7 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -426,6 +426,18 @@ amplitude, offset and phase parameters
- Unhandled exceptions now handled, much calmer
- Avoid infinite blocking in `tb.stop()` by using `ZMQ_LINGER`
+#### gr-uhd
+
+- Change of log method, and increase message verbosity
+
+### Added
+
+#### gr-uhd
+
+- Added `gr::prefs`-configurable logging interval for underflow, overflow and
+ command time error (`[uhd]` section, `logging_interval_ms` key, milliseconds
+ integer)
+
## [3.8.0.0] - 2019-08-09
Witness me!
diff --git a/gr-uhd/docs/uhd.dox b/gr-uhd/docs/uhd.dox
index 39453acdf6..ff08ed6c77 100644
--- a/gr-uhd/docs/uhd.dox
+++ b/gr-uhd/docs/uhd.dox
@@ -210,5 +210,19 @@ resampler to take care of the difference.
self.resampler = filter.pfb.arb_resampler_ccf(resample)
\endcode
+\section Logging
+
+gr-uhd will emit log messages when unexpected events occur.
+
+For under- and overflows, as well as command time errors, since these tend to happen in high-rate scenarios, such errors are counted for logging intervals. The first error after a time longer than the logging interval has passed is logged immediately, but subsequent log entries are accumulated.
+
+The logging interval can be configured using the GNU Radio preferences framework (i.e. gnuradio.conf file), as follows:
+
+\code
+[uhd]
+logging_interval_ms=750
+\endcode
+
+It is an integer that defaults to 750, representing the minimum number of milliseconds between logged under-, overflow events or command time errors.
*/
// vim: set ft=doxygen: