Add a new class for logging. (#36)

Author: jianjunz

web_transport/BUILD.gn

@@ -23,6 +23,7 @@ source_set("owt_web_transport_impl") {
     "//third_party/boringssl",
   ]
   sources = [
+    "sdk/api/owt/quic/logging.h",
     "sdk/api/owt/quic/version.h",
     "sdk/api/owt/quic/web_transport_client_interface.h",
     "sdk/api/owt/quic/web_transport_definitions.h",
@@ -37,6 +38,7 @@ source_set("owt_web_transport_impl") {
     "sdk/impl/utilities.cc",
     "sdk/impl/utilities.h",
     "sdk/impl/version.cc",
+    "sdk/impl/logging.cc",
     "sdk/impl/web_transport_factory_impl.cc",
     "sdk/impl/web_transport_factory_impl.h",
     "sdk/impl/web_transport_http3_client.cc",

web_transport/sdk/api/owt/quic/logging.h

@@ -0,0 +1,47 @@
+/*
+ * Copyright (C) 2021 Intel Corporation
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef OWT_WEB_TRANSPORT_LOGGING_H_
+#define OWT_WEB_TRANSPORT_LOGGING_H_
+
+#include "export.h"
+
+namespace owt {
+namespace quic {
+
+enum class LoggingSeverity : int {
+  /// This level is for data which we do not want to appear in the normal debug
+  /// log, but should appear in diagnostic logs.
+  kVerbose,
+  /// Chatty level used in debugging for all sorts of things, the default in
+  /// debug builds.
+  kInfo,
+  /// Something that may warrant investigation.
+  kWarning,
+  /// Something that should not have occurred.
+  kError,
+  /// Fatal errors.
+  kFatal
+};
+
+class OWT_EXPORT Logging {
+ public:
+  /// Set logging severity. All logging messages with higher severity will be
+  /// logged.
+  static void Severity(LoggingSeverity severity);
+  /// Get current logging severity.
+  static LoggingSeverity Severity();
+  // Init logging module.
+  static void InitLogging();
+
+ private:
+  static LoggingSeverity min_severity_;
+};
+
+}  // namespace quic
+}  // namespace owt
+
+#endif

web_transport/sdk/impl/logging.cc

@@ -0,0 +1,47 @@
+/*
+ * Copyright (C) 2021 Intel Corporation
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include "owt/quic/logging.h"
+#include <unordered_map>
+#include "base/logging.h"
+
+namespace owt {
+namespace quic {
+
+#ifdef _DEBUG
+LoggingSeverity Logging::min_severity_ = LoggingSeverity::kInfo;
+#else
+LoggingSeverity Logging::min_severity_ = LoggingSeverity::kError;
+#endif
+
+// Due to a defect in C++ 11, static cast to int instead of enum value.
+// http://www.open-std.org/jtc1/sc22/wg21/docs/lwg-defects.html#2148
+static std::unordered_map<int, logging::LogSeverity> logging_severity_map = {
+    {static_cast<int>(LoggingSeverity::kVerbose), logging::LOG_VERBOSE},
+    {static_cast<int>(LoggingSeverity::kInfo), logging::LOG_INFO},
+    {static_cast<int>(LoggingSeverity::kWarning), logging::LOG_WARNING},
+    {static_cast<int>(LoggingSeverity::kError), logging::LOG_ERROR},
+    {static_cast<int>(LoggingSeverity::kFatal), logging::LOG_FATAL}};
+
+void Logging::Severity(LoggingSeverity severity) {
+  min_severity_ = severity;
+  LOG(ERROR) << "Setting logging level to "
+             << logging_severity_map[static_cast<int>(severity)];
+  logging::SetMinLogLevel(logging_severity_map[static_cast<int>(severity)]);
+}
+
+LoggingSeverity Logging::Severity() {
+  return min_severity_;
+}
+
+void Logging::InitLogging() {
+  logging::LoggingSettings settings;
+  settings.logging_dest = logging::LOG_TO_STDERR;
+  logging::InitLogging(settings);
+}
+
+}  // namespace quic
+}  // namespace owt

web_transport/sdk/impl/web_transport_factory_impl.cc

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+#include "owt/quic/logging.h"
 #include "impl/web_transport_factory_impl.h"
 #include "base/at_exit.h"
 #include "base/bind.h"
@@ -135,15 +136,7 @@ void WebTransportFactoryImpl::Init() {
   base::CommandLine::Init(0, nullptr);
   base::CommandLine* command_line(base::CommandLine::ForCurrentProcess());
   command_line->AppendSwitch("--quic_default_to_bbr");
-  // Logging settings for Chromium.
-#ifdef _DEBUG
-  logging::SetMinLogLevel(logging::LOG_VERBOSE);
-#else
-  logging::SetMinLogLevel(logging::LOG_WARNING);
-#endif
-  logging::LoggingSettings settings;
-  settings.logging_dest = logging::LOG_TO_STDERR;
-  InitLogging(settings);
+  Logging::InitLogging();
 }
 
 }  // namespace quic