[clang-tools-extra] 524fe51 - [clangd] Add basic monitoring info request for remote index server
Kirill Bobyrev via cfe-commits
cfe-commits at lists.llvm.org
Tue Mar 16 05:38:13 PDT 2021
Author: Kirill Bobyrev
Date: 2021-03-16T13:37:58+01:00
New Revision: 524fe515091d31e1c054fc521113a3bf2088d159
URL: https://github.com/llvm/llvm-project/commit/524fe515091d31e1c054fc521113a3bf2088d159
DIFF: https://github.com/llvm/llvm-project/commit/524fe515091d31e1c054fc521113a3bf2088d159.diff
LOG: [clangd] Add basic monitoring info request for remote index server
This allows requesting information about the server uptime and start time. This is the first patch in a series of monitoring changes, hence it's not immediately useful. Next step is propagating the index freshness information and then probably loading metadata into the index server.
The way to test new behaviour through command line:
```
$ grpc_cli call localhost:50051 Monitor/MonitoringInfo ''
connecting to localhost:50051
uptime_seconds: 42
index_age_seconds: 609568
Rpc succeeded with OK status
```
Reviewed By: kadircet
Differential Revision: https://reviews.llvm.org/D98246
Added:
clang-tools-extra/clangd/index/remote/MonitoringService.proto
Modified:
clang-tools-extra/clangd/index/remote/CMakeLists.txt
clang-tools-extra/clangd/index/remote/Service.proto
clang-tools-extra/clangd/index/remote/server/Server.cpp
Removed:
################################################################################
diff --git a/clang-tools-extra/clangd/index/remote/CMakeLists.txt b/clang-tools-extra/clangd/index/remote/CMakeLists.txt
index eaa000b745e5..ded3f9274f86 100644
--- a/clang-tools-extra/clangd/index/remote/CMakeLists.txt
+++ b/clang-tools-extra/clangd/index/remote/CMakeLists.txt
@@ -1,5 +1,7 @@
if (CLANGD_ENABLE_REMOTE)
generate_protos(RemoteIndexProto "Index.proto")
+ generate_protos(MonitoringServiceProto "MonitoringService.proto"
+ GRPC)
generate_protos(RemoteIndexServiceProto "Service.proto"
DEPENDS "Index.proto"
GRPC)
@@ -8,6 +10,7 @@ if (CLANGD_ENABLE_REMOTE)
target_link_libraries(RemoteIndexServiceProto
PRIVATE
RemoteIndexProto
+ MonitoringServiceProto
)
include_directories(${CMAKE_CURRENT_BINARY_DIR})
include_directories(${CMAKE_CURRENT_SOURCE_DIR}/../../)
diff --git a/clang-tools-extra/clangd/index/remote/MonitoringService.proto b/clang-tools-extra/clangd/index/remote/MonitoringService.proto
new file mode 100644
index 000000000000..75d807c19005
--- /dev/null
+++ b/clang-tools-extra/clangd/index/remote/MonitoringService.proto
@@ -0,0 +1,27 @@
+//===--- MonitoringService.proto - CLangd Remote index monitoring service -===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+syntax = "proto2";
+
+package clang.clangd.remote.v1;
+
+message MonitoringInfoRequest {}
+message MonitoringInfoReply {
+ // Time since the server started (in seconds).
+ optional uint64 uptime_seconds = 1;
+ // Time since the index was built on the indexing machine.
+ optional uint64 index_age_seconds = 2;
+ // ID of the indexed commit in Version Control System.
+ optional string index_commit_hash = 3;
+ // URL to the index file.
+ optional string index_link = 4;
+}
+
+service Monitor {
+ rpc MonitoringInfo(MonitoringInfoRequest) returns (MonitoringInfoReply) {}
+}
diff --git a/clang-tools-extra/clangd/index/remote/Service.proto b/clang-tools-extra/clangd/index/remote/Service.proto
index 4e39ff9ec666..7c7efa530200 100644
--- a/clang-tools-extra/clangd/index/remote/Service.proto
+++ b/clang-tools-extra/clangd/index/remote/Service.proto
@@ -23,4 +23,3 @@ service SymbolIndex {
rpc Relations(RelationsRequest) returns (stream RelationsReply) {}
}
-
diff --git a/clang-tools-extra/clangd/index/remote/server/Server.cpp b/clang-tools-extra/clangd/index/remote/server/Server.cpp
index be0e844a1f80..f3cf131bb8a5 100644
--- a/clang-tools-extra/clangd/index/remote/server/Server.cpp
+++ b/clang-tools-extra/clangd/index/remote/server/Server.cpp
@@ -8,7 +8,10 @@
#include "Features.inc"
#include "Index.pb.h"
+#include "MonitoringService.grpc.pb.h"
+#include "MonitoringService.pb.h"
#include "Service.grpc.pb.h"
+#include "Service.pb.h"
#include "index/Index.h"
#include "index/Serialization.h"
#include "index/Symbol.h"
@@ -288,11 +291,46 @@ class RemoteIndexServer final : public v1::SymbolIndex::Service {
clangd::SymbolIndex &Index;
};
+class Monitor final : public v1::Monitor::Service {
+public:
+ Monitor(llvm::sys::TimePoint<> IndexAge)
+ : StartTime(std::chrono::system_clock::now()), IndexBuildTime(IndexAge) {}
+
+ void updateIndex(llvm::sys::TimePoint<> UpdateTime) {
+ IndexBuildTime.exchange(UpdateTime);
+ }
+
+private:
+ // FIXME(kirillbobyrev): Most fields should be populated when the index
+ // reloads (probably in adjacent metadata.txt file next to loaded .idx) but
+ // they aren't right now.
+ grpc::Status MonitoringInfo(grpc::ServerContext *Context,
+ const v1::MonitoringInfoRequest *Request,
+ v1::MonitoringInfoReply *Reply) override {
+ Reply->set_uptime_seconds(std::chrono::duration_cast<std::chrono::seconds>(
+ std::chrono::system_clock::now() - StartTime)
+ .count());
+ // FIXME(kirillbobyrev): We are currently making use of the last
+ // modification time of the index artifact to deduce its age. This is wrong
+ // as it doesn't account for the indexing delay. Propagate some metadata
+ // with the index artifacts to indicate time of the commit we indexed.
+ Reply->set_index_age_seconds(
+ std::chrono::duration_cast<std::chrono::seconds>(
+ std::chrono::system_clock::now() - IndexBuildTime.load())
+ .count());
+ return grpc::Status::OK;
+ }
+
+ const llvm::sys::TimePoint<> StartTime;
+ std::atomic<llvm::sys::TimePoint<>> IndexBuildTime;
+};
+
// Detect changes in \p IndexPath file and load new versions of the index
// whenever they become available.
void hotReload(clangd::SwapIndex &Index, llvm::StringRef IndexPath,
llvm::vfs::Status &LastStatus,
- llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> &FS) {
+ llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> &FS,
+ Monitor &Monitor) {
auto Status = FS->status(IndexPath);
// Requested file is same as loaded index: no reload is needed.
if (!Status || (Status->getLastModificationTime() ==
@@ -309,12 +347,13 @@ void hotReload(clangd::SwapIndex &Index, llvm::StringRef IndexPath,
return;
}
Index.reset(std::move(NewIndex));
+ Monitor.updateIndex(Status->getLastModificationTime());
log("New index version loaded. Last modification time: {0}, size: {1} bytes.",
Status->getLastModificationTime(), Status->getSize());
}
void runServerAndWait(clangd::SymbolIndex &Index, llvm::StringRef ServerAddress,
- llvm::StringRef IndexPath) {
+ llvm::StringRef IndexPath, Monitor &Monitor) {
RemoteIndexServer Service(Index, IndexRoot);
grpc::EnableDefaultHealthCheckService(true);
@@ -327,6 +366,7 @@ void runServerAndWait(clangd::SymbolIndex &Index, llvm::StringRef ServerAddress,
Builder.AddChannelArgument(GRPC_ARG_MAX_CONNECTION_IDLE_MS,
IdleTimeoutSeconds * 1000);
Builder.RegisterService(&Service);
+ Builder.RegisterService(&Monitor);
std::unique_ptr<grpc::Server> Server(Builder.BuildAndStart());
log("Server listening on {0}", ServerAddress);
@@ -425,16 +465,18 @@ int main(int argc, char *argv[]) {
}
clang::clangd::SwapIndex Index(std::move(SymIndex));
- std::thread HotReloadThread([&Index, &Status, &FS]() {
+ Monitor Monitor(Status->getLastModificationTime());
+
+ std::thread HotReloadThread([&Index, &Status, &FS, &Monitor]() {
llvm::vfs::Status LastStatus = *Status;
static constexpr auto RefreshFrequency = std::chrono::seconds(30);
while (!clang::clangd::shutdownRequested()) {
- hotReload(Index, llvm::StringRef(IndexPath), LastStatus, FS);
+ hotReload(Index, llvm::StringRef(IndexPath), LastStatus, FS, Monitor);
std::this_thread::sleep_for(RefreshFrequency);
}
});
- runServerAndWait(Index, ServerAddress, IndexPath);
+ runServerAndWait(Index, ServerAddress, IndexPath, Monitor);
HotReloadThread.join();
}
More information about the cfe-commits
mailing list