...
This page lists the Guidelines that must be used when creating new application logs.
"Relevant Logs" are defined as the logs that are especially interesting for a CDAP User and would help the User to quickly assess the progress or debug any failures in the application. More detailed guidelines for "Relevant Logs" are as following:
...
1. Any logs generated directly from within the Plugin code are always included.
2. Logs generated from within user scripts [javascript and python] from certain plugins that allow them are also considered relevant User Logs.
3. Logs from libraries used by the Plugins [CDAP or Otherwise] are not included. [Ideally, underlying libraries should not generate logs at all, any errors are expected to be thrown as exceptions]
...
b. Follow Error guideline[below] and update the message appropriately.
5. Since all logs generated from within the Plugin are shown visible to the user, they must follow strict guidelines:
...
6. When Pipeline User is writing his/her own plugin, all logs generated will be shown included because of #1. #5 above is mainly for internally-developed Plugins like the ones available on Market, although is generally applicable.
...
4. Since all logs generated from the Application Programs are shown in the condensed viewconsidered relevant, they must follow strict guidelines:
...
5. When Application User is writing his/her own application, all logs generated will be shown because of #1. #4 above is mainly for internally-developed Applications like the ones available on Market, although is generally applicable.
CDAP Platform:
User is only shown logs from Only include the System that are helpful for User in debugging the pipelinePipeline/Application:
1. Pipeline Lifecycle Info: Logs reflecting the execution of the complete Pipeline: start and finish [with success or failure]
...