RDK Logger is a common logging library which is based on MPEOS logging & it uses log4c for formatting and supports multiple log levels<\/p>\n
RDK Logger Capabilities<\/h3>\n\n- Abstracts logging client from underlying logging utility.<\/li>\n
- Dynamically enables\/disables logging level at run time.<\/li>\n
- Provides logging format that complies with the existing OCAP format (e.g. <timestamp> [mod=*, level=*]).<\/li>\n
- Controls log level independently for each component\/module.<\/li>\n
- Enables logging globally via single configuration value.<\/li>\n
- Controls initial log level for each component\/module from configuration file (debug.ini) at startup.<\/li>\n
- Prints formatted data to stdout.<\/li>\n
- Separates logs into separate files based on “SEPARATE.LOGFILE.SUPPORT<\/strong>” configuration variable<\/li>\n<\/ul>\n
Architecture<\/h3>\n<\/p>\n
![](\"\/wp-content\/uploads\/sites\/16\/2023\/09\/RDK_LOGGER_ARCHITECTURE.drawio.png\")
<\/p>\n
Log4c – Introduction & Terminology:<\/h3>\n\n- Framework which provides the capability to log messages in a variety of formats to console or local file<\/li>\n
- Configuration – Log4c can be configured using a configuration file\n
\n- log4crc keeps configurations in xml format<\/li>\n
- Configurations can be provided for modules, sub modules etc.<\/li>\n<\/ul>\n<\/li>\n
- Loggers – Named log message destinations which are known to applications.<\/li>\n
- Appenders – Responsible for delivering LogEvents to their destination.<\/li>\n
- Layouts & Filters determine how the message is formatted & filter the messages according to the configuration.<\/li>\n<\/ul>\n
Logging Levels supported by RDK Logger<\/h3>\n\n\n\nCode<\/th> Description<\/th><\/tr> RDK_LOG_FATAL<\/td> Any error that is forcing a shutdown of the service or application to prevent data loss (or further data loss), reserve these only for the most heinous errors and situations where there is guaranteed to have been data corruption or loss.<\/td><\/tr> RDK_LOG_ERROR<\/td> Any error which is fatal to the operation but not the service (cant open a file, missing data, etc)<\/td><\/tr> RDK_LOG_WARN<\/td> Anything that can potentially cause application oddities, but for which the application automatically recovering.<\/td><\/tr> RDK_LOG_NOTICE<\/td> Anything that largely superfluous for application-level logging.<\/td><\/tr> RDK_LOG_INFO<\/td> Generally useful information to log (service start\/stop, configuration assumptions, etc).<\/td><\/tr> RDK_LOG_DEBUG<\/td> Information that is diagnostically helpful to people more than just developers.<\/td><\/tr> RDK_LOG_TRACE1,<\/p>
RDK_LOG_TRACE2,…<\/p><\/td>
Only when it would be “tracing” the code and trying to find one part of a function specifically.<\/td><\/tr><\/tbody><\/table>\n\n\n<\/div>\nHow to initialize RDK Logger<\/h3>\n\n- rdk_logger_init() loads entries from “debug.ini” and initializes log4c.<\/li>\n
- Sets log level of the module corresponding to environment variables.<\/li>\n
- Sets log level to default log levels, for the modules not having entries in configuration file. (Currently it is set as LOG.RDK.DEFAULT = ERROR<\/strong> in debug.ini)<\/li>\n<\/ul>\n
How to add the logger functionality to the new module?<\/h3>\n
Include rdk_debug.h header file and make use of RDK_LOG for printing logs. Initialize RDK Logger by calling rdk_logger_init() in the respective module\/component. Build new module\/component by linking “librdkloggers.so” along with “liblog4c.so” and “libglib-2.0.so” shared object.<\/p>\n
Example: -lrdkloggers -L ..\/opensource\/lib -llog4c -lglib-2.0<\/p>\n
RDK Logger Usage Format<\/h3>\n
RDK_LOG (rdk_LogLevel level, const char *module, const char *format,…)<\/p>\n
\n- “level” is Log level of the log message (FATAL, ERROR etc). Apart from this there are special log levels like ALL, NONE, TRACE, !TRACE are supported.<\/li>\n
- “module” is the Module to which this message belongs to (Use module name same as mentioned in debug.ini)<\/li>\n
- “format” is a printf style string containing the log message.<\/li>\n<\/ul>\n
All the RDK components logs are stored under \/opt\/log\/ with a naming convention <RDK component>=””>_log.txt.
For example, \/opt\/log\/pod_log.txt includes all events logged by POD Manager module.<\/p>\n
Sample code for Logging<\/strong><\/p>\nFor example, add a debug messages for “INBSI” module<\/p>\n
RDK_LOG (RDK_LOG_NOTICE, “LOG.RDK.INBSI”,”<%s: %s>: Sending PMT_ACQUIRED eventn”, PSIMODULE, __FUNCTION__);<\/p>\n
User needs to provide the module name “LOG.RDK.INBSI”, which is the same as mentioned in debug.ini<\/p>\n
$ cat debug.ini
EnableMPELog = TRUE
LOG.RDK.INBSI = ALL FATAL ERROR WARNING NOTICE INFO DEBUG<\/p>\n
Sample logging output<\/h3>\n
131011-21:21:49.578394 [mod=INBSI, lvl=NOTICE] [tid=4141] <SITP_PSI: NotifyTableChanged>: Sending PMT_ACQUIRED event<\/p>\n
In this way, user make use of the RDK logger in the respective modules and control the logging levels through configuration file. Here, No need to build RDK logger again for the addition of new components\/module.<\/p>\n
How to use logging in G-Streamer<\/h3>\n
A callback function gst_debug_add_log_function() is registered to receive GStreamer logs. Logs are converted to RDK logs in callback function. RMF element which controls a gst-element shall register element name and corresponding log module using<\/p>\n
void RMF_registerGstElementDbgModule(char *gst_module, char *rmf_module)<\/p>\n
Callback function uses this information to get module names corresponding to gstreamer logs.<\/p>\n
RDK Logging Configuration<\/h3>\n
Default level for RDK logging is ERROR and logging settings are configured in \/etc\/debug.ini. <\/strong>RDK components reads the configuration details from config file at the beginning.<\/p>\nLOG.RDK.<component1> = FATAL ERROR WARNING NOTICE INFO
LOG.RDK.<component2> = FATAL ERROR WARNING NOTICE INFO DEBUG<\/p>\n
For Example:<\/strong><\/p>\nLOG.RDK.UI = NONE
LOG.RDK.QAMSRC = ALL FATAL ERROR
LOG.RDK.VODSRC = ALL FATAL ERROR WARNING NOTICE INFO
LOG.RDK.MS = ALL FATAL ERROR WARNING INFO
LOG.RDK.GSTQAM = ALL FATAL ERROR WARNING INFO
LOG.RDK.IPPV = ALL FATAL ERROR WARNING NOTICE INFO
LOG.RDK.RMFBASE = FATAL ERROR WARNING INFO
LOG.RDK.TRM = ALL FATAL ERROR WARNING NOTICE INFO<\/p>\n
Which path logs are stored<\/h3>\n
By default, stdout is redirected to \/opt\/logs\/ocapri_log.txt<\/strong> for OCAP RI related logs. <\/p>\nRDK Log upload Process<\/h3>\n
Logs are uploaded to servers in following scenarios<\/p>\n
Architecture<\/h3>\n<\/p>\n
<\/p>\n
Log4c – Introduction & Terminology:<\/h3>\n\n- Framework which provides the capability to log messages in a variety of formats to console or local file<\/li>\n
- Configuration – Log4c can be configured using a configuration file\n
\n- log4crc keeps configurations in xml format<\/li>\n
- Configurations can be provided for modules, sub modules etc.<\/li>\n<\/ul>\n<\/li>\n
- Loggers – Named log message destinations which are known to applications.<\/li>\n
- Appenders – Responsible for delivering LogEvents to their destination.<\/li>\n
- Layouts & Filters determine how the message is formatted & filter the messages according to the configuration.<\/li>\n<\/ul>\n
Logging Levels supported by RDK Logger<\/h3>\n\n\n\nCode<\/th> Description<\/th><\/tr> RDK_LOG_FATAL<\/td> Any error that is forcing a shutdown of the service or application to prevent data loss (or further data loss), reserve these only for the most heinous errors and situations where there is guaranteed to have been data corruption or loss.<\/td><\/tr> RDK_LOG_ERROR<\/td> Any error which is fatal to the operation but not the service (cant open a file, missing data, etc)<\/td><\/tr> RDK_LOG_WARN<\/td> Anything that can potentially cause application oddities, but for which the application automatically recovering.<\/td><\/tr> RDK_LOG_NOTICE<\/td> Anything that largely superfluous for application-level logging.<\/td><\/tr> RDK_LOG_INFO<\/td> Generally useful information to log (service start\/stop, configuration assumptions, etc).<\/td><\/tr> RDK_LOG_DEBUG<\/td> Information that is diagnostically helpful to people more than just developers.<\/td><\/tr> RDK_LOG_TRACE1,<\/p>
RDK_LOG_TRACE2,…<\/p><\/td>
Only when it would be “tracing” the code and trying to find one part of a function specifically.<\/td><\/tr><\/tbody><\/table>\n\n\n<\/div>\nHow to initialize RDK Logger<\/h3>\n\n- rdk_logger_init() loads entries from “debug.ini” and initializes log4c.<\/li>\n
- Sets log level of the module corresponding to environment variables.<\/li>\n
- Sets log level to default log levels, for the modules not having entries in configuration file. (Currently it is set as LOG.RDK.DEFAULT = ERROR<\/strong> in debug.ini)<\/li>\n<\/ul>\n
How to add the logger functionality to the new module?<\/h3>\n
Include rdk_debug.h header file and make use of RDK_LOG for printing logs. Initialize RDK Logger by calling rdk_logger_init() in the respective module\/component. Build new module\/component by linking “librdkloggers.so” along with “liblog4c.so” and “libglib-2.0.so” shared object.<\/p>\n
Example: -lrdkloggers -L ..\/opensource\/lib -llog4c -lglib-2.0<\/p>\n
RDK Logger Usage Format<\/h3>\n
RDK_LOG (rdk_LogLevel level, const char *module, const char *format,…)<\/p>\n
\n- “level” is Log level of the log message (FATAL, ERROR etc). Apart from this there are special log levels like ALL, NONE, TRACE, !TRACE are supported.<\/li>\n
- “module” is the Module to which this message belongs to (Use module name same as mentioned in debug.ini)<\/li>\n
- “format” is a printf style string containing the log message.<\/li>\n<\/ul>\n
All the RDK components logs are stored under \/opt\/log\/ with a naming convention <RDK component>=””>_log.txt.
For example, \/opt\/log\/pod_log.txt includes all events logged by POD Manager module.<\/p>\n
Sample code for Logging<\/strong><\/p>\nFor example, add a debug messages for “INBSI” module<\/p>\n
RDK_LOG (RDK_LOG_NOTICE, “LOG.RDK.INBSI”,”<%s: %s>: Sending PMT_ACQUIRED eventn”, PSIMODULE, __FUNCTION__);<\/p>\n
User needs to provide the module name “LOG.RDK.INBSI”, which is the same as mentioned in debug.ini<\/p>\n
$ cat debug.ini
EnableMPELog = TRUE
LOG.RDK.INBSI = ALL FATAL ERROR WARNING NOTICE INFO DEBUG<\/p>\n
Sample logging output<\/h3>\n
131011-21:21:49.578394 [mod=INBSI, lvl=NOTICE] [tid=4141] <SITP_PSI: NotifyTableChanged>: Sending PMT_ACQUIRED event<\/p>\n
In this way, user make use of the RDK logger in the respective modules and control the logging levels through configuration file. Here, No need to build RDK logger again for the addition of new components\/module.<\/p>\n
How to use logging in G-Streamer<\/h3>\n
A callback function gst_debug_add_log_function() is registered to receive GStreamer logs. Logs are converted to RDK logs in callback function. RMF element which controls a gst-element shall register element name and corresponding log module using<\/p>\n
void RMF_registerGstElementDbgModule(char *gst_module, char *rmf_module)<\/p>\n
Callback function uses this information to get module names corresponding to gstreamer logs.<\/p>\n
RDK Logging Configuration<\/h3>\n
Default level for RDK logging is ERROR and logging settings are configured in \/etc\/debug.ini. <\/strong>RDK components reads the configuration details from config file at the beginning.<\/p>\nLOG.RDK.<component1> = FATAL ERROR WARNING NOTICE INFO
LOG.RDK.<component2> = FATAL ERROR WARNING NOTICE INFO DEBUG<\/p>\n
For Example:<\/strong><\/p>\nLOG.RDK.UI = NONE
LOG.RDK.QAMSRC = ALL FATAL ERROR
LOG.RDK.VODSRC = ALL FATAL ERROR WARNING NOTICE INFO
LOG.RDK.MS = ALL FATAL ERROR WARNING INFO
LOG.RDK.GSTQAM = ALL FATAL ERROR WARNING INFO
LOG.RDK.IPPV = ALL FATAL ERROR WARNING NOTICE INFO
LOG.RDK.RMFBASE = FATAL ERROR WARNING INFO
LOG.RDK.TRM = ALL FATAL ERROR WARNING NOTICE INFO<\/p>\n
Which path logs are stored<\/h3>\n
By default, stdout is redirected to \/opt\/logs\/ocapri_log.txt<\/strong> for OCAP RI related logs. <\/p>\nRDK Log upload Process<\/h3>\n
Logs are uploaded to servers in following scenarios<\/p>\n
- \n
- log4crc keeps configurations in xml format<\/li>\n
- Configurations can be provided for modules, sub modules etc.<\/li>\n<\/ul>\n<\/li>\n
- Loggers – Named log message destinations which are known to applications.<\/li>\n
- Appenders – Responsible for delivering LogEvents to their destination.<\/li>\n
- Layouts & Filters determine how the message is formatted & filter the messages according to the configuration.<\/li>\n<\/ul>\n
Logging Levels supported by RDK Logger<\/h3>\n
\n\n\n<\/colgroup> Code<\/th> Description<\/th><\/tr> RDK_LOG_FATAL<\/td> Any error that is forcing a shutdown of the service or application to prevent data loss (or further data loss), reserve these only for the most heinous errors and situations where there is guaranteed to have been data corruption or loss.<\/td><\/tr> RDK_LOG_ERROR<\/td> Any error which is fatal to the operation but not the service (cant open a file, missing data, etc)<\/td><\/tr> RDK_LOG_WARN<\/td> Anything that can potentially cause application oddities, but for which the application automatically recovering.<\/td><\/tr> RDK_LOG_NOTICE<\/td> Anything that largely superfluous for application-level logging.<\/td><\/tr> RDK_LOG_INFO<\/td> Generally useful information to log (service start\/stop, configuration assumptions, etc).<\/td><\/tr> RDK_LOG_DEBUG<\/td> Information that is diagnostically helpful to people more than just developers.<\/td><\/tr> RDK_LOG_TRACE1,<\/p>
RDK_LOG_TRACE2,…<\/p><\/td>
Only when it would be “tracing” the code and trying to find one part of a function specifically.<\/td><\/tr><\/tbody><\/table>\n\n\n<\/div>\n How to initialize RDK Logger<\/h3>\n
- \n
- rdk_logger_init() loads entries from “debug.ini” and initializes log4c.<\/li>\n
- Sets log level of the module corresponding to environment variables.<\/li>\n
- Sets log level to default log levels, for the modules not having entries in configuration file. (Currently it is set as LOG.RDK.DEFAULT = ERROR<\/strong> in debug.ini)<\/li>\n<\/ul>\n
How to add the logger functionality to the new module?<\/h3>\n
Include rdk_debug.h header file and make use of RDK_LOG for printing logs. Initialize RDK Logger by calling rdk_logger_init() in the respective module\/component. Build new module\/component by linking “librdkloggers.so” along with “liblog4c.so” and “libglib-2.0.so” shared object.<\/p>\n
Example: -lrdkloggers -L ..\/opensource\/lib -llog4c -lglib-2.0<\/p>\n
RDK Logger Usage Format<\/h3>\n
RDK_LOG (rdk_LogLevel level, const char *module, const char *format,…)<\/p>\n
- \n
- “level” is Log level of the log message (FATAL, ERROR etc). Apart from this there are special log levels like ALL, NONE, TRACE, !TRACE are supported.<\/li>\n
- “module” is the Module to which this message belongs to (Use module name same as mentioned in debug.ini)<\/li>\n
- “format” is a printf style string containing the log message.<\/li>\n<\/ul>\n
All the RDK components logs are stored under \/opt\/log\/ with a naming convention <RDK component>=””>_log.txt.
For example, \/opt\/log\/pod_log.txt includes all events logged by POD Manager module.<\/p>\nSample code for Logging<\/strong><\/p>\n
For example, add a debug messages for “INBSI” module<\/p>\n
RDK_LOG (RDK_LOG_NOTICE, “LOG.RDK.INBSI”,”<%s: %s>: Sending PMT_ACQUIRED eventn”, PSIMODULE, __FUNCTION__);<\/p>\n
User needs to provide the module name “LOG.RDK.INBSI”, which is the same as mentioned in debug.ini<\/p>\n
$ cat debug.ini
EnableMPELog = TRUE
LOG.RDK.INBSI = ALL FATAL ERROR WARNING NOTICE INFO DEBUG<\/p>\nSample logging output<\/h3>\n
131011-21:21:49.578394 [mod=INBSI, lvl=NOTICE] [tid=4141] <SITP_PSI: NotifyTableChanged>: Sending PMT_ACQUIRED event<\/p>\n
In this way, user make use of the RDK logger in the respective modules and control the logging levels through configuration file. Here, No need to build RDK logger again for the addition of new components\/module.<\/p>\n
How to use logging in G-Streamer<\/h3>\n
A callback function gst_debug_add_log_function() is registered to receive GStreamer logs. Logs are converted to RDK logs in callback function. RMF element which controls a gst-element shall register element name and corresponding log module using<\/p>\n
void RMF_registerGstElementDbgModule(char *gst_module, char *rmf_module)<\/p>\n
Callback function uses this information to get module names corresponding to gstreamer logs.<\/p>\n
RDK Logging Configuration<\/h3>\n
Default level for RDK logging is ERROR and logging settings are configured in \/etc\/debug.ini. <\/strong>RDK components reads the configuration details from config file at the beginning.<\/p>\n
LOG.RDK.<component1> = FATAL ERROR WARNING NOTICE INFO
LOG.RDK.<component2> = FATAL ERROR WARNING NOTICE INFO DEBUG<\/p>\nFor Example:<\/strong><\/p>\n
LOG.RDK.UI = NONE
LOG.RDK.QAMSRC = ALL FATAL ERROR
LOG.RDK.VODSRC = ALL FATAL ERROR WARNING NOTICE INFO
LOG.RDK.MS = ALL FATAL ERROR WARNING INFO
LOG.RDK.GSTQAM = ALL FATAL ERROR WARNING INFO
LOG.RDK.IPPV = ALL FATAL ERROR WARNING NOTICE INFO
LOG.RDK.RMFBASE = FATAL ERROR WARNING INFO
LOG.RDK.TRM = ALL FATAL ERROR WARNING NOTICE INFO<\/p>\nWhich path logs are stored<\/h3>\n
By default, stdout is redirected to \/opt\/logs\/ocapri_log.txt<\/strong> for OCAP RI related logs. <\/p>\n
RDK Log upload Process<\/h3>\n
Logs are uploaded to servers in following scenarios<\/p>\n
![](\"\/wp-content\/uploads\/sites\/16\/2023\/09\/RDK%20Log%20upload%20Process.drawio.png\")
<\/p>\n