logging: Replace NOLOGGING #362

avdgrinten · 2019-07-01T11:12:38Z

As mentioned in #361 (comment), the current behavior of the -NOLOGGING processor definition (and the corresponding CMake option -DNETWORKIT_LOGGING=OFF) is problematic.

This PR fixes the issue by splitting the responsibilities of -DNOLOGGING into two parts:

NETWORKIT_QUIET_LOGGING sets the default log level to a new QUIET setting. This setting disables logging at run time. However, the logging calls are still compiled in and other log levels can explicitly be set at run time.
NETWORKIT_RELEASE_LOGGING disables the compilation of logging calls for TRACE and DEBUG levels. This option is automatically enabled in release mode but can also be manually enabled/disabled using the CMake option of the same name.

Library users who want to hide the logging functionaltiy of NetworKIT should now set -DNETWORKIT_QUIET_LOGGING (instead of -DNETWORKIT_LOGGING=OFF) during configuration.

manpen

While you're at it: To me it seems that the logger passes strings by value where we might want to have const refs. While SSO will deal with setLogLevel, the messages in log, logToTerminal should be const refs.

manpen · 2019-07-01T15:43:53Z

CMakeLists.txt

@@ -18,6 +18,7 @@ option(NETWORKIT_COVERAGE "Build with support for coverage" OFF)
 set(NETWORKIT_PYTHON "" CACHE STRING "Directory containing Python.h. Implies MONOLITH=TRUE")
 set(NETWORKIT_PYTHON_SOABI "" CACHE STRING "Platform specific file extension. Implies MONOLITH=TRUE")
 set(NETWORKIT_WITH_SANITIZERS "" CACHE STRING "Uses sanitizers during the compilation")
+set(NETWORKIT_RELEASE_LOGGING "AUTO" CACHE STRING "Do not compile log messages at levels TRACE or DEBUG")


Please add available values (AUTO|ON|OFF) to description.

Good point.

manpen · 2019-07-01T15:50:21Z

networkit/cpp/auxiliary/test/AuxGTest.cpp

@@ -37,7 +37,7 @@ class AuxGTest: public testing::Test{};

 TEST_F(AuxGTest, produceRandomIntegers) {
 	Aux::Random::setSeed(1, false);
-#if (LOG_LEVEL == LOG_LEVEL_TRACE)
+#ifndef NETWORKIT_RELEASE_LOGGING


It seems that a more CPPish way of achieving this would be to define a constexpr in Global.h and replace the preprocessor commands using CPP ifs. Any decent compiler will remove the unreachable code. Or am I missing something?

AFAICS the main use of the #ifdef is to prevent unused variable warnings when TRACE or DEBUG is compiled out. A if with constant argument will not help in this case as the dead code elimination will only be done in the compiler backend, after the unused variable warning has already been issued.

That being said, a lot of the code using the #if LOGLEVEL == [...] idiom is quite questionable. I decided to only do syntactical changes to LOG_LEVEL in this PR but we can definitely take another look at those cases after the PR is merged.

manpen · 2019-07-01T16:07:52Z

CMakeLists.txt

@@ -8,7 +8,7 @@ endif("${PROJECT_SOURCE_DIR}" STREQUAL "${PROJECT_BINARY_DIR}")
 # BUILD OPTIONS
 option(NETWORKIT_BUILD_CORE "Build NetworKit core library" ON)
 option(NETWORKIT_BUILD_TESTS "Build NetworKit C++ tests" OFF)
-option(NETWORKIT_LOGGING "Build with logging support" ON)


Should we first mark NETWORKIT_LOGGING as DEPREACTED and issue an error message hinting to the new options if it is ever set to OFF?

I am not sure if it's worthwhile to do this. The option is not used in any standard build (e.g., setup.py) and it is quite easy to adapt to the new option. If you think that it is worthwhile, I suggest to fail the build if the option is specified so that users are forced to adapt their builds.

manpen · 2019-07-01T16:15:00Z

networkit/cpp/auxiliary/Log.cpp

@@ -41,6 +43,8 @@ std::string getLogLevel() {
 		return "ERROR";
 	} else if (current == LogLevel::fatal) {
 		return "FATAL";
+	} else if (current == LogLevel::quiet) {


It seems that this if-block should be a switch-case

Makes sense.

While NOLOGGING utilized the C++ preprocessor to remove calls to logging functions at compile time, NETWORKIT_QUIET_LOGGING disables logging at runtime, *unless* users explicitely set a log level. We achieve this by introducing a new log level called QUIET. QUIET does not have corresponding logging functions; however, when the current log level is set to QUIET, no messages (of any level) are emitted.

Introduce a preprocessor definition that can be set to disable the compilation of logging calls for levels TRACE and DEBUG. Adjust CMakeLists.txt to automatically set this behavior in Release mode and introduce a configuration option NETWORKIT_RELEASE_LOGGING to control it. Using this option, users are still able to configure release builds with full logging (e.g., to verify that a new feature works correctly in release mode).

LOG_LEVEL is not really used anymore. Replace LOG_LEVEL >= TRACE and LOG_LEVEL >= DEBUG by !NETWORKIT_RELEASE_LOGGING.

NOLOGGING is not used anymore.

This avoids a copy when passing std::string objects from Impl::log() to logToTerminal() / logToFile().

Tidy up the code to use a switch instead of an if-chain.

avdgrinten · 2019-07-10T11:29:15Z

I rebased the patch series onto the current Dev branch. Comments have been addressed in the last 3 commits.

avdgrinten · 2019-07-10T14:38:54Z

The push failure has nothing to do with this PR (Travis seems to be confused?). The pr build succeeded.

manpen

LGTM 👍

avdgrinten · 2019-07-11T09:14:23Z

Thank you for the review.

manpen reviewed Jul 1, 2019

View reviewed changes

avdgrinten added 7 commits July 10, 2019 13:01

logging: Remove obsolete LOG_LEVEL definition

1c35e84

LOG_LEVEL is not really used anymore. Replace LOG_LEVEL >= TRACE and LOG_LEVEL >= DEBUG by !NETWORKIT_RELEASE_LOGGING.

gtest: Fix NOLOGGING message in gtest wrapper

01bd70e

NOLOGGING is not used anymore.

CMake: Describe options for NETWORKIT_RELEASE_LOGGING

835c75d

logging: Take strings by reference

b23729d

This avoids a copy when passing std::string objects from Impl::log() to logToTerminal() / logToFile().

logging: Refactor getLogLevel()

a5636f1

Tidy up the code to use a switch instead of an if-chain.

avdgrinten force-pushed the quiet-logging branch from 05cc5b9 to a5636f1 Compare July 10, 2019 11:28

avdgrinten requested a review from manpen July 11, 2019 07:50

manpen approved these changes Jul 11, 2019

View reviewed changes

avdgrinten merged commit 6059174 into networkit:Dev Jul 11, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

logging: Replace NOLOGGING #362

logging: Replace NOLOGGING #362

avdgrinten commented Jul 1, 2019

manpen left a comment

manpen Jul 1, 2019

avdgrinten Jul 1, 2019

manpen Jul 1, 2019

avdgrinten Jul 1, 2019

manpen Jul 1, 2019

avdgrinten Jul 1, 2019

manpen Jul 1, 2019

avdgrinten Jul 1, 2019

avdgrinten commented Jul 10, 2019

avdgrinten commented Jul 10, 2019 •

edited

Loading

manpen left a comment

avdgrinten commented Jul 11, 2019

logging: Replace NOLOGGING #362

logging: Replace NOLOGGING #362

Conversation

avdgrinten commented Jul 1, 2019

manpen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

avdgrinten commented Jul 10, 2019

avdgrinten commented Jul 10, 2019 • edited Loading

manpen left a comment

Choose a reason for hiding this comment

avdgrinten commented Jul 11, 2019

avdgrinten commented Jul 10, 2019 •

edited

Loading