65eaec9bd3
The index server has access to potentially-sensitive information, e.g. a sequence of fuzzyFind requests reveals details about code completions in the editor which in turn reveals details about the code being edited. This information is necessary to provide the service, and our intention[1] is it should never be retained beyond the scope of the request (e.g. not logged). At the same time, some log messages should be exposed: - server startup/index reloads etc that don't pertain to a user request - basic request logs (method, latency, #results, error code) for monitoring - errors while handling requests, without request-specific data The -log=public design accommodates these by allowing three types of logs: - those not associated with any user RPC request (via context-propagation) - those explicitly tagged as [public] in the log line - logging of format strings only, with no interpolated data (error level only) [1] Specifically: Google is likely to run public instances of this server for LLVM and potentially other projects, they will run in this configuration. The details agreed in a Google-internal privacy review. As clangd developers, we'd encourage others to use this configuration for public instances too. Differential Revision: https://reviews.llvm.org/D90526
86 lines
2.5 KiB
C++
86 lines
2.5 KiB
C++
//===--- Logger.cpp - Logger interface for clangd -------------------------===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "support/Logger.h"
|
|
#include "support/Trace.h"
|
|
#include "llvm/Support/Chrono.h"
|
|
#include "llvm/Support/Error.h"
|
|
#include "llvm/Support/FormatVariadic.h"
|
|
#include "llvm/Support/raw_ostream.h"
|
|
#include <mutex>
|
|
|
|
namespace clang {
|
|
namespace clangd {
|
|
|
|
namespace {
|
|
Logger *L = nullptr;
|
|
} // namespace
|
|
|
|
LoggingSession::LoggingSession(clangd::Logger &Instance) {
|
|
assert(!L);
|
|
L = &Instance;
|
|
}
|
|
|
|
LoggingSession::~LoggingSession() { L = nullptr; }
|
|
|
|
void detail::logImpl(Logger::Level Level, const char *Fmt,
|
|
const llvm::formatv_object_base &Message) {
|
|
if (L)
|
|
L->log(Level, Fmt, Message);
|
|
else {
|
|
static std::mutex Mu;
|
|
std::lock_guard<std::mutex> Guard(Mu);
|
|
llvm::errs() << Message << "\n";
|
|
}
|
|
}
|
|
|
|
const char *detail::debugType(const char *Filename) {
|
|
if (const char *Slash = strrchr(Filename, '/'))
|
|
return Slash + 1;
|
|
if (const char *Backslash = strrchr(Filename, '\\'))
|
|
return Backslash + 1;
|
|
return Filename;
|
|
}
|
|
|
|
void StreamLogger::log(Logger::Level Level, const char *Fmt,
|
|
const llvm::formatv_object_base &Message) {
|
|
if (Level < MinLevel)
|
|
return;
|
|
llvm::sys::TimePoint<> Timestamp = std::chrono::system_clock::now();
|
|
trace::log(Message);
|
|
std::lock_guard<std::mutex> Guard(StreamMutex);
|
|
Logs << llvm::formatv("{0}[{1:%H:%M:%S.%L}] {2}\n", indicator(Level),
|
|
Timestamp, Message);
|
|
Logs.flush();
|
|
}
|
|
|
|
namespace {
|
|
// Like llvm::StringError but with fewer options and no gratuitous copies.
|
|
class SimpleStringError : public llvm::ErrorInfo<SimpleStringError> {
|
|
std::error_code EC;
|
|
std::string Message;
|
|
|
|
public:
|
|
SimpleStringError(std::error_code EC, std::string &&Message)
|
|
: EC(EC), Message(std::move(Message)) {}
|
|
void log(llvm::raw_ostream &OS) const override { OS << Message; }
|
|
std::string message() const override { return Message; }
|
|
std::error_code convertToErrorCode() const override { return EC; }
|
|
static char ID;
|
|
};
|
|
char SimpleStringError::ID;
|
|
|
|
} // namespace
|
|
|
|
llvm::Error detail::error(std::error_code EC, std::string &&Msg) {
|
|
return llvm::make_error<SimpleStringError>(EC, std::move(Msg));
|
|
}
|
|
|
|
} // namespace clangd
|
|
} // namespace clang
|