Fix GitHub Issue #6: Add option to use a microsecond timestamp

Author: juzzlin

CHANGELOG

@@ -1,3 +1,11 @@
+1.3.0
+=====
+
+New features:
+
+* Fix GitHub Issue #6: Add option to use a microsecond timestamp
+  - More generic setTimestampMode() replaces enableDateTime()
+
 1.2.0 - "Thread-safe Taco"
 ==========================
 

README.md

@@ -7,7 +7,7 @@ Looking for a simple logger for your C++ project? `SimpleLogger` might be for yo
 
 * Based on RAII
 * Configurable level symbols
-* Date / time
+* Datetime / EPOCH timestamps
 * Logging levels: `Trace`, `Debug`, `Info`, `Warning`, `Error`, `Fatal`
 * Log to file and/or console
 * Thread-safe
@@ -46,7 +46,7 @@ L().info() << "Something happened";
 
 Outputs something like this:
 
-`[Sat Oct 13 22:38:42 2018] I: Something happened`
+`Sat Oct 13 22:38:42 2018 I: Something happened`
 
 ## Log to file and console
 
@@ -69,7 +69,7 @@ L::enableEchoMode(false);
 L().info() << "Something happened";
 ```
 
-## Set logging level 
+## Set logging level
 
 ```
 using juzzlin::L;
@@ -82,9 +82,9 @@ L().debug() << "A debug thing happened";
 
 Outputs something like this:
 
-`[Sat Oct 13 22:38:42 2018] I: Something happened`
+`Sat Oct 13 22:38:42 2018 I: Something happened`
 
-`[Sat Oct 13 22:38:42 2018] D: A debug thing happened`
+`Sat Oct 13 22:38:42 2018 D: A debug thing happened`
 
 ## Set custom level symbols
 
@@ -99,7 +99,23 @@ L().debug() << "A debug thing happened";
 
 Outputs something like this:
 
-`[Sat Oct 13 22:38:42 2018] <DEBUG> A debug thing happened`
+`Sat Oct 13 22:38:42 2018 <DEBUG> A debug thing happened`
+
+## Set timestamp mode and optional custom separator
+
+Possible modes: `None`, `EpochSeconds`, `EpochMilliseconds`, `EpochMicroseconds`, `DateTime`.
+
+```
+using juzzlin::L;
+
+L::setTimestampMode(L::TimestampMode::EpochMilliseconds, " ## ");
+
+L().info() << "Something happened";
+```
+
+Outputs something like this:
+
+`1562955750677 ## I: Something happened`
 
 # Requirements
 

src/simple_logger.cpp

@@ -59,28 +59,30 @@ class Logger::Impl
 
     static void enableEchoMode(bool enable);
 
-    static void enableDateTime(bool enable);
-
     static void setLevelSymbol(Logger::Level level, std::string symbol);
 
     static void setLoggingLevel(Logger::Level level);
 
+    static void setTimestampMode(Logger::TimestampMode timestampMode, std::string separator);
+
     static void init(std::string filename, bool append);
 
     void flush();
 
     std::ostringstream & getStream(Logger::Level level);
 
-    void prefixDateTime();
+    void prefixTimestamp();
 
 private:
 
     static bool m_echoMode;
 
-    static bool m_dateTime;
-
     static Logger::Level m_level;
 
+    static Logger::TimestampMode m_timestampMode;
+
+    static std::string m_timestampSeparator;
+
     static std::ofstream m_fout;
 
     using SymbolMap = std::map<Logger::Level, std::string>;
@@ -98,10 +100,12 @@ class Logger::Impl
 
 bool Logger::Impl::m_echoMode = true;
 
-bool Logger::Impl::m_dateTime = true;
-
 Logger::Level Logger::Impl::m_level = Logger::Level::Info;
 
+Logger::TimestampMode Logger::Impl::m_timestampMode = Logger::TimestampMode::DateTime;
+
+std::string Logger::Impl::m_timestampSeparator = ": ";
+
 std::ofstream Logger::Impl::m_fout;
 
 // Default level symbols
@@ -143,15 +147,10 @@ void Logger::Impl::enableEchoMode(bool enable)
     Impl::m_echoMode = enable;
 }
 
-void Logger::Impl::enableDateTime(bool enable)
-{
-    Impl::m_dateTime = enable;
-}
-
 std::ostringstream & Logger::Impl::getStream(Logger::Level level)
 {
     m_activeLevel = level;
-    Impl::prefixDateTime();
+    Impl::prefixTimestamp();
     m_oss << Impl::m_symbols[level] << " ";
     return m_oss;
 }
@@ -166,15 +165,45 @@ void Logger::Impl::setLoggingLevel(Logger::Level level)
     Impl::m_level = level;
 }
 
-void Logger::Impl::prefixDateTime()
+void Logger::Impl::setTimestampMode(TimestampMode timestampMode, std::string separator)
+{
+    Impl::m_timestampMode = timestampMode;
+    Impl::m_timestampSeparator = separator;
+}
+
+void Logger::Impl::prefixTimestamp()
 {
-    if (Impl::m_dateTime)
+    std::string timeStr;
+
+    using std::chrono::duration_cast;
+    using std::chrono::system_clock;
+
+    switch (Impl::m_timestampMode)
+    {
+    case Logger::TimestampMode::None:
+        break;
+    case Logger::TimestampMode::DateTime:
     {
         time_t rawTime;
         time(&rawTime);
-        std::string timeStr(ctime(&rawTime));
+        timeStr = ctime(&rawTime);
         timeStr.erase(timeStr.length() - 1);
-        m_oss << "[" << timeStr << "] ";
+    }
+        break;
+    case Logger::TimestampMode::EpochSeconds:
+        timeStr = std::to_string(duration_cast<std::chrono::seconds>(system_clock::now().time_since_epoch()).count());
+        break;
+    case Logger::TimestampMode::EpochMilliseconds:
+        timeStr = std::to_string(duration_cast<std::chrono::milliseconds>(system_clock::now().time_since_epoch()).count());
+        break;
+    case Logger::TimestampMode::EpochMicroseconds:
+        timeStr = std::to_string(duration_cast<std::chrono::microseconds>(system_clock::now().time_since_epoch()).count());
+        break;
+    }
+
+    if (!timeStr.empty())
+    {
+        m_oss << timeStr << m_timestampSeparator;
     }
 }
 
@@ -267,11 +296,6 @@ void Logger::enableEchoMode(bool enable)
     Impl::enableEchoMode(enable);
 }
 
-void Logger::enableDateTime(bool enable)
-{
-    Impl::enableDateTime(enable);
-}
-
 void Logger::setLoggingLevel(Level level)
 {
     Impl::setLoggingLevel(level);
@@ -282,6 +306,11 @@ void Logger::setLevelSymbol(Level level, std::string symbol)
     Impl::setLevelSymbol(level, symbol);
 }
 
+void Logger::setTimestampMode(TimestampMode timestampMode, std::string separator)
+{
+    Impl::setTimestampMode(timestampMode, separator);
+}
+
 std::ostringstream & Logger::trace()
 {
     return m_impl->trace();

src/simple_logger.hpp

@@ -57,6 +57,15 @@ class Logger
         Fatal
     };
 
+    enum class TimestampMode
+    {
+        None = 0,
+        DateTime,
+        EpochSeconds,
+        EpochMilliseconds,
+        EpochMicroseconds
+    };
+
     //! Constructor.
     Logger();
 
@@ -73,10 +82,6 @@ class Logger
     //! \param enable Echo everything if true. Default is false.
     static void enableEchoMode(bool enable);
 
-    //! Enable/disable date and time prefix.
-    //! \param enable Prefix with date and time if true. Default is true.
-    static void enableDateTime(bool enable);
-
     //! Set the logging level.
     //! \param level The minimum level. Default is Info.
     static void setLoggingLevel(Level level);
@@ -86,6 +91,11 @@ class Logger
     //! \param symbol The symbol outputted for the messages of this level.
     static void setLevelSymbol(Level level, std::string symbol);
 
+    //! Set/enable timestamp mode.
+    //! \param timestampMode Timestamp mode enumeration.
+    //! \param separator Separator string outputted after timestamp.
+    static void setTimestampMode(TimestampMode timestampMode, std::string separator = " ");
+
     //! Get stream to the trace log message.
     std::ostringstream & trace();
 

src/tests/hello_world/hello_world.cpp

@@ -41,10 +41,11 @@ int main(int, char **)
 
     L::init(logFile);
     L::enableEchoMode(true);
-    L::enableDateTime(true);
     L::setLoggingLevel(L::Level::Trace);
 
-    std::string message = "Hello, world!";
+    const std::string message = "Hello, world!";
+    const std::string timestampSeparator = " ## ";
+    L::setTimestampMode(L::TimestampMode::DateTime, timestampSeparator);
 
     L().trace() << message;
     L().debug() << message;
@@ -61,6 +62,7 @@ int main(int, char **)
     while (std::getline(fin, line))
     {
         assert(line.find(message) != std::string::npos);
+        assert(line.find(timestampSeparator) != std::string::npos);
         lines++;
     }