Merge pull request #1390 from LLNL/feature/white238/split_slic_rank_and_rank_count

Split RANK_COUNT out of RANK in SLIC message formatting

Author: white238

RELEASE-NOTES.md

@@ -65,6 +65,8 @@ The Axom project release numbers follow [Semantic Versioning](http://semver.org/
   external `fmt` and axom's vendored copy.
 - Turn off CMake finding dependencies on system paths.
 - `axom::Array`: trivially-copyable types with a non-trivial constructor are now initialized on the GPU.
+- SLIC no longer outputs the rank count in the `RANK` format string in parallel loggers. You can access
+  the rank count via new format option `RANK_COUNT`.
 
 ### Removed
 - Removes config option `AXOM_ENABLE_ANNOTATIONS`. Annotations are now provided by `caliper` 

src/axom/slic/core/LogStream.cpp

@@ -69,6 +69,7 @@ std::string LogStream::getFormatedMessage(const std::string& msgLevel,
                                           const std::string& message,
                                           const std::string& tagName,
                                           const std::string& rank,
+                                          const std::string& rank_count,
                                           const std::string& fileName,
                                           int line)
 {
@@ -79,6 +80,7 @@ std::string LogStream::getFormatedMessage(const std::string& msgLevel,
   this->replaceKey(msg, "<TAG>", tagName);
   this->replaceKey(msg, "<FILE>", fileName);
   this->replaceKey(msg, "<RANK>", rank);
+  this->replaceKey(msg, "<RANK_COUNT>", rank_count);
 
   if(line != MSG_IGNORE_LINE)
   {

src/axom/slic/core/LogStream.hpp

@@ -58,7 +58,8 @@ class LogStream
    *    <li> <TAG> user-supplied tag </li>
    *    <li> <FILE> with the filename </li>
    *    <li> <LINE> with the line number </li>
-   *    <li> <LINE> with the MPI rank </li>
+   *    <li> <RANK> with the MPI rank(s) </li>
+   *    <li> <RANK_COUNT> with the number of MPI ranks </li>
    *    <li> <TIMESTAMP> date/time the message is logged </li>
    *  </ul>
    *
@@ -73,6 +74,7 @@ class LogStream
    *         std::string( "* FILE=<FILE>\n" ) +
    *         std::string( "* LINE=<LINE>\n" ) +
    *         std::string( "* RANK=<RANK>\n" ) +
+   *         std::string( "* RANK_COUNT=<RANK_COUNT>\n" ) +
    *         std::string( "***********************************\n" );
    * \endcode
    */
@@ -151,6 +153,8 @@ class LogStream
    * \param [in] tagName user-supplied tag, may be MSG_IGNORE_TAG
    * \param [in] fileName filename where this message is logged, may be
    *  MSG_IGNORE_FILE to ignore this field.
+   * \param [in] rank The MPI rank(s) that emitted this message
+   * \param [in] rank_count the number of MPI ranks that emitted this message
    * \param [in] line the line number within the file where the message is
    *  logged. Likewise, may be set to MSG_IGNORE_LINE to ignore this field.
    *
@@ -161,6 +165,7 @@ class LogStream
                                  const std::string& message,
                                  const std::string& tagName,
                                  const std::string& rank,
+                                 const std::string& rank_count,
                                  const std::string& fileName,
                                  int line);
 

src/axom/slic/docs/sphinx/sections/architecture.rst

@@ -151,8 +151,14 @@ The list of keywords is summarized in the table below.
 | **<TAG>**           | A string tag associated with a given message, e.g., for|
 |                     | filtering during post-processing, etc.                 |
 +---------------------+--------------------------------------------------------+
-| **<RANK>**          | The MPI rank that emitted the message. Only applicable |
-|                     | when the `Axom Toolkit`_ is compiled with MPI enabled  |
+| **<RANK>**          | The MPI rank(s) that emitted the message.              |
+|                     | Only applicable when Axom is compiled with MPI enabled |
+|                     | and with MPI-aware :ref:`LogStream` instances, such as,|
+|                     | the :ref:`SynchronizedStream` and                      |
+|                     | :ref:`LumberjackStream`.                               |
++---------------------+--------------------------------------------------------+
+| **<RANK_COUNT>**    | The number of MPI ranks that emitted the message.      |
+|                     | Only applicable when Axom is compiled with MPI enabled |
 |                     | and with MPI-aware :ref:`LogStream` instances, such as,|
 |                     | the :ref:`SynchronizedStream` and                      |
 |                     | :ref:`LumberjackStream`.                               |
@@ -221,7 +227,7 @@ Generic Output Stream
 The :ref:`GenericOutputStream`, is a concrete implementation of the
 :ref:`LogStream` base class, that can be constructed by specifying:
 
-#. A C++ ``std::ostream`` object instance, e.g., ``std::cout`, ``std::cerr`` for
+#. A C++ ``std::ostream`` object instance, e.g., ``std::cout``, ``std::cerr`` for
    console output, or to a file by passing a C++ ``std::ofstream`` object, and,
 
 #. Optionally, a string that specifies the :ref:`logMessageFormat`.
@@ -423,12 +429,13 @@ The ``MyStream`` class implements the ``LogStream::append()`` method of the
                           int line,
                           bool AXOM_UNUSED_PARAM(filtered_duplicates) )
    {
-      assert( m_stream != nillptr );
+      assert( m_stream != nullptr );
 
       (*m_stream) << this->getFormatedMessage( message::getLevelAsString(msgLevel),
                                                message,
                                                tagName,
                                                "",
+                                               "",
                                                fileName,
                                                line );
    }

src/axom/slic/examples/basic/lumberjack_logging.cpp

@@ -39,10 +39,15 @@ int main(int argc, char** argv)
   MPI_Comm_rank(MPI_COMM_WORLD, &rank);
 
   // Initialize SLIC
-  std::string format = std::string("<MESSAGE>\n") +
-    std::string("\t<TIMESTAMP>\n") + std::string("\tLEVEL=<LEVEL>\n") +
-    std::string("\tRANKS=<RANK>\n") + std::string("\tFILE=<FILE>\n") +
-    std::string("\tLINE=<LINE>\n");
+  constexpr const char* format = R"(
+<MESSAGE>
+\t<TIMESTAMP>
+\tLEVEL=<LEVEL>
+\tRANKS=<RANK>
+\tRANK_COUNT=<RANK_COUNT>
+\tFILE=<FILE>
+\tLINE=<LINE>
+)";
   slic::initialize();
 
   // Set SLIC logging level and Lumberjack Logging stream

src/axom/slic/streams/GenericOutputStream.cpp

@@ -74,6 +74,7 @@ void GenericOutputStream::append(message::Level msgLevel,
                                           message,
                                           tagName,
                                           "",
+                                          "",
                                           fileName,
                                           line);
 }

src/axom/slic/streams/LumberjackStream.cpp

@@ -139,22 +139,22 @@ void LumberjackStream::write(bool local)
 
   if(m_lj->isOutputNode() || local)
   {
-    std::vector<axom::lumberjack::Message*> messages = m_lj->getMessages();
-
-    const int nmessages = static_cast<int>(messages.size());
-    std::string rankString;
-    for(int i = 0; i < nmessages; ++i)
+    for(const auto* curr_message : m_lj->getMessages())
     {
-      rankString = std::to_string(messages[i]->count()) + ": " +
-        messages[i]->stringOfRanks();
+      if(curr_message == nullptr)
+      {
+        continue;
+      }
+
       (*m_stream) << this->getFormatedMessage(
         message::getLevelAsString(
-          static_cast<message::Level>(messages[i]->level())),
-        messages[i]->text(),
-        messages[i]->tag(),
-        rankString,
-        messages[i]->fileName(),
-        messages[i]->lineNumber());
+          static_cast<message::Level>(curr_message->level())),
+        curr_message->text(),
+        curr_message->tag(),
+        curr_message->stringOfRanks(),
+        std::to_string(curr_message->count()),
+        curr_message->fileName(),
+        curr_message->lineNumber());
     }
 
     m_stream->flush();

src/axom/slic/streams/SynchronizedStream.cpp

@@ -92,6 +92,7 @@ void SynchronizedStream::append(message::Level msgLevel,
                              message,
                              tagName,
                              std::to_string(rank),
+                             "1",
                              fileName,
                              line));
 }