Merge pull request #1091 from PhilipDeegan/no_logs

high rank run produce less logs by default

Author: nicolasaunai

pyphare/pyphare/pharein/simulation.py

@@ -730,9 +730,9 @@ def wrapper(simulation_object, **kwargs):
         kwargs["dry_run"] = kwargs.get(
             "dry_run", os.environ.get("PHARE_DRY_RUN", "0") == "1"
         )
-        kwargs["write_reports"] = kwargs.get(  # on by default except for tests
-            "write_reports", os.environ.get("PHARE_TESTING", "0") != "1"
-        )
+
+        # is per rank, not per node (yet)
+        kwargs["write_reports"] = kwargs.get("write_reports", False)
 
         return func(simulation_object, **kwargs)
 

pyphare/pyphare/simulator/simulator.py

@@ -298,12 +298,13 @@ def _log_to_file(self):
         Support keys:
             RANK_FILES - logfile per rank
             DATETIME_FILES - logfile with starting datetime timestamp per rank
-            NONE - no logging files, display to cout
+            CLI  - no logging files, display to cout
+            NULL - no logging files, no cout
         """
-
-        if "PHARE_LOG" not in os.environ:
-            os.environ["PHARE_LOG"] = "RANK_FILES"
         from pyphare.cpp import cpp_lib
 
-        if os.environ["PHARE_LOG"] != "NONE" and cpp_lib().mpi_rank() == 0:
+        logging = os.environ["PHARE_LOG"] = os.environ.get("PHARE_LOG", "RANK_FILES")
+        need_log_dir = logging != "CLI" and logging != "NULL"
+        if need_log_dir and cpp_lib().mpi_rank() == 0:
             Path(".log").mkdir(exist_ok=True)
+        cpp_lib().mpi_barrier()

res/cmake/def.cmake

@@ -163,7 +163,6 @@ if (test AND ${PHARE_EXEC_LEVEL_MIN} GREATER 0) # 0 = no tests
     set_property(TEST ${binary}        PROPERTY ENVIRONMENT "PYTHONPATH=${PHARE_PYTHONPATH}")
     # ASAN detects leaks by default, even in system/third party libraries
     set_property(TEST ${binary} APPEND PROPERTY ENVIRONMENT "ASAN_OPTIONS=detect_leaks=0")
-    set_property(TEST ${binary} APPEND PROPERTY ENVIRONMENT PHARE_TESTING=1 )
   endfunction(set_exe_paths_)
 
   function(add_phare_test_ binary directory)

src/core/logger.hpp

@@ -12,7 +12,7 @@ namespace PHARE
 constexpr static std::uint8_t LOG_LEVEL = PHARE_LOG_LEVEL;
 }
 
-#if !defined(NDEBUG) || defined(PHARE_FORCE_DEBUG_DO)
+#if !defined(NDEBUG) || defined(PHARE_FORCE_DEBUG_DO) || defined(PHARE_FORCE_LOG_LINE)
 #define PHARE_LOG_LINE_STR(str)                                                                    \
     std::cout << __FILE__ << ":" << __LINE__ << " - " << str << std::endl;
 #define PHARE_LOG_LINE_SS(s) PHARE_LOG_LINE_STR((std::stringstream{} << s).str());

src/simulator/simulator.hpp

@@ -123,32 +123,37 @@ class Simulator : public ISimulator
 private:
     auto find_model(std::string name);
 
-    auto static log_file_name()
+    std::unique_ptr<std::ofstream> static log_file()
     {
-        // ".log" directory is not created here, but in python if PHARE_LOG != "NONE"
+        // ".log" directory is not created here, but in simulator.py
         if (auto log = core::get_env("PHARE_LOG"))
         {
             if (log == "RANK_FILES")
-                return ".log/" + std::to_string(core::mpi::rank()) + ".out";
+                return std::make_unique<std::ofstream>(".log/" + std::to_string(core::mpi::rank())
+                                                       + ".out");
 
 
             if (log == "DATETIME_FILES")
             {
                 auto date_time = core::mpi::date_time();
                 auto rank      = std::to_string(core::mpi::rank());
                 auto size      = std::to_string(core::mpi::size());
-                return ".log/" + date_time + "_" + rank + "_of_" + size + ".out";
+                return std::make_unique<std::ofstream>(".log/" + date_time + "_" + rank + "_of_"
+                                                       + size + ".out");
             }
 
-            if (log != "NONE")
+            if (log == "NULL")
+                return std::make_unique<std::ofstream>("/dev/null");
+
+            if (log != "CLI")
                 throw std::runtime_error(
-                    "PHARE_LOG invalid type, valid keys are RANK_FILES/DATETIME_FILES/NONE");
+                    "PHARE_LOG invalid type, valid keys are RANK_FILES/DATETIME_FILES/CLI/NULL");
         }
 
-        return std::string{""}; // unused
+        return nullptr;
     }
 
-    std::ofstream log_out{log_file_name()};
+    std::unique_ptr<std::ofstream> log_out{log_file()};
     std::streambuf* coutbuf = nullptr;
     std::shared_ptr<PHARE::amr::Hierarchy> hierarchy_;
     std::unique_ptr<Integrator> integrator_;
@@ -196,13 +201,13 @@ class Simulator : public ISimulator
 
 namespace
 {
-    inline auto logging(std::ofstream& log_out)
+    inline auto logging(std::unique_ptr<std::ofstream>& log_out)
     {
         std::streambuf* buf = nullptr;
-        if (auto log = core::get_env("PHARE_LOG"); log != "NONE")
+        if (log_out)
         {
             buf = std::cout.rdbuf();
-            std::cout.rdbuf(log_out.rdbuf());
+            std::cout.rdbuf(log_out->rdbuf());
         }
         return buf;
     }