/**
 *  Function which create debug log
 *
 * @param {String} stLogTittle - logger title
 * @param {String} stLogMessage - message
 */
function debugLogMaker(stLogTittle, stLogMessage) {
    if (BL_DEB_LOG_IS_ENABLED) {
        log.debug(stLogTittle, stLogMessage);
    }
}

Any idea why you'd create this function?

This is to control the debug loggin. If BL_DEB_LOG_IS_ENABLED is set to FALSE, this will not be logged.

What what is clear, I'm wondering about the why?

To easily turn on/off the debug logging.

But you can do that on the deployment record

That's true but I have seen similar implementations done for logging. That's why I know.

The script also executes for every action e.g. CREATE, EDIT, XEDIT etc.

I didn't know that about ACS, thanks for the insight.

Exactly that.

The check for Log levels on the Deployment record is done on the server side, thus every unguarded

log

method call is still submitted to the server, even if it is a lower level than what the Deployment states, so you still take a performance hit for that log call. An implementation like this prevents that.

Thanks @erictgrubaugh

So ACS did this for performance reasons. I am very impressed.

Wow, I did not know that. My scripts are full of debug level logs I never bothered to remove.

It is such that part of our code review standards are that all

debug()

logs must either be removed or upgraded to a higher level before it can be merged

I did an analysis once where I ran the scheduled script 3 times; 1st with debug logs, 2nd time with log level set to Error, 3rd time without any logs. The script ran fastest without any logs. With logs and log level set to Error didn't have any significant difference.

@erictgrubaugh If you remove all the debug logs, won't it make it hard to troubleshoot production issues?

You can add the logs back if there is a production issue. @rustyshackles I follow the same approach and remove all the logs.

Yes, it does make it harder.

Yes, it absolutely makes it harder, but we have some very time-sensitive operations that don't leave us any other choice.

As always, a tradeoff