feat: bring --enable-logging functionality in line with Chromium (#25089)
Co-authored-by: Jeremy Rose <jeremya@chromium.org>
This commit is contained in:
parent
c841247815
commit
8ccab4ce91
18 changed files with 553 additions and 54 deletions
141
shell/common/logging.cc
Normal file
141
shell/common/logging.cc
Normal file
|
@ -0,0 +1,141 @@
|
|||
// Copyright (c) 2021 Slack Technologies, Inc.
|
||||
// Use of this source code is governed by the MIT license that can be
|
||||
// found in the LICENSE file.
|
||||
|
||||
#include "shell/common/logging.h"
|
||||
|
||||
#include <string>
|
||||
|
||||
#include "base/base_switches.h"
|
||||
#include "base/command_line.h"
|
||||
#include "base/environment.h"
|
||||
#include "base/files/file_path.h"
|
||||
#include "base/logging.h"
|
||||
#include "base/path_service.h"
|
||||
#include "base/strings/string_number_conversions.h"
|
||||
#include "chrome/common/chrome_paths.h"
|
||||
#include "content/public/common/content_switches.h"
|
||||
#include "shell/common/electron_paths.h"
|
||||
|
||||
namespace logging {
|
||||
|
||||
constexpr base::StringPiece kLogFileName("ELECTRON_LOG_FILE");
|
||||
constexpr base::StringPiece kElectronEnableLogging("ELECTRON_ENABLE_LOGGING");
|
||||
|
||||
base::FilePath GetLogFileName(const base::CommandLine& command_line) {
|
||||
std::string filename = command_line.GetSwitchValueASCII(switches::kLogFile);
|
||||
if (filename.empty())
|
||||
base::Environment::Create()->GetVar(kLogFileName, &filename);
|
||||
if (!filename.empty())
|
||||
return base::FilePath::FromUTF8Unsafe(filename);
|
||||
|
||||
const base::FilePath log_filename(FILE_PATH_LITERAL("electron_debug.log"));
|
||||
base::FilePath log_path;
|
||||
|
||||
if (base::PathService::Get(chrome::DIR_LOGS, &log_path)) {
|
||||
log_path = log_path.Append(log_filename);
|
||||
return log_path;
|
||||
} else {
|
||||
// error with path service, just use some default file somewhere
|
||||
return log_filename;
|
||||
}
|
||||
}
|
||||
|
||||
bool HasExplicitLogFile(const base::CommandLine& command_line) {
|
||||
std::string filename = command_line.GetSwitchValueASCII(switches::kLogFile);
|
||||
if (filename.empty())
|
||||
base::Environment::Create()->GetVar(kLogFileName, &filename);
|
||||
return !filename.empty();
|
||||
}
|
||||
|
||||
LoggingDestination DetermineLoggingDestination(
|
||||
const base::CommandLine& command_line,
|
||||
bool is_preinit) {
|
||||
bool enable_logging = false;
|
||||
std::string logging_destination;
|
||||
if (command_line.HasSwitch(::switches::kEnableLogging)) {
|
||||
enable_logging = true;
|
||||
logging_destination =
|
||||
command_line.GetSwitchValueASCII(switches::kEnableLogging);
|
||||
} else {
|
||||
auto env = base::Environment::Create();
|
||||
if (env->HasVar(kElectronEnableLogging)) {
|
||||
enable_logging = true;
|
||||
env->GetVar(kElectronEnableLogging, &logging_destination);
|
||||
}
|
||||
}
|
||||
if (!enable_logging)
|
||||
return LOG_NONE;
|
||||
|
||||
// --enable-logging logs to stderr, --enable-logging=file logs to a file.
|
||||
// NB. this differs from Chromium, in which --enable-logging logs to a file
|
||||
// and --enable-logging=stderr logs to stderr, because that's how Electron
|
||||
// used to work, so in order to not break anyone who was depending on
|
||||
// --enable-logging logging to stderr, we preserve the old behavior by
|
||||
// default.
|
||||
// If --log-file or ELECTRON_LOG_FILE is specified along with
|
||||
// --enable-logging, return LOG_TO_FILE.
|
||||
// If we're in the pre-init phase, before JS has run, we want to avoid
|
||||
// logging to the default log file, which is inside the user data directory,
|
||||
// because we aren't able to accurately determine the user data directory
|
||||
// before JS runs. Instead, log to stderr unless there's an explicit filename
|
||||
// given.
|
||||
if (HasExplicitLogFile(command_line) ||
|
||||
(logging_destination == "file" && !is_preinit))
|
||||
return LOG_TO_FILE;
|
||||
return LOG_TO_SYSTEM_DEBUG_LOG | LOG_TO_STDERR;
|
||||
}
|
||||
|
||||
void InitElectronLogging(const base::CommandLine& command_line,
|
||||
bool is_preinit) {
|
||||
const std::string process_type =
|
||||
command_line.GetSwitchValueASCII(::switches::kProcessType);
|
||||
LoggingDestination logging_dest =
|
||||
DetermineLoggingDestination(command_line, is_preinit);
|
||||
LogLockingState log_locking_state = LOCK_LOG_FILE;
|
||||
base::FilePath log_path;
|
||||
|
||||
if (command_line.HasSwitch(::switches::kLoggingLevel) &&
|
||||
GetMinLogLevel() >= 0) {
|
||||
std::string log_level =
|
||||
command_line.GetSwitchValueASCII(::switches::kLoggingLevel);
|
||||
int level = 0;
|
||||
if (base::StringToInt(log_level, &level) && level >= 0 &&
|
||||
level < LOGGING_NUM_SEVERITIES) {
|
||||
SetMinLogLevel(level);
|
||||
} else {
|
||||
DLOG(WARNING) << "Bad log level: " << log_level;
|
||||
}
|
||||
}
|
||||
|
||||
// Don't resolve the log path unless we need to. Otherwise we leave an open
|
||||
// ALPC handle after sandbox lockdown on Windows.
|
||||
if ((logging_dest & LOG_TO_FILE) != 0) {
|
||||
log_path = GetLogFileName(command_line);
|
||||
} else {
|
||||
log_locking_state = DONT_LOCK_LOG_FILE;
|
||||
}
|
||||
|
||||
// On Windows, having non canonical forward slashes in log file name causes
|
||||
// problems with sandbox filters, see https://crbug.com/859676
|
||||
log_path = log_path.NormalizePathSeparators();
|
||||
|
||||
LoggingSettings settings;
|
||||
settings.logging_dest = logging_dest;
|
||||
settings.log_file_path = log_path.value().c_str();
|
||||
settings.lock_log = log_locking_state;
|
||||
// If we're logging to an explicit file passed with --log-file, we don't want
|
||||
// to delete the log file on our second initialization.
|
||||
settings.delete_old =
|
||||
process_type.empty() && (is_preinit || !HasExplicitLogFile(command_line))
|
||||
? DELETE_OLD_LOG_FILE
|
||||
: APPEND_TO_OLD_LOG_FILE;
|
||||
bool success = InitLogging(settings);
|
||||
if (!success) {
|
||||
PLOG(FATAL) << "Failed to init logging";
|
||||
}
|
||||
|
||||
SetLogItems(true /* pid */, false, true /* timestamp */, false);
|
||||
}
|
||||
|
||||
} // namespace logging
|
Loading…
Add table
Add a link
Reference in a new issue