Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
arangodb/lib/Logger/LoggerFeature.cpp

326 lines
12 KiB
C++
Raw Blame History

////////////////////////////////////////////////////////////////////////////////
/// DISCLAIMER
///
/// Copyright 2016 ArangoDB GmbH, Cologne, Germany
///
/// Licensed under the Apache License, Version 2.0 (the "License");
/// you may not use this file except in compliance with the License.
/// You may obtain a copy of the License at
///
/// http://www.apache.org/licenses/LICENSE-2.0
///
/// Unless required by applicable law or agreed to in writing, software
/// distributed under the License is distributed on an "AS IS" BASIS,
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
/// See the License for the specific language governing permissions and
/// limitations under the License.
///
/// Copyright holder is ArangoDB GmbH, Cologne, Germany
///
/// @author Dr. Frank Celler
////////////////////////////////////////////////////////////////////////////////
#include "LoggerFeature.h"
#ifdef ARANGODB_HAVE_GETGRGID
#include <grp.h>
#endif
#ifdef TRI_HAVE_UNISTD_H
#include <unistd.h>
#endif
#include "Basics/conversions.h"
#include "Basics/StringUtils.h"
#include "Logger/LogAppender.h"
#include "Logger/LogAppenderFile.h"
#include "Logger/LogTimeFormat.h"
#include "Logger/Logger.h"
#include "ProgramOptions/ProgramOptions.h"
#include "ProgramOptions/Section.h"
#if _WIN32
#include <iostream>
#endif
using namespace arangodb::basics;
using namespace arangodb::options;
namespace arangodb {
LoggerFeature::LoggerFeature(application_features::ApplicationServer& server, bool threaded)
: ApplicationFeature(server, "Logger"),
_timeFormatString(LogTimeFormats::defaultFormatName()),
_threaded(threaded) {
setOptional(false);
startsAfter("ShellColors");
startsAfter("Version");
_levels.push_back("info");
// if stdout is a tty, then the default for _foregroundTty becomes true
_foregroundTty = (isatty(STDOUT_FILENO) == 1);
}
LoggerFeature::~LoggerFeature() { Logger::shutdown(); }
void LoggerFeature::collectOptions(std::shared_ptr<ProgramOptions> options) {
options->addOldOption("log.tty", "log.foreground-tty");
options->addOldOption("log.content-filter", "");
options->addOldOption("log.source-filter", "");
options->addOldOption("log.application", "");
options->addOldOption("log.facility", "");
options->addOption("--log", "the global or topic-specific log level",
new VectorParameter<StringParameter>(&_levels),
arangodb::options::makeFlags(arangodb::options::Flags::Hidden))
.setDeprecatedIn(30500);
options->addSection("log", "Configure the logging");
options->addOption("--log.color", "use colors for TTY logging",
new BooleanParameter(&_useColor));
options->addOption("--log.escape", "escape characters when logging",
new BooleanParameter(&_useEscaped));
options->addOption("--log.output,-o",
"log destination(s), e.g. file:///path/to/file (Linux, macOS) "
"or file://C:\\path\\to\\file (Windows)",
new VectorParameter<StringParameter>(&_output));
options->addOption("--log.level,-l", "the global or topic-specific log level",
new VectorParameter<StringParameter>(&_levels));
options->addOption("--log.use-local-time", "use local timezone instead of UTC",
new BooleanParameter(&_useLocalTime),
arangodb::options::makeFlags(arangodb::options::Flags::Hidden))
.setDeprecatedIn(30500);
options->addOption("--log.use-microtime", "use microtime instead",
new BooleanParameter(&_useMicrotime),
arangodb::options::makeFlags(arangodb::options::Flags::Hidden))
.setDeprecatedIn(30500);
options->addOption("--log.time-format", "time format to use in logs",
new DiscreteValuesParameter<StringParameter>(&_timeFormatString, LogTimeFormats::getAvailableFormatNames()))
.setIntroducedIn(30500);
options->addOption("--log.ids", "log unique message ids",
new BooleanParameter(&_showIds))
.setIntroducedIn(30500);
options->addOption("--log.role", "log server role", new BooleanParameter(&_showRole));
options->addOption("--log.file-mode",
"mode to use for new log file, umask will be applied as well",
new StringParameter(&_fileMode))
.setIntroducedIn(30405)
.setIntroducedIn(30500);
#ifdef ARANGODB_HAVE_SETGID
options->addOption("--log.file-group",
"group to use for new log file, user must be a member of this group",
new StringParameter(&_fileGroup))
.setIntroducedIn(30405)
.setIntroducedIn(30500);
#endif
options->addOption("--log.prefix", "prefix log message with this string",
new StringParameter(&_prefix),
arangodb::options::makeFlags(arangodb::options::Flags::Hidden));
options->addOption("--log.file",
"shortcut for '--log.output file://<filename>'",
new StringParameter(&_file),
arangodb::options::makeFlags(arangodb::options::Flags::Hidden));
options->addOption("--log.line-number", "append line number and file name",
new BooleanParameter(&_lineNumber),
arangodb::options::makeFlags(arangodb::options::Flags::Hidden));
options->addOption(
"--log.shorten-filenames",
"shorten filenames in log output (use with --log.line-number)",
new BooleanParameter(&_shortenFilenames),
arangodb::options::makeFlags(arangodb::options::Flags::Hidden));
options->addOption("--log.thread", "show thread identifier in log message",
new BooleanParameter(&_threadId),
arangodb::options::makeFlags(arangodb::options::Flags::Hidden));
options->addOption("--log.thread-name", "show thread name in log message",
new BooleanParameter(&_threadName),
arangodb::options::makeFlags(arangodb::options::Flags::Hidden));
options->addOption("--log.performance",
"shortcut for '--log.level performance=trace'",
new BooleanParameter(&_performance),
arangodb::options::makeFlags(arangodb::options::Flags::Hidden))
.setDeprecatedIn(30500);
options->addOption("--log.keep-logrotate",
"keep the old log file after receiving a sighup",
new BooleanParameter(&_keepLogRotate),
arangodb::options::makeFlags(arangodb::options::Flags::Hidden));
options->addOption("--log.foreground-tty", "also log to tty if backgrounded",
new BooleanParameter(&_foregroundTty),
arangodb::options::makeFlags(arangodb::options::Flags::Hidden));
options->addOption("--log.force-direct",
"do not start a seperate thread for logging",
new BooleanParameter(&_forceDirect),
arangodb::options::makeFlags(arangodb::options::Flags::Hidden));
options->addOption(
"--log.request-parameters",
"include full URLs and HTTP request parameters in trace logs",
new BooleanParameter(&_logRequestParameters),
arangodb::options::makeFlags(arangodb::options::Flags::Hidden));
}
void LoggerFeature::loadOptions(std::shared_ptr<options::ProgramOptions>,
char const* binaryPath) {
// for debugging purpose, we set the log levels NOW
// this might be overwritten latter
Logger::setLogLevel(_levels);
}
void LoggerFeature::validateOptions(std::shared_ptr<ProgramOptions> options) {
if (options->processingResult().touched("log.file")) {
std::string definition;
if (_file == "+" || _file == "-") {
definition = _file;
} else {
definition = "file://" + _file;
}
_output.push_back(definition);
}
if (_performance) {
_levels.push_back("performance=trace");
}
if (options->processingResult().touched("log.time-format") &&
(options->processingResult().touched("log.use-microtime") ||
options->processingResult().touched("log.use-local-time"))) {
LOG_TOPIC("c3f28", FATAL, arangodb::Logger::FIXME)
<< "cannot combine `--log.time-format` with either `--log.use-microtime` or `--log.use-local-time`";
FATAL_ERROR_EXIT();
}
// convert the deprecated options into the new timeformat
if (options->processingResult().touched("log.use-local-time")) {
_timeFormatString = "local-datestring";
// the following call ensures the string is actually valid.
// if not valid, the following call will throw an exception and
// abort the startup
LogTimeFormats::formatFromName(_timeFormatString);
} else if (options->processingResult().touched("log.use-microtime")) {
_timeFormatString = "timestamp-micros";
// the following call ensures the string is actually valid.
// if not valid, the following call will throw an exception and
// abort the startup
LogTimeFormats::formatFromName(_timeFormatString);
}
if (!_fileMode.empty()) {
try {
int result = std::stoi(_fileMode, nullptr, 8);
LogAppenderFile::setFileMode(result);
} catch (...) {
LOG_TOPIC("797c2", FATAL, arangodb::Logger::FIXME)
<< "expecting an octal number for log.file-mode, got '" << _fileMode << "'";
FATAL_ERROR_EXIT();
}
}
#ifdef ARANGODB_HAVE_SETGID
if (!_fileGroup.empty()) {
int gidNumber = TRI_Int32String(_fileGroup.c_str());
if (TRI_errno() == TRI_ERROR_NO_ERROR && gidNumber >= 0) {
#ifdef ARANGODB_HAVE_GETGRGID
group* g = getgrgid(gidNumber);
if (g == nullptr) {
LOG_TOPIC("174c2", FATAL, arangodb::Logger::FIXME)
<< "unknown numeric gid '" << _fileGroup << "'";
FATAL_ERROR_EXIT();
}
#endif
} else {
#ifdef ARANGODB_HAVE_GETGRNAM
std::string name = _fileGroup;
group* g = getgrnam(name.c_str());
if (g != nullptr) {
gidNumber = g->gr_gid;
} else {
TRI_set_errno(TRI_ERROR_SYS_ERROR);
LOG_TOPIC("11a2c", FATAL, arangodb::Logger::FIXME)
<< "cannot convert groupname '" << _fileGroup
<< "' to numeric gid: " << TRI_last_error();
FATAL_ERROR_EXIT();
}
#else
LOG_TOPIC("1c96f", FATAL, arangodb::Logger::FIXME)
<< "cannot convert groupname '" << _fileGroup << "' to numeric gid";
FATAL_ERROR_EXIT();
#endif
}
LogAppenderFile::setFileGroup(gidNumber);
}
#endif
}
void LoggerFeature::prepare() {
#if _WIN32
if (!TRI_InitWindowsEventLog()) {
std::cerr << "failed to init event log" << std::endl;
FATAL_ERROR_EXIT();
}
#endif
Logger::setLogLevel(_levels);
Logger::setShowIds(_showIds);
Logger::setShowRole(_showRole);
Logger::setUseColor(_useColor);
Logger::setTimeFormat(LogTimeFormats::formatFromName(_timeFormatString));
Logger::setUseEscaped(_useEscaped);
Logger::setShowLineNumber(_lineNumber);
Logger::setShortenFilenames(_shortenFilenames);
Logger::setShowThreadIdentifier(_threadId);
Logger::setShowThreadName(_threadName);
Logger::setOutputPrefix(_prefix);
Logger::setKeepLogrotate(_keepLogRotate);
Logger::setLogRequestParameters(_logRequestParameters);
for (auto const& definition : _output) {
if (_supervisor && StringUtils::isPrefix(definition, "file://")) {
LogAppender::addAppender(definition + ".supervisor");
} else {
LogAppender::addAppender(definition);
}
}
if (_foregroundTty) {
LogAppender::addAppender("-");
}
if (_forceDirect || _supervisor) {
Logger::initialize(false);
} else {
Logger::initialize(_threaded);
}
}
void LoggerFeature::unprepare() { Logger::flush(); }
} // namespace arangodb
Reference in New Issue View Git Blame Copy Permalink