README update for DLOGS (#1092)

awslabs · Oct 23, 2023 · 6a41789 · 6a41789
1 parent 2d2dac6
commit 6a41789
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -18,7 +18,6 @@ option(BUILD_OPENSSL_PLATFORM "If buildng OpenSSL what is the target platform" O
 option(BUILD_LOG4CPLUS_HOST "Specify host-name for log4cplus for cross-compilation" OFF)
 option(CONSTRAINED_DEVICE "Set thread stack size to 0.5MB" OFF)
 
-
 # Developer Flags
 option(BUILD_TEST "Build the testing tree" OFF)
 option(CODE_COVERAGE "Enable coverage reporting" OFF)

diff --git a/README.md b/README.md
@@ -74,6 +74,10 @@ To set a log level, update the log level value [here](https://github.com/awslabs
 
 Note: The default log level is `DEBUG`
 
+The SDK also tracks entry and exit of functions which increases the verbosity of the logs. This will be useful when you want to track the transitions within the codebase. To do so, you need to set log level to TRACE and add the following to the cmake file:
+`add_definitions(-DLOG_STREAMING)`
+Note: This log level is extremely VERBOSE and could flood the files if using file based logging strategy.
+
 #### Cross-Compilation
 If you wish to cross-compile `CC` and `CXX` are respected when building the library and all its dependencies. See our [ci.yml](https://github.com/awslabs/amazon-kinesis-video-streams-producer-sdk-cpp/blob/develop/.github/workflows/ci.yml) for an example of this. Every commit is cross compiled to ensure that it continues to work.
 Please note that GStreamer is not cross-compiled as a part of the cross-compilation of the KVS-SDK, customers will have to cross-compile it separately.