Color for alog

Author: Coldwings

common/alog.cpp

@@ -40,11 +40,31 @@ class BaseLogOutput : public ILogOutput {
     uint64_t count = 0;
     time_t ts = 0;
     int log_file_fd;
+    struct iovec level_prefix[ALOG_AUDIT + 1]{}, level_suffix[ALOG_AUDIT + 1]{};
 
-    constexpr BaseLogOutput(int fd = 0) : log_file_fd(fd) { }
+    constexpr BaseLogOutput(int fd = 0) : log_file_fd(fd) {}
 
-    void write(int, const char* begin, const char* end) override {
-        std::ignore = ::write(log_file_fd, begin, end - begin);
+    void set_level_color(int level, const char* color) override {
+        level_prefix[level] = {(void*)color, strlen(color)};
+        if (level_prefix[level].iov_base == nullptr ||
+            level_prefix[level].iov_len == 0) {
+            level_suffix[level] = {(void*)"", 0};
+        } else {
+            level_suffix[level] = {(void*)ALOG_COLOR_RESET,
+                                   sizeof(ALOG_COLOR_RESET) - 1};
+        }
+    }
+
+    void write(int level, const char* begin, const char* end) override {
+        struct iovec iov[3] = {
+            level_prefix[level],
+            {
+                .iov_base = (void*)begin,
+                .iov_len = (size_t)(end - begin),
+            },
+            level_suffix[level]
+        };
+        std::ignore = ::writev(log_file_fd, iov, 3);
         throttle_block();
     }
     void throttle_block() {
@@ -251,15 +271,19 @@ class LogOutputFile final : public BaseLogOutput {
         return open(fn, O_CREAT | O_WRONLY | O_APPEND, mode);
     }
 
-    void write(int, const char* begin, const char* end) override {
+    void write(int level, const char* begin, const char* end) override {
         if (log_file_fd < 0) return;
         uint64_t length = end - begin;
-        iovec iov{(void*)begin, length};
-#ifndef _WIN64
-        std::ignore = ::writev(log_file_fd, &iov, 1); // writev() is atomic, whereas write() is not
-#else
-        std::ignore = ::write(log_file_fd, iov.iov_base, iov.iov_len);
-#endif
+        // iovec iov{(void*)begin, length};
+        struct iovec iov[3] = {
+            level_prefix[level],
+            {
+                .iov_base = (void*)begin,
+                .iov_len = length,
+            },
+            level_suffix[level]
+        };
+        std::ignore = ::writev(log_file_fd, iov, 3);
         throttle_block();
         if (log_file_name && log_file_size_limit) {
             log_file_size += length;

common/alog.h

@@ -28,6 +28,25 @@ limitations under the License.
 #include <photon/common/conststr.h>
 #include <photon/common/retval.h>
 
+#define ALOG_COLOR_RESET "\033[0m"
+#define ALOG_COLOR_BLACK "\033[30m"
+#define ALOG_COLOR_RED "\033[31m"
+#define ALOG_COLOR_GREEN "\033[32m"
+#define ALOG_COLOR_YELLOW "\033[33m"
+#define ALOG_COLOR_BLUE "\033[34m"
+#define ALOG_COLOR_MAGENTA "\033[35m"
+#define ALOG_COLOR_CYAN "\033[36m"
+#define ALOG_COLOR_LIGHTGRAY "\033[37m"
+#define ALOG_COLOR_DARKGRAY "\033[90m"
+#define ALOG_COLOR_LIGHTRED "\033[91m"
+#define ALOG_COLOR_LIGHTGREEN "\033[92m"
+#define ALOG_COLOR_LIGHTYELLOW "\033[93m"
+#define ALOG_COLOR_LIGHTBLUE "\033[94m"
+#define ALOG_COLOR_LIGHTMAGENTA "\033[95m"
+#define ALOG_COLOR_LIGHTCYAN "\033[96m"
+#define ALOG_COLOR_LIGHTWHITE "\033[97m"
+#define ALOG_COLOR_NOTHING ""
+
 class ILogOutput {
 protected:
     // output object should be destructed via `destruct()`
@@ -40,6 +59,11 @@ class ILogOutput {
     virtual uint64_t set_throttle(uint64_t t = -1UL) = 0;
     virtual uint64_t get_throttle() = 0;
     virtual void destruct() = 0;
+    virtual void set_level_color(int level, const char* color) {
+        // not implemented by default
+    }
+    void preset_color();
+    void clear_color();
 };
 
 extern ILogOutput * const log_output_null;
@@ -201,6 +225,25 @@ struct ALogBuffer
 #define ALOG_TEMP  5
 #define ALOG_AUDIT 6
 
+inline void ILogOutput::preset_color() {
+    set_level_color(ALOG_DEBUG, ALOG_COLOR_DARKGRAY);
+    set_level_color(ALOG_INFO, ALOG_COLOR_RESET);
+    set_level_color(ALOG_WARN, ALOG_COLOR_YELLOW);
+    set_level_color(ALOG_ERROR, ALOG_COLOR_RED);
+    set_level_color(ALOG_FATAL, ALOG_COLOR_MAGENTA);
+    set_level_color(ALOG_TEMP, ALOG_COLOR_CYAN);
+    set_level_color(ALOG_AUDIT, ALOG_COLOR_GREEN);
+}
+inline void ILogOutput::clear_color() {
+    set_level_color(ALOG_DEBUG, ALOG_COLOR_NOTHING);
+    set_level_color(ALOG_INFO, ALOG_COLOR_NOTHING);
+    set_level_color(ALOG_WARN, ALOG_COLOR_NOTHING);
+    set_level_color(ALOG_ERROR, ALOG_COLOR_NOTHING);
+    set_level_color(ALOG_FATAL, ALOG_COLOR_NOTHING);
+    set_level_color(ALOG_TEMP, ALOG_COLOR_NOTHING);
+    set_level_color(ALOG_AUDIT, ALOG_COLOR_NOTHING);
+}
+
 class LogFormatter
 {
 public:

common/test/test_alog.cpp

@@ -584,6 +584,23 @@ TEST(ALOG, signed_zero) {
     EXPECT_STREQ("0", log_output_test.log_start());
 }
 
+TEST(ALOG, log_with_color) {
+    default_logger.log_output->preset_color();
+    LOG_DEBUG("some debug log");
+    LOG_INFO("some info log");
+    LOG_WARN("some warning log");
+    LOG_ERROR("some error log");
+    LOG_FATAL("some fatal log");
+    default_logger << LOG_AUDIT("some audit log");
+    default_logger.log_output->clear_color();
+    LOG_DEBUG("some debug log");
+    LOG_INFO("some info log");
+    LOG_WARN("some warning log");
+    LOG_ERROR("some error log");
+    LOG_FATAL("some fatal log");
+    default_logger << LOG_AUDIT("some audit log");
+}
+
 int main(int argc, char **argv)
 {
     if (!photon::is_using_default_engine()) return 0;