2016-04-25 13:26:07 +00:00
|
|
|
#include "logging.hh"
|
|
|
|
#include "util.hh"
|
2020-07-02 15:04:31 +00:00
|
|
|
#include "config.hh"
|
2016-04-25 13:26:07 +00:00
|
|
|
|
2017-05-16 14:09:57 +00:00
|
|
|
#include <atomic>
|
2017-10-24 11:41:52 +00:00
|
|
|
#include <nlohmann/json.hpp>
|
2020-04-16 11:12:58 +00:00
|
|
|
#include <iostream>
|
2017-05-16 14:09:57 +00:00
|
|
|
|
2016-04-25 13:26:07 +00:00
|
|
|
namespace nix {
|
|
|
|
|
2020-07-02 15:04:31 +00:00
|
|
|
LoggerSettings loggerSettings;
|
|
|
|
|
2020-10-06 11:36:55 +00:00
|
|
|
static GlobalConfig::Register rLoggerSettings(&loggerSettings);
|
2020-07-02 15:04:31 +00:00
|
|
|
|
2018-03-12 04:56:41 +00:00
|
|
|
static thread_local ActivityId curActivity = 0;
|
|
|
|
|
|
|
|
ActivityId getCurActivity()
|
|
|
|
{
|
|
|
|
return curActivity;
|
|
|
|
}
|
|
|
|
void setCurActivity(const ActivityId activityId)
|
|
|
|
{
|
|
|
|
curActivity = activityId;
|
|
|
|
}
|
2017-08-25 15:49:40 +00:00
|
|
|
|
2020-07-02 15:04:31 +00:00
|
|
|
Logger * logger = makeSimpleLogger(true);
|
2016-04-25 13:26:07 +00:00
|
|
|
|
2017-04-12 12:53:10 +00:00
|
|
|
void Logger::warn(const std::string & msg)
|
|
|
|
{
|
2021-09-14 08:38:10 +00:00
|
|
|
log(lvlWarn, ANSI_WARNING "warning:" ANSI_NORMAL " " + msg);
|
2017-04-12 12:53:10 +00:00
|
|
|
}
|
|
|
|
|
2020-04-16 11:12:58 +00:00
|
|
|
void Logger::writeToStdout(std::string_view s)
|
|
|
|
{
|
2023-03-02 13:46:28 +00:00
|
|
|
writeFull(STDOUT_FILENO, s);
|
|
|
|
writeFull(STDOUT_FILENO, "\n");
|
2020-04-16 11:12:58 +00:00
|
|
|
}
|
|
|
|
|
2016-04-25 13:26:07 +00:00
|
|
|
class SimpleLogger : public Logger
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
|
|
|
|
bool systemd, tty;
|
2020-06-05 16:20:11 +00:00
|
|
|
bool printBuildLogs;
|
2016-04-25 13:26:07 +00:00
|
|
|
|
2020-07-02 15:04:31 +00:00
|
|
|
SimpleLogger(bool printBuildLogs)
|
|
|
|
: printBuildLogs(printBuildLogs)
|
2016-04-25 13:26:07 +00:00
|
|
|
{
|
|
|
|
systemd = getEnv("IN_SYSTEMD") == "1";
|
2021-07-02 00:19:01 +00:00
|
|
|
tty = shouldANSI();
|
2016-04-25 13:26:07 +00:00
|
|
|
}
|
|
|
|
|
2020-06-05 16:20:11 +00:00
|
|
|
bool isVerbose() override {
|
|
|
|
return printBuildLogs;
|
|
|
|
}
|
|
|
|
|
2016-04-25 13:26:07 +00:00
|
|
|
void log(Verbosity lvl, const FormatOrString & fs) override
|
|
|
|
{
|
|
|
|
if (lvl > verbosity) return;
|
|
|
|
|
|
|
|
std::string prefix;
|
|
|
|
|
|
|
|
if (systemd) {
|
|
|
|
char c;
|
|
|
|
switch (lvl) {
|
|
|
|
case lvlError: c = '3'; break;
|
2019-06-17 07:12:03 +00:00
|
|
|
case lvlWarn: c = '4'; break;
|
2016-04-25 13:26:07 +00:00
|
|
|
case lvlInfo: c = '5'; break;
|
|
|
|
case lvlTalkative: case lvlChatty: c = '6'; break;
|
|
|
|
default: c = '7';
|
|
|
|
}
|
|
|
|
prefix = std::string("<") + c + ">";
|
|
|
|
}
|
|
|
|
|
2018-03-15 15:08:07 +00:00
|
|
|
writeToStderr(prefix + filterANSIEscapes(fs.s, !tty) + "\n");
|
2016-04-25 13:26:07 +00:00
|
|
|
}
|
2017-08-28 17:13:24 +00:00
|
|
|
|
2020-04-17 21:07:44 +00:00
|
|
|
void logEI(const ErrorInfo & ei) override
|
|
|
|
{
|
2020-04-29 16:14:32 +00:00
|
|
|
std::stringstream oss;
|
2020-07-02 15:04:31 +00:00
|
|
|
showErrorInfo(oss, ei, loggerSettings.showTrace.get());
|
2020-04-17 21:07:44 +00:00
|
|
|
|
|
|
|
log(ei.level, oss.str());
|
|
|
|
}
|
|
|
|
|
2017-08-28 17:13:24 +00:00
|
|
|
void startActivity(ActivityId act, Verbosity lvl, ActivityType type,
|
|
|
|
const std::string & s, const Fields & fields, ActivityId parent)
|
2023-03-02 13:46:28 +00:00
|
|
|
override
|
2017-08-28 17:13:24 +00:00
|
|
|
{
|
|
|
|
if (lvl <= verbosity && !s.empty())
|
|
|
|
log(lvl, s + "...");
|
|
|
|
}
|
2020-06-05 16:20:11 +00:00
|
|
|
|
|
|
|
void result(ActivityId act, ResultType type, const Fields & fields) override
|
|
|
|
{
|
|
|
|
if (type == resBuildLogLine && printBuildLogs) {
|
|
|
|
auto lastLine = fields[0].s;
|
|
|
|
printError(lastLine);
|
|
|
|
}
|
|
|
|
else if (type == resPostBuildLogLine && printBuildLogs) {
|
|
|
|
auto lastLine = fields[0].s;
|
|
|
|
printError("post-build-hook: " + lastLine);
|
|
|
|
}
|
|
|
|
}
|
2016-04-25 13:26:07 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
Verbosity verbosity = lvlInfo;
|
|
|
|
|
2022-02-25 15:00:00 +00:00
|
|
|
void writeToStderr(std::string_view s)
|
2016-04-25 13:26:07 +00:00
|
|
|
{
|
|
|
|
try {
|
2016-09-16 16:52:42 +00:00
|
|
|
writeFull(STDERR_FILENO, s, false);
|
2016-04-25 13:26:07 +00:00
|
|
|
} catch (SysError & e) {
|
2016-09-16 16:52:42 +00:00
|
|
|
/* Ignore failing writes to stderr. We need to ignore write
|
|
|
|
errors to ensure that cleanup code that logs to stderr runs
|
|
|
|
to completion if the other side of stderr has been closed
|
|
|
|
unexpectedly. */
|
2016-04-25 13:26:07 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-07-02 15:04:31 +00:00
|
|
|
Logger * makeSimpleLogger(bool printBuildLogs)
|
2016-04-25 13:26:07 +00:00
|
|
|
{
|
2020-07-02 15:04:31 +00:00
|
|
|
return new SimpleLogger(printBuildLogs);
|
2016-04-25 13:26:07 +00:00
|
|
|
}
|
|
|
|
|
2022-12-07 11:58:58 +00:00
|
|
|
std::atomic<uint64_t> nextId{0};
|
2017-05-16 14:09:57 +00:00
|
|
|
|
2017-08-28 17:13:24 +00:00
|
|
|
Activity::Activity(Logger & logger, Verbosity lvl, ActivityType type,
|
2017-08-25 15:49:40 +00:00
|
|
|
const std::string & s, const Logger::Fields & fields, ActivityId parent)
|
2022-12-07 11:58:58 +00:00
|
|
|
: logger(logger), id(nextId++ + (((uint64_t) getpid()) << 32))
|
2017-08-14 20:42:17 +00:00
|
|
|
{
|
2017-08-28 17:13:24 +00:00
|
|
|
logger.startActivity(id, lvl, type, s, fields, parent);
|
2017-08-14 20:42:17 +00:00
|
|
|
}
|
|
|
|
|
2022-12-12 23:48:04 +00:00
|
|
|
void to_json(nlohmann::json & json, std::shared_ptr<AbstractPos> pos)
|
|
|
|
{
|
|
|
|
if (pos) {
|
|
|
|
json["line"] = pos->line;
|
|
|
|
json["column"] = pos->column;
|
|
|
|
std::ostringstream str;
|
|
|
|
pos->print(str);
|
|
|
|
json["file"] = str.str();
|
|
|
|
} else {
|
|
|
|
json["line"] = nullptr;
|
|
|
|
json["column"] = nullptr;
|
|
|
|
json["file"] = nullptr;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-04-29 16:14:32 +00:00
|
|
|
struct JSONLogger : Logger {
|
2017-10-24 11:41:52 +00:00
|
|
|
Logger & prevLogger;
|
|
|
|
|
|
|
|
JSONLogger(Logger & prevLogger) : prevLogger(prevLogger) { }
|
|
|
|
|
2020-06-05 16:20:11 +00:00
|
|
|
bool isVerbose() override {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2017-10-24 11:41:52 +00:00
|
|
|
void addFields(nlohmann::json & json, const Fields & fields)
|
|
|
|
{
|
|
|
|
if (fields.empty()) return;
|
|
|
|
auto & arr = json["fields"] = nlohmann::json::array();
|
|
|
|
for (auto & f : fields)
|
|
|
|
if (f.type == Logger::Field::tInt)
|
|
|
|
arr.push_back(f.i);
|
|
|
|
else if (f.type == Logger::Field::tString)
|
|
|
|
arr.push_back(f.s);
|
|
|
|
else
|
|
|
|
abort();
|
|
|
|
}
|
|
|
|
|
|
|
|
void write(const nlohmann::json & json)
|
|
|
|
{
|
2021-08-21 21:26:22 +00:00
|
|
|
prevLogger.log(lvlError, "@nix " + json.dump(-1, ' ', false, nlohmann::json::error_handler_t::replace));
|
2017-10-24 11:41:52 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void log(Verbosity lvl, const FormatOrString & fs) override
|
|
|
|
{
|
|
|
|
nlohmann::json json;
|
|
|
|
json["action"] = "msg";
|
|
|
|
json["level"] = lvl;
|
|
|
|
json["msg"] = fs.s;
|
|
|
|
write(json);
|
|
|
|
}
|
|
|
|
|
2020-04-17 21:07:44 +00:00
|
|
|
void logEI(const ErrorInfo & ei) override
|
|
|
|
{
|
2020-04-17 21:50:46 +00:00
|
|
|
std::ostringstream oss;
|
2020-07-02 15:04:31 +00:00
|
|
|
showErrorInfo(oss, ei, loggerSettings.showTrace.get());
|
2020-04-17 21:50:46 +00:00
|
|
|
|
|
|
|
nlohmann::json json;
|
|
|
|
json["action"] = "msg";
|
|
|
|
json["level"] = ei.level;
|
|
|
|
json["msg"] = oss.str();
|
2021-01-20 23:27:36 +00:00
|
|
|
json["raw_msg"] = ei.msg.str();
|
2022-12-12 23:48:04 +00:00
|
|
|
to_json(json, ei.errPos);
|
libutil/logging: extend `internal-json` logger to make it more machine-readable
The new error-format is pretty nice from a UX point-of-view, however
it's fairly hard to parse the output e.g. for editor plugins such as
vim-ale[1] that use `nix-instantiate --parse` to determine syntax errors in
Nix expression files.
This patch extends the `internal-json` logger by adding the fields
`line`, `column` and `file` to easily locate an error in a file and the
field `raw_msg` which contains the error-message itself without
code-lines and additional helpers.
An exemplary output may look like this:
```
[nix-shell]$ ./inst/bin/nix-instantiate ~/test.nix --log-format minimal
{"action":"msg","column":1,"file":"/home/ma27/test.nix","level":0,"line":4,"raw_msg":"syntax error, unexpected IF, expecting $end","msg":"<full error-msg with code-lines etc>"}
```
[1] https://github.com/dense-analysis/ale
2020-07-21 21:38:18 +00:00
|
|
|
|
|
|
|
if (loggerSettings.showTrace.get() && !ei.traces.empty()) {
|
|
|
|
nlohmann::json traces = nlohmann::json::array();
|
|
|
|
for (auto iter = ei.traces.rbegin(); iter != ei.traces.rend(); ++iter) {
|
|
|
|
nlohmann::json stackFrame;
|
|
|
|
stackFrame["raw_msg"] = iter->hint.str();
|
2022-12-12 23:48:04 +00:00
|
|
|
to_json(stackFrame, iter->pos);
|
libutil/logging: extend `internal-json` logger to make it more machine-readable
The new error-format is pretty nice from a UX point-of-view, however
it's fairly hard to parse the output e.g. for editor plugins such as
vim-ale[1] that use `nix-instantiate --parse` to determine syntax errors in
Nix expression files.
This patch extends the `internal-json` logger by adding the fields
`line`, `column` and `file` to easily locate an error in a file and the
field `raw_msg` which contains the error-message itself without
code-lines and additional helpers.
An exemplary output may look like this:
```
[nix-shell]$ ./inst/bin/nix-instantiate ~/test.nix --log-format minimal
{"action":"msg","column":1,"file":"/home/ma27/test.nix","level":0,"line":4,"raw_msg":"syntax error, unexpected IF, expecting $end","msg":"<full error-msg with code-lines etc>"}
```
[1] https://github.com/dense-analysis/ale
2020-07-21 21:38:18 +00:00
|
|
|
traces.push_back(stackFrame);
|
|
|
|
}
|
|
|
|
|
|
|
|
json["trace"] = traces;
|
|
|
|
}
|
2020-04-17 21:50:46 +00:00
|
|
|
|
|
|
|
write(json);
|
2020-04-17 21:07:44 +00:00
|
|
|
}
|
|
|
|
|
2017-10-24 11:41:52 +00:00
|
|
|
void startActivity(ActivityId act, Verbosity lvl, ActivityType type,
|
|
|
|
const std::string & s, const Fields & fields, ActivityId parent) override
|
|
|
|
{
|
|
|
|
nlohmann::json json;
|
|
|
|
json["action"] = "start";
|
|
|
|
json["id"] = act;
|
|
|
|
json["level"] = lvl;
|
|
|
|
json["type"] = type;
|
|
|
|
json["text"] = s;
|
|
|
|
addFields(json, fields);
|
|
|
|
// FIXME: handle parent
|
|
|
|
write(json);
|
|
|
|
}
|
|
|
|
|
|
|
|
void stopActivity(ActivityId act) override
|
|
|
|
{
|
|
|
|
nlohmann::json json;
|
|
|
|
json["action"] = "stop";
|
|
|
|
json["id"] = act;
|
|
|
|
write(json);
|
|
|
|
}
|
|
|
|
|
|
|
|
void result(ActivityId act, ResultType type, const Fields & fields) override
|
|
|
|
{
|
|
|
|
nlohmann::json json;
|
|
|
|
json["action"] = "result";
|
|
|
|
json["id"] = act;
|
|
|
|
json["type"] = type;
|
|
|
|
addFields(json, fields);
|
|
|
|
write(json);
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
Logger * makeJSONLogger(Logger & prevLogger)
|
|
|
|
{
|
|
|
|
return new JSONLogger(prevLogger);
|
|
|
|
}
|
|
|
|
|
|
|
|
static Logger::Fields getFields(nlohmann::json & json)
|
|
|
|
{
|
|
|
|
Logger::Fields fields;
|
|
|
|
for (auto & f : json) {
|
|
|
|
if (f.type() == nlohmann::json::value_t::number_unsigned)
|
|
|
|
fields.emplace_back(Logger::Field(f.get<uint64_t>()));
|
|
|
|
else if (f.type() == nlohmann::json::value_t::string)
|
|
|
|
fields.emplace_back(Logger::Field(f.get<std::string>()));
|
|
|
|
else throw Error("unsupported JSON type %d", (int) f.type());
|
|
|
|
}
|
|
|
|
return fields;
|
|
|
|
}
|
|
|
|
|
2022-02-19 21:34:50 +00:00
|
|
|
std::optional<nlohmann::json> parseJSONMessage(const std::string & msg)
|
2017-10-24 11:41:52 +00:00
|
|
|
{
|
2022-02-19 21:34:50 +00:00
|
|
|
if (!hasPrefix(msg, "@nix ")) return std::nullopt;
|
2017-10-24 11:41:52 +00:00
|
|
|
try {
|
2022-02-19 21:34:50 +00:00
|
|
|
return nlohmann::json::parse(std::string(msg, 5));
|
|
|
|
} catch (std::exception & e) {
|
|
|
|
printError("bad JSON log message from builder: %s", e.what());
|
|
|
|
}
|
|
|
|
return std::nullopt;
|
|
|
|
}
|
2017-10-24 11:41:52 +00:00
|
|
|
|
2022-02-19 21:34:50 +00:00
|
|
|
bool handleJSONLogMessage(nlohmann::json & json,
|
|
|
|
const Activity & act, std::map<ActivityId, Activity> & activities,
|
|
|
|
bool trusted)
|
|
|
|
{
|
|
|
|
std::string action = json["action"];
|
|
|
|
|
|
|
|
if (action == "start") {
|
|
|
|
auto type = (ActivityType) json["type"];
|
|
|
|
if (trusted || type == actFileTransfer)
|
|
|
|
activities.emplace(std::piecewise_construct,
|
|
|
|
std::forward_as_tuple(json["id"]),
|
|
|
|
std::forward_as_tuple(*logger, (Verbosity) json["level"], type,
|
|
|
|
json["text"], getFields(json["fields"]), act.id));
|
|
|
|
}
|
2017-10-24 11:41:52 +00:00
|
|
|
|
2022-02-19 21:34:50 +00:00
|
|
|
else if (action == "stop")
|
|
|
|
activities.erase((ActivityId) json["id"]);
|
2017-10-24 11:41:52 +00:00
|
|
|
|
2022-02-19 21:34:50 +00:00
|
|
|
else if (action == "result") {
|
|
|
|
auto i = activities.find((ActivityId) json["id"]);
|
|
|
|
if (i != activities.end())
|
|
|
|
i->second.result((ResultType) json["type"], getFields(json["fields"]));
|
|
|
|
}
|
2017-10-24 11:41:52 +00:00
|
|
|
|
2022-02-19 21:34:50 +00:00
|
|
|
else if (action == "setPhase") {
|
|
|
|
std::string phase = json["phase"];
|
|
|
|
act.result(resSetPhase, phase);
|
|
|
|
}
|
2017-10-24 11:41:52 +00:00
|
|
|
|
2022-02-19 21:34:50 +00:00
|
|
|
else if (action == "msg") {
|
|
|
|
std::string msg = json["msg"];
|
|
|
|
logger->log((Verbosity) json["level"], msg);
|
2017-10-24 11:41:52 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2022-02-19 21:34:50 +00:00
|
|
|
bool handleJSONLogMessage(const std::string & msg,
|
|
|
|
const Activity & act, std::map<ActivityId, Activity> & activities, bool trusted)
|
|
|
|
{
|
|
|
|
auto json = parseJSONMessage(msg);
|
|
|
|
if (!json) return false;
|
|
|
|
|
|
|
|
return handleJSONLogMessage(*json, act, activities, trusted);
|
|
|
|
}
|
|
|
|
|
2020-04-29 16:14:32 +00:00
|
|
|
Activity::~Activity()
|
|
|
|
{
|
2018-03-03 20:39:04 +00:00
|
|
|
try {
|
|
|
|
logger.stopActivity(id);
|
|
|
|
} catch (...) {
|
|
|
|
ignoreException();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-04-25 13:26:07 +00:00
|
|
|
}
|