Skip to content

Commit

Permalink
Extended the LogSink interface to be able to pass microseconds.
Browse files Browse the repository at this point in the history
  • Loading branch information
@asekretenko
asekretenko committed Mar 26, 2019
1 parent 96a2f23 commit 8710c23
Show file tree
Hide file tree
Showing 4 changed files with 72 additions and 21 deletions.
20 changes: 19 additions & 1 deletion src/glog/logging.h.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1423,6 +1423,16 @@ class GOOGLE_GLOG_DLL_DECL LogSink {
// Sink's logging logic (message_len is such as to exclude '\n' at the end).
// This method can't use LOG() or CHECK() as logging system mutex(s) are held
// during this call.
virtual void send(LogSeverity severity, const char* full_filename,
const char* base_filename, int line,
const struct ::tm* tm_time,
const char* message, size_t message_len, int usec) {
send(severity, full_filename, base_filename, line,
tm_time, message, message_len);
}
// This send() signature is obsolete.
// New implementations should define this in terms of
// the above send() method.
virtual void send(LogSeverity severity, const char* full_filename,
const char* base_filename, int line,
const struct ::tm* tm_time,
Expand All @@ -1447,7 +1457,15 @@ class GOOGLE_GLOG_DLL_DECL LogSink {
// Can be useful to implement send().
static std::string ToString(LogSeverity severity, const char* file, int line,
const struct ::tm* tm_time,
const char* message, size_t message_len);
const char* message, size_t message_len,
int usecs);

// Obsolete
static std::string ToString(LogSeverity severity, const char* file, int line,
const struct ::tm* tm_time,
const char* message, size_t message_len) {
return ToString(severity, file, line, tm_time, message, message_len, 0);
}
};

// Add or remove a LogSink as a consumer of logging data. Thread-safe.
Expand Down
30 changes: 15 additions & 15 deletions src/logging.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -349,6 +349,7 @@ struct LogMessage::LogMessageData {
};
time_t timestamp_; // Time of creation of LogMessage
struct ::tm tm_time_; // Time of creation of LogMessage
int usecs_; // Time of creation of LogMessage - microseconds part
size_t num_prefix_chars_; // # of chars of prefix in this message
size_t num_chars_to_log_; // # of chars of msg to send to log
size_t num_chars_to_syslog_; // # of chars of msg to send to syslog
Expand Down Expand Up @@ -515,7 +516,8 @@ class LogDestination {
int line,
const struct ::tm* tm_time,
const char* message,
size_t message_len);
size_t message_len,
int usecs);

// Wait for all registered sinks via WaitTillSent
// including the optional one in "data".
Expand Down Expand Up @@ -782,12 +784,13 @@ inline void LogDestination::LogToSinks(LogSeverity severity,
int line,
const struct ::tm* tm_time,
const char* message,
size_t message_len) {
size_t message_len,
int usecs) {
ReaderMutexLock l(&sink_mutex_);
if (sinks_) {
for (int i = sinks_->size() - 1; i >= 0; i--) {
(*sinks_)[i]->send(severity, full_filename, base_filename,
line, tm_time, message, message_len);
line, tm_time, message, message_len, usecs);
}
}
}
Expand Down Expand Up @@ -1265,7 +1268,7 @@ void LogMessage::Init(const char* file,
WallTime now = WallTime_Now();
data_->timestamp_ = static_cast<time_t>(now);
localtime_r(&data_->timestamp_, &data_->tm_time_);
int usecs = static_cast<int>((now - data_->timestamp_) * 1000000);
data_->usecs_ = static_cast<int>((now - data_->timestamp_) * 1000000);

data_->num_chars_to_log_ = 0;
data_->num_chars_to_syslog_ = 0;
Expand All @@ -1285,7 +1288,7 @@ void LogMessage::Init(const char* file,
<< setw(2) << data_->tm_time_.tm_hour << ':'
<< setw(2) << data_->tm_time_.tm_min << ':'
<< setw(2) << data_->tm_time_.tm_sec << "."
<< setw(6) << usecs
<< setw(6) << data_->usecs_
<< ' '
<< setfill(' ') << setw(5)
<< static_cast<unsigned int>(GetTID()) << setfill('0')
Expand Down Expand Up @@ -1432,7 +1435,8 @@ void LogMessage::SendToLog() EXCLUSIVE_LOCKS_REQUIRED(log_mutex) {
data_->line_, &data_->tm_time_,
data_->message_text_ + data_->num_prefix_chars_,
(data_->num_chars_to_log_ -
data_->num_prefix_chars_ - 1));
data_->num_prefix_chars_ - 1),
data_->usecs_);
} else {

// log this message to all log files of severity <= severity_
Expand All @@ -1449,7 +1453,8 @@ void LogMessage::SendToLog() EXCLUSIVE_LOCKS_REQUIRED(log_mutex) {
data_->line_, &data_->tm_time_,
data_->message_text_ + data_->num_prefix_chars_,
(data_->num_chars_to_log_
- data_->num_prefix_chars_ - 1));
- data_->num_prefix_chars_ - 1),
data_->usecs_);
// NOTE: -1 removes trailing \n
}

Expand Down Expand Up @@ -1545,7 +1550,8 @@ void LogMessage::SendToSink() EXCLUSIVE_LOCKS_REQUIRED(log_mutex) {
data_->line_, &data_->tm_time_,
data_->message_text_ + data_->num_prefix_chars_,
(data_->num_chars_to_log_ -
data_->num_prefix_chars_ - 1));
data_->num_prefix_chars_ - 1),
data_->usecs_);
}
}

Expand Down Expand Up @@ -1672,16 +1678,10 @@ void LogSink::WaitTillSent() {

string LogSink::ToString(LogSeverity severity, const char* file, int line,
const struct ::tm* tm_time,
const char* message, size_t message_len) {
const char* message, size_t message_len, int usecs) {
ostringstream stream(string(message, message_len));
stream.fill('0');

// FIXME(jrvb): Updating this to use the correct value for usecs
// requires changing the signature for both this method and
// LogSink::send(). This change needs to be done in a separate CL
// so subclasses of LogSink can be updated at the same time.
int usecs = 0;

stream << LogSeverityNames[severity][0]
<< setw(2) << 1+tm_time->tm_mon
<< setw(2) << tm_time->tm_mday
Expand Down
23 changes: 19 additions & 4 deletions src/logging_unittest.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -487,9 +487,16 @@ class TestLogSinkImpl : public LogSink {
virtual void send(LogSeverity severity, const char* /* full_filename */,
const char* base_filename, int line,
const struct tm* tm_time,
const char* message, size_t message_len) {
const char* message, size_t message_len, int usecs) {
errors.push_back(
ToString(severity, base_filename, line, tm_time, message, message_len));
ToString(severity, base_filename, line, tm_time, message, message_len, usecs));
}
virtual void send(LogSeverity severity, const char* full_filename,
const char* base_filename, int line,
const struct tm* tm_time,
const char* message, size_t message_len) {
send(severity, full_filename, base_filename, line,
tm_time, message, message_len, 0);
}
};

Expand Down Expand Up @@ -1010,15 +1017,23 @@ class TestWaitingLogSink : public LogSink {
virtual void send(LogSeverity severity, const char* /* full_filename */,
const char* base_filename, int line,
const struct tm* tm_time,
const char* message, size_t message_len) {
const char* message, size_t message_len, int usecs) {
// Push it to Writer thread if we are the original logging thread.
// Note: Something like ThreadLocalLogSink is a better choice
// to do thread-specific LogSink logic for real.
if (pthread_equal(tid_, pthread_self())) {
writer_.Buffer(ToString(severity, base_filename, line,
tm_time, message, message_len));
tm_time, message, message_len, usecs));
}
}

virtual void send(LogSeverity severity, const char* full_filename,
const char* base_filename, int line,
const struct tm* tm_time,
const char* message, size_t message_len) {
send(severity, full_filename, base_filename, line, tm_time, message, message_len);
}

virtual void WaitTillSent() {
// Wait for Writer thread if we are the original logging thread.
if (pthread_equal(tid_, pthread_self())) writer_.Wait();
Expand Down
20 changes: 19 additions & 1 deletion src/windows/glog/logging.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1427,6 +1427,16 @@ class GOOGLE_GLOG_DLL_DECL LogSink {
// Sink's logging logic (message_len is such as to exclude '\n' at the end).
// This method can't use LOG() or CHECK() as logging system mutex(s) are held
// during this call.
virtual void send(LogSeverity severity, const char* full_filename,
const char* base_filename, int line,
const struct ::tm* tm_time,
const char* message, size_t message_len, int usec) {
send(severity, full_filename, base_filename, line,
tm_time, message, message_len);
}
// This send() signature is obsolete.
// New implementations should define this in terms of
// the above send() method.
virtual void send(LogSeverity severity, const char* full_filename,
const char* base_filename, int line,
const struct ::tm* tm_time,
Expand All @@ -1451,7 +1461,15 @@ class GOOGLE_GLOG_DLL_DECL LogSink {
// Can be useful to implement send().
static std::string ToString(LogSeverity severity, const char* file, int line,
const struct ::tm* tm_time,
const char* message, size_t message_len);
const char* message, size_t message_len,
int usecs);

// Obsolete
static std::string ToString(LogSeverity severity, const char* file, int line,
const struct ::tm* tm_time,
const char* message, size_t message_len) {
return ToString(severity, file, line, tm_time, message, message_len, 0);
}
};

// Add or remove a LogSink as a consumer of logging data. Thread-safe.
Expand Down

0 comments on commit 8710c23

Please sign in to comment.