MichaelDickens: more initial content

2021-05-14T19:49:12Z

MichaelDickens: Initial creation, part 1

2021-05-13T16:56:05Z

Initial creation, part 1

New page

==Application Note Information==
'''AN-001''' by Michael Dickens


==Overview==

This application note describes the UHD logging facility: compile-time options, runtime options, application usage, default values and how all of these interact.

==Code==

UHD has 3 primary files associated with logging: [https://github.com/EttusResearch/uhd/blob/master/host/include/uhd/utils/log.hpp log.hpp], [https://github.com/EttusResearch/uhd/blob/master/host/lib/utils/log.cpp log.cpp], and [https://github.com/EttusResearch/uhd/blob/master/host/cmake/Modules/UHDLog.cmake UHDLog.cmake]. There are secondary logging files providing an interface to C and Python.

==Concepts==

There are 7 logging levels; the name and number can be used interchangeably for any logging variable.

{| class="wikitable" style="text-align: center; cellpadding: 20px"
|+ UHD Logging Levels
|-
| trace
| 0
|-
| debug
| 1
|-
| info
| 2
|-
| warning
| 3
|-
| error
| 4
|-
| fatal
| 5
|-
| off
| 6
|}

There are 2 distinct times where logging can be controlled: during compilation per CMake settings, and during runtime via shell environment variables.

===CMake Logging Settings===

There are 4 CMake variables that control logging: <code>UHD_LOG_MIN_LEVEL</code>, <code>UHD_LOG_CONSOLE_DISABLE</code>, <code>UHD_LOG_FILE_LEVEL</code>, and <code>UHD_LOG_CONSOLE_LEVEL</code>. Each of these variables can be set independently via the CMake commandline or other methods, and override each's default value. The default values for these variables depend on whether the <code>CMAKE_BUILD_TYPE</code> is debug or not, as follows:

{| class="wikitable" style="text-align: center; cellpadding: 20px"
|+ UHD CMake Logging Variables and Default Values for different <code>CMAKE_BUILD_TYPE</code>
|-
| Variable
| non-<code>Debug</code>
| <code>Debug</code>
|-
| <code>UHD_LOG_MIN_LEVEL</code>
| colspan="2" | debug (1)
|-
| <code>UHD_LOG_CONSOLE_DISABLE</code>
| colspan="2" | OFF
|-
| <code>UHD_LOG_FILE_LEVEL</code>
| info (2)
| trace (0)
|-
| <code>UHD_LOG_CONSOLE_LEVEL</code>
| info (2)
| debug (0)
|}

===Runtime Logging Settings===

[[Category:Application Notes]]

@@ Line 16: / Line 16: @@
 ==Overview==
-This application note describes the UHD logging facility: compile-time options, runtime options, application usage, default values and how all of these interact.
+This application note describes the UHD logging facility: compile-time options, runtime options, application usage, and default values ... and how all of these interact.
 ==Code==
@@ Line 30: / Line 30: @@
 |-
 | trace
 | debug
 | info
 | warning
 | error
 | fatal
 | off
 | 6
 |}
@@ Line 55: / Line 50: @@
 ===CMake Logging Settings===
-There are 4 CMake variables that control logging: <code>UHD_LOG_MIN_LEVEL</code>, <code>UHD_LOG_CONSOLE_DISABLE</code>, <code>UHD_LOG_FILE_LEVEL</code>, and <code>UHD_LOG_CONSOLE_LEVEL</code>. Each of these variables can be set independently via the CMake commandline or other methods, and override each's default value. The default values for these variables depend on whether the <code>CMAKE_BUILD_TYPE</code> is debug or not, as follows:
+There are 10 CMake variables that control logging:
 {| class="wikitable" style="text-align: center; cellpadding: 20px"
 |+ UHD CMake Logging Variables and Default Values for different <code>CMAKE_BUILD_TYPE</code>
 |-
-| Variable
-| non-<code>Debug</code>
+| colspan="2" | ''Default Value''
-| <code>Debug</code>
 |-
-| <code>UHD_LOG_MIN_LEVEL</code>
+| ''Variable''
-| colspan="2" | debug (1)
+| ''non-<code>Debug</code>''
-|-
+| ''<code>Debug</code>''
-| <code>UHD_LOG_CONSOLE_DISABLE</code>
-| colspan="2" | OFF
 |-
 | <code>UHD_LOG_FILE_LEVEL</code>
-| info (2)
+| <code>info</code>
-| trace (0)
+| <code>trace</code>
 |-
 | <code>UHD_LOG_CONSOLE_LEVEL</code>
-| info (2)
+| <code>info</code>
-| debug (0)
+| <code>debug</code>
 |}
 ===Runtime Logging Settings===
 [[Category:Application Notes]]

The UHD logging facility - Revision history

MichaelDickens: more initial content

MichaelDickens: Initial creation, part 1