2 * collectd - src/grpc.cc
3 * Copyright (C) 2015-2016 Sebastian Harl
4 * Copyright (C) 2016 Florian octo Forster
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
25 * Sebastian Harl <sh at tokkee.org>
26 * Florian octo Forster <octo at collectd.org>
29 #include <grpc++/grpc++.h>
30 #include <google/protobuf/util/time_util.h>
37 #include "collectd.grpc.pb.h"
47 #include "daemon/utils_cache.h"
50 using collectd::Collectd;
52 using collectd::PutValuesRequest;
53 using collectd::PutValuesResponse;
54 using collectd::QueryValuesRequest;
55 using collectd::QueryValuesResponse;
57 using google::protobuf::util::TimeUtil;
67 grpc::SslServerCredentialsOptions *ssl;
69 static std::vector<Listener> listeners;
70 static grpc::string default_addr("0.0.0.0:50051");
76 static bool ident_matches(const value_list_t *vl, const value_list_t *matcher)
78 if (fnmatch(matcher->host, vl->host, 0))
81 if (fnmatch(matcher->plugin, vl->plugin, 0))
83 if (fnmatch(matcher->plugin_instance, vl->plugin_instance, 0))
86 if (fnmatch(matcher->type, vl->type, 0))
88 if (fnmatch(matcher->type_instance, vl->type_instance, 0))
94 static grpc::string read_file(const char *filename)
97 grpc::string s, content;
101 ERROR("grpc: Failed to open '%s'", filename);
105 while (std::getline(f, s)) {
107 content.push_back('\n');
117 static void marshal_ident(const value_list_t *vl, collectd::types::Identifier *msg)
119 msg->set_host(vl->host);
120 msg->set_plugin(vl->plugin);
121 if (vl->plugin_instance[0] != '\0')
122 msg->set_plugin_instance(vl->plugin_instance);
123 msg->set_type(vl->type);
124 if (vl->type_instance[0] != '\0')
125 msg->set_type_instance(vl->type_instance);
126 } /* marshal_ident */
128 static grpc::Status unmarshal_ident(const collectd::types::Identifier &msg, value_list_t *vl,
134 if (!s.length() && require_fields)
135 return grpc::Status(grpc::StatusCode::INVALID_ARGUMENT,
136 grpc::string("missing host name"));
137 sstrncpy(vl->host, s.c_str(), sizeof(vl->host));
140 if (!s.length() && require_fields)
141 return grpc::Status(grpc::StatusCode::INVALID_ARGUMENT,
142 grpc::string("missing plugin name"));
143 sstrncpy(vl->plugin, s.c_str(), sizeof(vl->plugin));
146 if (!s.length() && require_fields)
147 return grpc::Status(grpc::StatusCode::INVALID_ARGUMENT,
148 grpc::string("missing type name"));
149 sstrncpy(vl->type, s.c_str(), sizeof(vl->type));
151 s = msg.plugin_instance();
152 sstrncpy(vl->plugin_instance, s.c_str(), sizeof(vl->plugin_instance));
154 s = msg.type_instance();
155 sstrncpy(vl->type_instance, s.c_str(), sizeof(vl->type_instance));
157 return grpc::Status::OK;
158 } /* unmarshal_ident() */
160 static grpc::Status marshal_value_list(const value_list_t *vl, collectd::types::ValueList *msg)
162 auto id = msg->mutable_identifier();
163 marshal_ident(vl, id);
165 auto ds = plugin_get_ds(vl->type);
166 if ((ds == NULL) || (ds->ds_num != vl->values_len)) {
167 return grpc::Status(grpc::StatusCode::INTERNAL,
168 grpc::string("failed to retrieve data-set for values"));
171 auto t = TimeUtil::NanosecondsToTimestamp(CDTIME_T_TO_NS(vl->time));
172 auto d = TimeUtil::NanosecondsToDuration(CDTIME_T_TO_NS(vl->interval));
173 msg->set_allocated_time(new google::protobuf::Timestamp(t));
174 msg->set_allocated_interval(new google::protobuf::Duration(d));
176 for (size_t i = 0; i < vl->values_len; ++i) {
177 auto v = msg->add_values();
178 switch (ds->ds[i].type) {
179 case DS_TYPE_COUNTER:
180 v->set_counter(vl->values[i].counter);
183 v->set_gauge(vl->values[i].gauge);
186 v->set_derive(vl->values[i].derive);
188 case DS_TYPE_ABSOLUTE:
189 v->set_absolute(vl->values[i].absolute);
192 return grpc::Status(grpc::StatusCode::INTERNAL,
193 grpc::string("unknown value type"));
196 auto name = msg->add_ds_names();
197 name->assign(ds->ds[i].name);
200 return grpc::Status::OK;
201 } /* marshal_value_list */
203 static grpc::Status unmarshal_value_list(const collectd::types::ValueList &msg, value_list_t *vl)
205 vl->time = NS_TO_CDTIME_T(TimeUtil::TimestampToNanoseconds(msg.time()));
206 vl->interval = NS_TO_CDTIME_T(TimeUtil::DurationToNanoseconds(msg.interval()));
208 auto status = unmarshal_ident(msg.identifier(), vl, true);
212 value_t *values = NULL;
213 size_t values_len = 0;
215 status = grpc::Status::OK;
216 for (auto v : msg.values()) {
217 value_t *val = (value_t *)realloc(values, (values_len + 1) * sizeof(*values));
219 status = grpc::Status(grpc::StatusCode::RESOURCE_EXHAUSTED,
220 grpc::string("failed to allocate values array"));
225 val = values + values_len;
228 switch (v.value_case()) {
229 case collectd::types::Value::ValueCase::kCounter:
230 val->counter = counter_t(v.counter());
232 case collectd::types::Value::ValueCase::kGauge:
233 val->gauge = gauge_t(v.gauge());
235 case collectd::types::Value::ValueCase::kDerive:
236 val->derive = derive_t(v.derive());
238 case collectd::types::Value::ValueCase::kAbsolute:
239 val->absolute = absolute_t(v.absolute());
242 status = grpc::Status(grpc::StatusCode::INVALID_ARGUMENT,
243 grpc::string("unknown value type"));
252 vl->values_len = values_len;
259 } /* unmarshal_value_list() */
264 class CollectdImpl : public collectd::Collectd::Service {
266 grpc::Status QueryValues(grpc::ServerContext *ctx, QueryValuesRequest const *req, grpc::ServerWriter<QueryValuesResponse> *writer) override {
268 auto status = unmarshal_ident(req->identifier(), &match, false);
273 std::queue<value_list_t> value_lists;
274 status = this->queryValuesRead(&match, &value_lists);
276 status = this->queryValuesWrite(ctx, writer, &value_lists);
279 while (!value_lists.empty()) {
280 auto vl = value_lists.front();
288 grpc::Status PutValues(grpc::ServerContext *ctx,
289 grpc::ServerReader<PutValuesRequest> *reader,
290 PutValuesResponse *res) override {
291 PutValuesRequest req;
293 while (reader->Read(&req)) {
294 value_list_t vl = {0};
295 auto status = unmarshal_value_list(req.value_list(), &vl);
299 if (plugin_dispatch_values(&vl))
300 return grpc::Status(grpc::StatusCode::INTERNAL,
301 grpc::string("failed to enqueue values for writing"));
305 return grpc::Status::OK;
309 grpc::Status queryValuesRead(value_list_t const *match, std::queue<value_list_t> *value_lists) {
311 if ((iter = uc_get_iterator()) == NULL) {
312 return grpc::Status(grpc::StatusCode::INTERNAL,
313 grpc::string("failed to query values: cannot create iterator"));
316 grpc::Status status = grpc::Status::OK;
318 while (uc_iterator_next(iter, &name) == 0) {
320 if (parse_identifier_vl(name, &vl) != 0) {
321 status = grpc::Status(grpc::StatusCode::INTERNAL,
322 grpc::string("failed to parse identifier"));
326 if (!ident_matches(&vl, match))
329 if (uc_iterator_get_time(iter, &vl.time) < 0) {
330 status = grpc::Status(grpc::StatusCode::INTERNAL,
331 grpc::string("failed to retrieve value timestamp"));
334 if (uc_iterator_get_interval(iter, &vl.interval) < 0) {
335 status = grpc::Status(grpc::StatusCode::INTERNAL,
336 grpc::string("failed to retrieve value interval"));
339 if (uc_iterator_get_values(iter, &vl.values, &vl.values_len) < 0) {
340 status = grpc::Status(grpc::StatusCode::INTERNAL,
341 grpc::string("failed to retrieve values"));
345 value_lists->push(vl);
346 } // while (uc_iterator_next(iter, &name) == 0)
348 uc_iterator_destroy(iter);
352 grpc::Status queryValuesWrite(grpc::ServerContext *ctx,
353 grpc::ServerWriter<QueryValuesResponse> *writer,
354 std::queue<value_list_t> *value_lists) {
355 while (!value_lists->empty()) {
356 auto vl = value_lists->front();
357 QueryValuesResponse res;
360 auto status = marshal_value_list(&vl, res.mutable_value_list());
365 if (!writer->Write(res)) {
366 return grpc::Status::CANCELLED;
373 return grpc::Status::OK;
378 * gRPC server implementation
380 class CollectdServer final
385 auto auth = grpc::InsecureServerCredentials();
387 grpc::ServerBuilder builder;
389 if (listeners.empty()) {
390 builder.AddListeningPort(default_addr, auth);
391 INFO("grpc: Listening on %s", default_addr.c_str());
394 for (auto l : listeners) {
395 grpc::string addr = l.addr + ":" + l.port;
397 auto use_ssl = grpc::string("");
399 if (l.ssl != nullptr) {
400 use_ssl = grpc::string(" (SSL enabled)");
401 a = grpc::SslServerCredentials(*l.ssl);
404 builder.AddListeningPort(addr, a);
405 INFO("grpc: Listening on %s%s", addr.c_str(), use_ssl.c_str());
409 builder.RegisterService(&collectd_service_);
411 server_ = builder.BuildAndStart();
420 CollectdImpl collectd_service_;
422 std::unique_ptr<grpc::Server> server_;
423 }; /* class CollectdServer */
425 class CollectdClient final
428 CollectdClient(std::shared_ptr<grpc::ChannelInterface> channel) : stub_(Collectd::NewStub(channel)) {
431 int PutValues(value_list_t const *vl) {
432 grpc::ClientContext ctx;
434 PutValuesRequest req;
435 auto status = marshal_value_list(vl, req.mutable_value_list());
437 ERROR("grpc: Marshalling value_list_t failed.");
441 PutValuesResponse res;
442 auto stream = stub_->PutValues(&ctx, &res);
443 if (!stream->Write(req)) {
444 NOTICE("grpc: Broken stream.");
445 /* intentionally not returning. */
448 stream->WritesDone();
449 status = stream->Finish();
451 ERROR ("grpc: Error while closing stream.");
456 } /* int PutValues */
459 std::unique_ptr<Collectd::Stub> stub_;
462 static CollectdServer *server = nullptr;
465 * collectd plugin interface
468 static void c_grpc_destroy_write_callback (void *ptr) {
469 delete (CollectdClient *) ptr;
472 static int c_grpc_write(__attribute__((unused)) data_set_t const *ds,
473 value_list_t const *vl,
475 CollectdClient *c = (CollectdClient *) ud->data;
476 return c->PutValues(vl);
479 static int c_grpc_config_listen(oconfig_item_t *ci)
481 if ((ci->values_num != 2)
482 || (ci->values[0].type != OCONFIG_TYPE_STRING)
483 || (ci->values[1].type != OCONFIG_TYPE_STRING)) {
484 ERROR("grpc: The `%s` config option needs exactly "
485 "two string argument (address and port).", ci->key);
489 auto listener = Listener();
490 listener.addr = grpc::string(ci->values[0].value.string);
491 listener.port = grpc::string(ci->values[1].value.string);
492 listener.ssl = nullptr;
494 auto ssl_opts = new(grpc::SslServerCredentialsOptions);
495 grpc::SslServerCredentialsOptions::PemKeyCertPair pkcp = {};
496 bool use_ssl = false;
498 for (int i = 0; i < ci->children_num; i++) {
499 oconfig_item_t *child = ci->children + i;
501 if (!strcasecmp("EnableSSL", child->key)) {
502 if (cf_util_get_boolean(child, &use_ssl)) {
503 ERROR("grpc: Option `%s` expects a boolean value",
508 else if (!strcasecmp("SSLCACertificateFile", child->key)) {
510 if (cf_util_get_string(child, &certs)) {
511 ERROR("grpc: Option `%s` expects a string value",
515 ssl_opts->pem_root_certs = read_file(certs);
517 else if (!strcasecmp("SSLCertificateKeyFile", child->key)) {
519 if (cf_util_get_string(child, &key)) {
520 ERROR("grpc: Option `%s` expects a string value",
524 pkcp.private_key = read_file(key);
526 else if (!strcasecmp("SSLCertificateFile", child->key)) {
528 if (cf_util_get_string(child, &cert)) {
529 ERROR("grpc: Option `%s` expects a string value",
533 pkcp.cert_chain = read_file(cert);
536 WARNING("grpc: Option `%s` not allowed in <%s> block.",
537 child->key, ci->key);
541 ssl_opts->pem_key_cert_pairs.push_back(pkcp);
543 listener.ssl = ssl_opts;
547 listeners.push_back(listener);
549 } /* c_grpc_config_listen() */
551 static int c_grpc_config_server(oconfig_item_t *ci)
553 if ((ci->values_num != 2)
554 || (ci->values[0].type != OCONFIG_TYPE_STRING)
555 || (ci->values[1].type != OCONFIG_TYPE_STRING)) {
556 ERROR("grpc: The `%s` config option needs exactly "
557 "two string argument (address and port).", ci->key);
561 grpc::SslCredentialsOptions ssl_opts;
562 bool use_ssl = false;
564 for (int i = 0; i < ci->children_num; i++) {
565 oconfig_item_t *child = ci->children + i;
567 if (!strcasecmp("EnableSSL", child->key)) {
568 if (cf_util_get_boolean(child, &use_ssl)) {
572 else if (!strcasecmp("SSLCACertificateFile", child->key)) {
574 if (cf_util_get_string(child, &certs)) {
577 ssl_opts.pem_root_certs = read_file(certs);
579 else if (!strcasecmp("SSLCertificateKeyFile", child->key)) {
581 if (cf_util_get_string(child, &key)) {
584 ssl_opts.pem_private_key = read_file(key);
586 else if (!strcasecmp("SSLCertificateFile", child->key)) {
588 if (cf_util_get_string(child, &cert)) {
591 ssl_opts.pem_cert_chain = read_file(cert);
594 WARNING("grpc: Option `%s` not allowed in <%s> block.",
595 child->key, ci->key);
599 auto node = grpc::string(ci->values[0].value.string);
600 auto service = grpc::string(ci->values[1].value.string);
601 auto addr = node + ":" + service;
603 CollectdClient *client;
605 auto channel_creds = grpc::SslCredentials(ssl_opts);
606 auto channel = grpc::CreateChannel(addr, channel_creds);
607 client = new CollectdClient(channel);
609 auto channel = grpc::CreateChannel(addr, grpc::InsecureChannelCredentials());
610 client = new CollectdClient(channel);
613 auto callback_name = grpc::string("grpc/") + addr;
616 .free_func = c_grpc_destroy_write_callback,
619 plugin_register_write (callback_name.c_str(), c_grpc_write, &ud);
621 } /* c_grpc_config_server() */
623 static int c_grpc_config(oconfig_item_t *ci)
627 for (i = 0; i < ci->children_num; i++) {
628 oconfig_item_t *child = ci->children + i;
630 if (!strcasecmp("Listen", child->key)) {
631 if (c_grpc_config_listen(child))
634 else if (!strcasecmp("Server", child->key)) {
635 if (c_grpc_config_server(child))
640 WARNING("grpc: Option `%s` not allowed here.", child->key);
645 } /* c_grpc_config() */
647 static int c_grpc_init(void)
649 server = new CollectdServer();
651 ERROR("grpc: Failed to create server");
657 } /* c_grpc_init() */
659 static int c_grpc_shutdown(void)
670 } /* c_grpc_shutdown() */
672 void module_register(void)
674 plugin_register_complex_config("grpc", c_grpc_config);
675 plugin_register_init("grpc", c_grpc_init);
676 plugin_register_shutdown("grpc", c_grpc_shutdown);
677 } /* module_register() */
680 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */