mflogger Library - Version:3.1.3 - current time formatting and logging

Mumbleface logger - current time: formatting and logging

mflogger Library - Version:3.1.3

Please read 'COPYING' for license terms

To use in your code include the MFlogger header

#include <mflogger.h>

There are three classes: log, jsonlog & timestring

log - current time and info proveded saved to file
jsonlog - current time saved to file in json format
timestring - return formatted current time

e.g. log data to a file

mflogger::log loggingfile("/path/to/log/file.log");
loggingfile.logmessage("there is something fishy going on");
loggingfile.logmessage("Barracuda");

This will result in something like this in the log file

2024-11-01T07:24:35 there is something fishy going on
2024-11-01T07:24:36 Barracuda

e.g. log json data to a file

mflogger::jsonlog loggingfile("/path/to/log/file.log");
loggingfile.logjson("what's up", "there is something fishy going on", "info");
loggingfile.logjson("fish", "Barracuda", "oh no");

This will result in something like this in the log file

{"level":"info","timestamp":"2024-11-30T19:16:15,"what's up":"there is something fishy going on"}
{"level":"oh no","timestamp":"2024-11-30T19:16:15,"fish":"Barracuda"}

e.g. You can use the std::vector version of the jsonlog class to add as many values as you wish in a log message

mflogger::jsonlog loggingfile("/path/to/log/file.log");
std::vector<std::pair<std::string, std::string> > values;
values.push_back(std::make_pair("hello", "world"));
values.push_back(std::make_pair("pointless", "query"));
values.push_back(std::make_pair("pi", "3.14159265358979323846"));
jlog.logjson(values, "trace");

This will result in something like this in the log file

{"level":"trace","timestamp":"2024-11-30T19:16:15EDT","hello":"world","pointless":"query","pi":"3.14159265358979323846"}

By default logging happens using local time in iso 8601 format.
This can be changed using the timeformat function. This function uses std::put_time formatting syntax or can be used with mflogger::timestring::format as an argument
e.g.

loggingfile.timeformat(mflogger::timestring::format::HMS24);  // see timestring.h for enum mflogger::timestring::format values
  // or
loggingfile.timeformat("Making up a logging line prefix %H:%M);

Please look at logexample.cpp for examples
mflogger::log Interface

// constructor
log(const std::string& logfilename, const bool& append = true, timestring::format prefix = timestring::format::iso8601);

// close current logging file and open a new file
bool open(const std::string& logfilename, const bool& append = true);

// is open ready for log input [encapsulates std::ios::base library routines]
bool good() const;
bool is_open() const;

// log message with timestamp/prefix. return the whole log line
std::string logmessage(const std::string& message);

// log message using time since epoch as the format
// see mflogger::timestring::precision enum for valid values for second argument, defaults to seconds
std::string logmessage_epoch(const std::string& message, timestring::precision p = timestring::precision::sec);

// stream various types to file
log& operator<<(const std::string& in);
log& operator<<(bool in);
log& operator<<(char in);
//   ... rest left our for brevity -- see log.h

// set the delimiter between time prefix and message, a space is the default - " "
void setdelimiter(const std::string& d);

mflogger::jsonlog Interface derived from mflogger::log

// constructor
jsonlog(const std::string& logfilename, const bool& append = true, timestring::format prefix = timestring::format::iso8601);

// log message with timestamp/prefix. return the whole log line
// e.g.  general       : TRACE, DEBUG, INFO, WARN, ERROR, FATAL.
//       RSYSLOG style : emerg alert crit error warn notice info debug
// don't add Level if no level is appended
std::string logjson(const std::string& logitem, const std::string& value, const std::string& level = "");

// Level can obviously be anything that parses to valid json name
// e.g.  general       : TRACE, DEBUG, INFO, WARN, ERROR, FATAL.
//       RSYSLOG style : emerg alert crit error warn notice info debug
// don't add Level if no level is appended
std::string logjson(const std::vector<std::pair<std::string, std::string> >& logdata, const std::string& level = "");

timestring

Log's Base class timestring can be used just to get local time in a string
Can also be used to format the current time.
e.g.

mflogger::timestring st;
st.time_asstring(); // will return (iso 8601 default) formatted current local time when called
st.epoch_asstring;  // will return seconds since epoch (in various formats)

// get current UTC time [zulu time]
st.ISO8601TimeUTC(); // in iso 8601 format

mflogger::timestring Interface

// constructor
timestring(timestring::format f = timestring::format::iso8601);

// return current time [format dependant on timeformat function call - referenced above in log class documentation]
std::string time_asstring();

// display time since epoch [various formats see enum mflogger::timestring::precision]
// second argument: if seconds and partial second delimit using this character or set of characters
std::string epoch_asstring(precision Precision = sec, std::string delimeter = ".")

// format the time output via time_asstring using std::put_time syntax
void timeformat(const std::string& FORMAT); { // see std::put_time to reference substitutions possible

// pre setup formatting - convenience
// one of:- iso8601, iso8601Z, iso8601z, HMS24, HMS12 -- see timestring::format
void timeformat(format FORMAT);