2 * collectd - src/grpc.cc
3 * Copyright (C) 2015-2016 Sebastian Harl
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
24 * Sebastian Harl <sh at tokkee.org>
27 #include <grpc++/grpc++.h>
28 #include <google/protobuf/util/time_util.h>
34 #include "collectd.grpc.pb.h"
42 #include "configfile.h"
45 #include "daemon/utils_cache.h"
48 using collectd::Collectd;
50 using collectd::DispatchValuesRequest;
51 using collectd::DispatchValuesReply;
52 using collectd::QueryValuesRequest;
53 using collectd::QueryValuesReply;
55 using google::protobuf::util::TimeUtil;
65 grpc::SslServerCredentialsOptions *ssl;
67 static std::vector<Listener> listeners;
68 static grpc::string default_addr("0.0.0.0:50051");
74 static bool ident_matches(const value_list_t *vl, const value_list_t *matcher)
76 if (fnmatch(matcher->host, vl->host, 0))
79 if (fnmatch(matcher->plugin, vl->plugin, 0))
81 if (fnmatch(matcher->plugin_instance, vl->plugin_instance, 0))
84 if (fnmatch(matcher->type, vl->type, 0))
86 if (fnmatch(matcher->type_instance, vl->type_instance, 0))
92 static grpc::string read_file(const char *filename)
95 grpc::string s, content;
99 ERROR("grpc: Failed to open '%s'", filename);
103 while (std::getline(f, s)) {
105 content.push_back('\n');
115 static void marshal_ident(const value_list_t *vl, collectd::types::Identifier *msg)
117 msg->set_host(vl->host);
118 msg->set_plugin(vl->plugin);
119 if (vl->plugin_instance[0] != '\0')
120 msg->set_plugin_instance(vl->plugin_instance);
121 msg->set_type(vl->type);
122 if (vl->type_instance[0] != '\0')
123 msg->set_type_instance(vl->type_instance);
124 } /* marshal_ident */
126 static grpc::Status unmarshal_ident(const collectd::types::Identifier &msg, value_list_t *vl,
132 if (!s.length() && require_fields)
133 return grpc::Status(grpc::StatusCode::INVALID_ARGUMENT,
134 grpc::string("missing host name"));
135 sstrncpy(vl->host, s.c_str(), sizeof(vl->host));
138 if (!s.length() && require_fields)
139 return grpc::Status(grpc::StatusCode::INVALID_ARGUMENT,
140 grpc::string("missing plugin name"));
141 sstrncpy(vl->plugin, s.c_str(), sizeof(vl->plugin));
144 if (!s.length() && require_fields)
145 return grpc::Status(grpc::StatusCode::INVALID_ARGUMENT,
146 grpc::string("missing type name"));
147 sstrncpy(vl->type, s.c_str(), sizeof(vl->type));
149 s = msg.plugin_instance();
150 sstrncpy(vl->plugin_instance, s.c_str(), sizeof(vl->plugin_instance));
152 s = msg.type_instance();
153 sstrncpy(vl->type_instance, s.c_str(), sizeof(vl->type_instance));
155 return grpc::Status::OK;
156 } /* unmarshal_ident() */
158 static grpc::Status marshal_value_list(const value_list_t *vl, collectd::types::ValueList *msg)
160 auto id = msg->mutable_identifier();
161 marshal_ident(vl, id);
163 auto ds = plugin_get_ds(vl->type);
164 if ((ds == NULL) || (ds->ds_num != vl->values_len)) {
165 return grpc::Status(grpc::StatusCode::INTERNAL,
166 grpc::string("failed to retrieve data-set for values"));
169 auto t = TimeUtil::NanosecondsToTimestamp(CDTIME_T_TO_NS(vl->time));
170 auto d = TimeUtil::NanosecondsToDuration(CDTIME_T_TO_NS(vl->interval));
171 msg->set_allocated_time(new google::protobuf::Timestamp(t));
172 msg->set_allocated_interval(new google::protobuf::Duration(d));
174 for (size_t i = 0; i < vl->values_len; ++i) {
175 auto v = msg->add_value();
176 switch (ds->ds[i].type) {
177 case DS_TYPE_COUNTER:
178 v->set_counter(vl->values[i].counter);
181 v->set_gauge(vl->values[i].gauge);
184 v->set_derive(vl->values[i].derive);
186 case DS_TYPE_ABSOLUTE:
187 v->set_absolute(vl->values[i].absolute);
190 return grpc::Status(grpc::StatusCode::INTERNAL,
191 grpc::string("unknown value type"));
195 return grpc::Status::OK;
196 } /* marshal_value_list */
198 static grpc::Status unmarshal_value_list(const collectd::types::ValueList &msg, value_list_t *vl)
200 vl->time = NS_TO_CDTIME_T(TimeUtil::TimestampToNanoseconds(msg.time()));
201 vl->interval = NS_TO_CDTIME_T(TimeUtil::DurationToNanoseconds(msg.interval()));
203 auto status = unmarshal_ident(msg.identifier(), vl, true);
207 value_t *values = NULL;
208 size_t values_len = 0;
210 status = grpc::Status::OK;
211 for (auto v : msg.value()) {
212 value_t *val = (value_t *)realloc(values, (values_len + 1) * sizeof(*values));
214 status = grpc::Status(grpc::StatusCode::RESOURCE_EXHAUSTED,
215 grpc::string("failed to allocate values array"));
220 val = values + values_len;
223 switch (v.value_case()) {
224 case collectd::types::Value::ValueCase::kCounter:
225 val->counter = counter_t(v.counter());
227 case collectd::types::Value::ValueCase::kGauge:
228 val->gauge = gauge_t(v.gauge());
230 case collectd::types::Value::ValueCase::kDerive:
231 val->derive = derive_t(v.derive());
233 case collectd::types::Value::ValueCase::kAbsolute:
234 val->absolute = absolute_t(v.absolute());
237 status = grpc::Status(grpc::StatusCode::INVALID_ARGUMENT,
238 grpc::string("unknown value type"));
247 vl->values_len = values_len;
254 } /* unmarshal_value_list() */
257 * request call-backs and call objects
260 static grpc::Status Process(grpc::ServerContext *ctx,
261 DispatchValuesRequest request, DispatchValuesReply *reply)
263 value_list_t vl = VALUE_LIST_INIT;
264 auto status = unmarshal_value_list(request.values(), &vl);
268 if (plugin_dispatch_values(&vl))
269 status = grpc::Status(grpc::StatusCode::INTERNAL,
270 grpc::string("failed to enqueue values for writing"));
272 } /* Process(): DispatchValues */
274 static grpc::Status Process(grpc::ServerContext *ctx,
275 QueryValuesRequest request, QueryValuesReply *reply)
280 value_list_t matcher;
281 auto status = unmarshal_ident(request.identifier(), &matcher, false);
285 if ((iter = uc_get_iterator()) == NULL) {
286 return grpc::Status(grpc::StatusCode::INTERNAL,
287 grpc::string("failed to query values: cannot create iterator"));
290 status = grpc::Status::OK;
291 while (uc_iterator_next(iter, &name) == 0) {
293 if (parse_identifier_vl(name, &res) != 0) {
294 status = grpc::Status(grpc::StatusCode::INTERNAL,
295 grpc::string("failed to parse identifier"));
299 if (!ident_matches(&res, &matcher))
302 if (uc_iterator_get_time(iter, &res.time) < 0) {
303 status = grpc::Status(grpc::StatusCode::INTERNAL,
304 grpc::string("failed to retrieve value timestamp"));
307 if (uc_iterator_get_interval(iter, &res.interval) < 0) {
308 status = grpc::Status(grpc::StatusCode::INTERNAL,
309 grpc::string("failed to retrieve value interval"));
312 if (uc_iterator_get_values(iter, &res.values, &res.values_len) < 0) {
313 status = grpc::Status(grpc::StatusCode::INTERNAL,
314 grpc::string("failed to retrieve values"));
318 auto vl = reply->add_values();
319 status = marshal_value_list(&res, vl);
325 uc_iterator_destroy(iter);
328 } /* Process(): QueryValues */
333 Call(Collectd::AsyncService *service, grpc::ServerCompletionQueue *cq)
334 : service_(service), cq_(cq), status_(CREATE)
342 if (status_ == CREATE) {
346 else if (status_ == PROCESS) {
351 GPR_ASSERT(status_ == FINISH);
357 virtual void Create() = 0;
358 virtual void Process() = 0;
359 virtual void Finish() = 0;
361 Collectd::AsyncService *service_;
362 grpc::ServerCompletionQueue *cq_;
363 grpc::ServerContext ctx_;
366 enum CallStatus { CREATE, PROCESS, FINISH };
370 template<typename RequestT, typename ReplyT>
371 class RpcCall final : public Call
373 typedef void (Collectd::AsyncService::*CreatorT)(grpc::ServerContext *,
374 RequestT *, grpc::ServerAsyncResponseWriter<ReplyT> *,
375 grpc::CompletionQueue *, grpc::ServerCompletionQueue *, void *);
378 RpcCall(Collectd::AsyncService *service,
379 CreatorT creator, grpc::ServerCompletionQueue *cq)
380 : Call(service, cq), creator_(creator), responder_(&ctx_)
391 (service_->*creator_)(&ctx_, &request_, &responder_, cq_, cq_, this);
396 // Add a new request object to the queue.
397 new RpcCall<RequestT, ReplyT>(service_, creator_, cq_);
398 grpc::Status status = ::Process(&ctx_, request_, &reply_);
399 responder_.Finish(reply_, status, this);
412 grpc::ServerAsyncResponseWriter<ReplyT> responder_;
413 }; /* class RpcCall */
416 * gRPC server implementation
419 class CollectdServer final
424 auto auth = grpc::InsecureServerCredentials();
426 grpc::ServerBuilder builder;
428 if (listeners.empty()) {
429 builder.AddListeningPort(default_addr, auth);
430 INFO("grpc: Listening on %s", default_addr.c_str());
433 for (auto l : listeners) {
434 grpc::string addr = l.addr + ":" + l.port;
436 auto use_ssl = grpc::string("");
438 if (l.ssl != nullptr) {
439 use_ssl = grpc::string(" (SSL enabled)");
440 a = grpc::SslServerCredentials(*l.ssl);
443 builder.AddListeningPort(addr, a);
444 INFO("grpc: Listening on %s%s", addr.c_str(), use_ssl.c_str());
448 builder.RegisterService(&service_);
449 cq_ = builder.AddCompletionQueue();
450 server_ = builder.BuildAndStart();
461 // Register request types.
462 new RpcCall<DispatchValuesRequest, DispatchValuesReply>(&service_,
463 &Collectd::AsyncService::RequestDispatchValues, cq_.get());
464 new RpcCall<QueryValuesRequest, QueryValuesReply>(&service_,
465 &Collectd::AsyncService::RequestQueryValues, cq_.get());
471 if (!cq_->Next(&req, &ok))
472 break; // Queue shut down.
474 ERROR("grpc: Failed to read from queue");
478 static_cast<Call *>(req)->Handle();
483 Collectd::AsyncService service_;
485 std::unique_ptr<grpc::Server> server_;
486 std::unique_ptr<grpc::ServerCompletionQueue> cq_;
487 }; /* class CollectdServer */
489 static CollectdServer *server = nullptr;
492 * collectd plugin interface
496 static pthread_t *workers;
497 static size_t workers_num = 5;
499 static void *worker_thread(void *arg)
501 CollectdServer *s = (CollectdServer *)arg;
504 } /* worker_thread() */
506 static int c_grpc_config_listen(oconfig_item_t *ci)
508 if ((ci->values_num != 2)
509 || (ci->values[0].type != OCONFIG_TYPE_STRING)
510 || (ci->values[1].type != OCONFIG_TYPE_STRING)) {
511 ERROR("grpc: The `%s` config option needs exactly "
512 "two string argument (address and port).", ci->key);
516 auto listener = Listener();
517 listener.addr = grpc::string(ci->values[0].value.string);
518 listener.port = grpc::string(ci->values[1].value.string);
519 listener.ssl = nullptr;
521 auto ssl_opts = new(grpc::SslServerCredentialsOptions);
522 grpc::SslServerCredentialsOptions::PemKeyCertPair pkcp = {};
523 bool use_ssl = false;
525 for (int i = 0; i < ci->children_num; i++) {
526 oconfig_item_t *child = ci->children + i;
528 if (!strcasecmp("EnableSSL", child->key)) {
529 if (cf_util_get_boolean(child, &use_ssl)) {
530 ERROR("grpc: Option `%s` expects a boolean value",
535 else if (!strcasecmp("SSLRootCerts", child->key)) {
537 if (cf_util_get_string(child, &certs)) {
538 ERROR("grpc: Option `%s` expects a string value",
542 ssl_opts->pem_root_certs = read_file(certs);
544 else if (!strcasecmp("SSLServerKey", child->key)) {
546 if (cf_util_get_string(child, &key)) {
547 ERROR("grpc: Option `%s` expects a string value",
551 pkcp.private_key = read_file(key);
553 else if (!strcasecmp("SSLServerCert", child->key)) {
555 if (cf_util_get_string(child, &cert)) {
556 ERROR("grpc: Option `%s` expects a string value",
560 pkcp.cert_chain = read_file(cert);
563 WARNING("grpc: Option `%s` not allowed in <%s> block.",
564 child->key, ci->key);
568 ssl_opts->pem_key_cert_pairs.push_back(pkcp);
570 listener.ssl = ssl_opts;
574 listeners.push_back(listener);
576 } /* c_grpc_config_listen() */
578 static int c_grpc_config(oconfig_item_t *ci)
582 for (i = 0; i < ci->children_num; i++) {
583 oconfig_item_t *child = ci->children + i;
585 if (!strcasecmp("Listen", child->key)) {
586 if (c_grpc_config_listen(child))
589 else if (!strcasecmp("WorkerThreads", child->key)) {
591 if (cf_util_get_int(child, &n))
593 workers_num = (size_t)n;
596 WARNING("grpc: Option `%s` not allowed here.", child->key);
601 } /* c_grpc_config() */
603 static int c_grpc_init(void)
605 server = new CollectdServer();
609 ERROR("grpc: Failed to create server");
613 workers = (pthread_t *)calloc(workers_num, sizeof(*workers));
618 ERROR("grpc: Failed to allocate worker threads");
623 for (i = 0; i < workers_num; i++) {
624 plugin_thread_create(&workers[i], /* attr = */ NULL,
625 worker_thread, server);
627 INFO("grpc: Started %zu workers", workers_num);
629 } /* c_grpc_init() */
631 static int c_grpc_shutdown(void)
640 INFO("grpc: Waiting for %zu workers to terminate", workers_num);
641 for (i = 0; i < workers_num; i++)
642 pthread_join(workers[i], NULL);
651 } /* c_grpc_shutdown() */
653 void module_register(void)
655 plugin_register_complex_config("grpc", c_grpc_config);
656 plugin_register_init("grpc", c_grpc_init);
657 plugin_register_shutdown("grpc", c_grpc_shutdown);
658 } /* module_register() */
661 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */