src/write_prometheus.c

   1 /**
   2  * collectd - src/write_prometheus.c
   3  * Copyright (C) 2016       Florian octo Forster
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy
   6  * of this software and associated documentation files (the "Software"), to deal
   7  * in the Software without restriction, including without limitation the rights
   8  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9  * copies of the Software, and to permit persons to whom the Software is
  10  * furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  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 FROM,
  20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21  * SOFTWARE.
  22  *
  23  * Authors:
  24  *   Florian octo Forster <octo at collectd.org>
  25  */
  26
  27 #include "collectd.h"
  28
  29 #include "common.h"
  30 #include "plugin.h"
  31 #include "utils_avltree.h"
  32 #include "utils_complain.h"
  33 #include "utils_time.h"
  34
  35 #include "prometheus.pb-c.h"
  36
  37 #include <microhttpd.h>
  38
  39 #ifndef PROMETHEUS_DEFAULT_STALENESS_DELTA
  40 #define PROMETHEUS_DEFAULT_STALENESS_DELTA TIME_T_TO_CDTIME_T(300)
  41 #endif
  42
  43 #define VARINT_UINT32_BYTES 5
  44
  45 #define CONTENT_TYPE_PROTO                                                     \
  46   "application/vnd.google.protobuf; proto=io.prometheus.client.MetricFamily; " \
  47   "encoding=delimited"
  48 #define CONTENT_TYPE_TEXT "text/plain; version=0.0.4"
  49
  50 static c_avl_tree_t *metrics;
  51 static pthread_mutex_t metrics_lock = PTHREAD_MUTEX_INITIALIZER;
  52
  53 static unsigned short httpd_port = 9103;
  54 static struct MHD_Daemon *httpd;
  55
  56 static cdtime_t staleness_delta = PROMETHEUS_DEFAULT_STALENESS_DELTA;
  57
  58 /* Unfortunately, protoc-c doesn't export it's implementation of varint, so we
  59  * need to implement our own. */
  60 static size_t varint(uint8_t buffer[static VARINT_UINT32_BYTES],
  61                      uint32_t value) {
  62   for (size_t i = 0; i < VARINT_UINT32_BYTES; i++) {
  63     buffer[i] = (uint8_t)(value & 0x7f);
  64     value >>= 7;
  65
  66     if (value == 0)
  67       return i + 1;
  68
  69     buffer[i] |= 0x80;
  70   }
  71
  72   return 0;
  73 }
  74
  75 /* format_protobuf iterates over all metric families in "metrics" and adds them
  76  * to a buffer in ProtoBuf format. It prefixes each protobuf with its encoded
  77  * size, the so called "delimited" format. */
  78 static void format_protobuf(ProtobufCBuffer *buffer) {
  79   pthread_mutex_lock(&metrics_lock);
  80
  81   char *unused_name;
  82   Io__Prometheus__Client__MetricFamily *fam;
  83   c_avl_iterator_t *iter = c_avl_get_iterator(metrics);
  84   while (c_avl_iterator_next(iter, (void *)&unused_name, (void *)&fam) == 0) {
  85     /* Prometheus uses a message length prefix to determine where one
  86      * MetricFamily ends and the next begins. This delimiter is encoded as a
  87      * "varint", which is common in Protobufs. */
  88     uint8_t delim[VARINT_UINT32_BYTES] = {0};
  89     size_t delim_len = varint(
  90         delim,
  91         (uint32_t)io__prometheus__client__metric_family__get_packed_size(fam));
  92     buffer->append(buffer, delim_len, delim);
  93
  94     io__prometheus__client__metric_family__pack_to_buffer(fam, buffer);
  95   }
  96   c_avl_iterator_destroy(iter);
  97
  98   pthread_mutex_unlock(&metrics_lock);
  99 }
 100
 101 /* format_labels formats a metric's labels in Prometheus-compatible format. This
 102  * format looks like this:
 103  *
 104  *   key0="value0",key1="value1"
 105  */
 106 static char *format_labels(char *buffer, size_t buffer_size,
 107                            Io__Prometheus__Client__Metric const *m) {
 108   /* our metrics always have at least one and at most three labels. */
 109   assert(m->n_label >= 1);
 110   assert(m->n_label <= 3);
 111
 112 #define LABEL_BUFFER_SIZE (2 * DATA_MAX_NAME_LEN + 4)
 113
 114   char *labels[3] = {
 115       (char[LABEL_BUFFER_SIZE]){0}, (char[LABEL_BUFFER_SIZE]){0},
 116       (char[LABEL_BUFFER_SIZE]){0},
 117   };
 118
 119   for (size_t i = 0; i < m->n_label; i++)
 120     ssnprintf(labels[i], LABEL_BUFFER_SIZE, "%s=\"%s\"", m->label[i]->name,
 121               m->label[i]->value);
 122
 123   strjoin(buffer, buffer_size, labels, m->n_label, ",");
 124   return buffer;
 125 }
 126
 127 /* format_protobuf iterates over all metric families in "metrics" and adds them
 128  * to a buffer in plain text format. */
 129 static void format_text(ProtobufCBuffer *buffer) {
 130   pthread_mutex_lock(&metrics_lock);
 131
 132   char *unused_name;
 133   Io__Prometheus__Client__MetricFamily *fam;
 134   c_avl_iterator_t *iter = c_avl_get_iterator(metrics);
 135   while (c_avl_iterator_next(iter, (void *)&unused_name, (void *)&fam) == 0) {
 136     char line[1024]; /* 4x DATA_MAX_NAME_LEN? */
 137
 138     ssnprintf(line, sizeof(line), "# HELP %s %s\n", fam->name, fam->help);
 139     buffer->append(buffer, strlen(line), (uint8_t *)line);
 140
 141     ssnprintf(line, sizeof(line), "# TYPE %s %s\n", fam->name,
 142               (fam->type == IO__PROMETHEUS__CLIENT__METRIC_TYPE__GAUGE)
 143                   ? "gauge"
 144                   : "counter");
 145     buffer->append(buffer, strlen(line), (uint8_t *)line);
 146
 147     for (size_t i = 0; i < fam->n_metric; i++) {
 148       Io__Prometheus__Client__Metric *m = fam->metric[i];
 149
 150       char labels[1024];
 151
 152       char timestamp_ms[24] = "";
 153       if (m->has_timestamp_ms)
 154         ssnprintf(timestamp_ms, sizeof(timestamp_ms), " %" PRIi64,
 155                   m->timestamp_ms);
 156
 157       if (fam->type == IO__PROMETHEUS__CLIENT__METRIC_TYPE__GAUGE)
 158         ssnprintf(line, sizeof(line), "%s{%s} " GAUGE_FORMAT "%s\n", fam->name,
 159                   format_labels(labels, sizeof(labels), m), m->gauge->value,
 160                   timestamp_ms);
 161       else /* if (fam->type == IO__PROMETHEUS__CLIENT__METRIC_TYPE__COUNTER) */
 162         ssnprintf(line, sizeof(line), "%s{%s} %.0f%s\n", fam->name,
 163                   format_labels(labels, sizeof(labels), m), m->counter->value,
 164                   timestamp_ms);
 165
 166       buffer->append(buffer, strlen(line), (uint8_t *)line);
 167     }
 168   }
 169   c_avl_iterator_destroy(iter);
 170
 171   char server[1024];
 172   ssnprintf(server, sizeof(server), "\n# collectd/write_prometheus %s at %s\n",
 173             PACKAGE_VERSION, hostname_g);
 174   buffer->append(buffer, strlen(server), (uint8_t *)server);
 175
 176   pthread_mutex_unlock(&metrics_lock);
 177 }
 178
 179 /* http_handler is the callback called by the microhttpd library. It essentially
 180  * handles all HTTP request aspects and creates an HTTP response. */
 181 static int http_handler(void *cls, struct MHD_Connection *connection,
 182                         const char *url, const char *method,
 183                         const char *version, const char *upload_data,
 184                         size_t *upload_data_size, void **connection_state) {
 185   if (strcmp(method, MHD_HTTP_METHOD_GET) != 0) {
 186     return MHD_NO;
 187   }
 188
 189   /* On the first call for each connection, return without anything further.
 190    * Apparently not everything has been initialized yet or so; the docs are not
 191    * very specific on the issue. */
 192   if (*connection_state == NULL) {
 193     /* set to a random non-NULL pointer. */
 194     *connection_state = &(int){42};
 195     return MHD_YES;
 196   }
 197
 198   char const *accept = MHD_lookup_connection_value(connection, MHD_HEADER_KIND,
 199                                                    MHD_HTTP_HEADER_ACCEPT);
 200   _Bool want_proto =
 201       (accept != NULL) &&
 202       (strstr(accept, "application/vnd.google.protobuf") != NULL);
 203
 204   uint8_t scratch[4096] = {0};
 205   ProtobufCBufferSimple simple = PROTOBUF_C_BUFFER_SIMPLE_INIT(scratch);
 206   ProtobufCBuffer *buffer = (ProtobufCBuffer *)&simple;
 207
 208   if (want_proto)
 209     format_protobuf(buffer);
 210   else
 211     format_text(buffer);
 212
 213   struct MHD_Response *res = MHD_create_response_from_data(
 214       simple.len, simple.data, /* must_free = */ 0, /* must_copy = */ 1);
 215   MHD_add_response_header(res, MHD_HTTP_HEADER_CONTENT_TYPE,
 216                           want_proto ? CONTENT_TYPE_PROTO : CONTENT_TYPE_TEXT);
 217
 218   int status = MHD_queue_response(connection, MHD_HTTP_OK, res);
 219
 220   MHD_destroy_response(res);
 221   PROTOBUF_C_BUFFER_SIMPLE_CLEAR(&simple);
 222   return status;
 223 }
 224
 225 /*
 226  * Functions for manipulating the global state in "metrics". This is organized
 227  * in two tiers: the global "metrics" tree holds "metric families", which are
 228  * identified by a name (a string). Each metric family has one or more
 229  * "metrics", which are identified by a unique set of key-value-pairs. For
 230  * example:
 231  *
 232  * collectd_cpu_total
 233  *   {cpu="0",type="idle"}
 234  *   {cpu="0",type="user"}
 235  *   ...
 236  * collectd_memory
 237  *   {memory="used"}
 238  *   {memory="free"}
 239  *   ...
 240  * {{{ */
 241 /* label_pair_destroy frees the memory used by a label pair. */
 242 static void label_pair_destroy(Io__Prometheus__Client__LabelPair *msg) {
 243   if (msg == NULL)
 244     return;
 245
 246   sfree(msg->name);
 247   sfree(msg->value);
 248
 249   sfree(msg);
 250 }
 251
 252 /* label_pair_create allocates and initializes a new label pair. */
 253 static Io__Prometheus__Client__LabelPair *label_pair_create(char const *name,
 254                                                             char const *value) {
 255   Io__Prometheus__Client__LabelPair *msg = calloc(1, sizeof(*msg));
 256   if (msg == NULL)
 257     return NULL;
 258   io__prometheus__client__label_pair__init(msg);
 259
 260   msg->name = strdup(name);
 261   msg->value = strdup(value);
 262   if ((msg->name == NULL) || (msg->value == NULL)) {
 263     label_pair_destroy(msg);
 264     return NULL;
 265   }
 266
 267   return msg;
 268 }
 269
 270 /* metric_destroy frees the memory used by a metric. */
 271 static void metric_destroy(Io__Prometheus__Client__Metric *msg) {
 272   if (msg == NULL)
 273     return;
 274
 275   for (size_t i = 0; i < msg->n_label; i++) {
 276     label_pair_destroy(msg->label[i]);
 277   }
 278   sfree(msg->label);
 279
 280   sfree(msg->gauge);
 281   sfree(msg->counter);
 282
 283   sfree(msg);
 284 }
 285
 286 /* metric_add_labels adds the labels that identify this metric to m.
 287  * The logic is copied from the "collectd_exporter". Essentially, the labels
 288  * contain the hostname, the plugin instance and the type instance of a
 289  * value_list_t. */
 290 static int metric_add_labels(Io__Prometheus__Client__Metric *m,
 291                              value_list_t const *vl) {
 292   size_t n_label = 1;
 293   if (strlen(vl->plugin_instance) != 0)
 294     n_label++;
 295   if (strlen(vl->type_instance) != 0)
 296     n_label++;
 297
 298   m->label = calloc(n_label, sizeof(*m->label));
 299   if (m->label == NULL)
 300     return ENOMEM;
 301
 302   if (strlen(vl->plugin_instance) != 0) {
 303     m->label[m->n_label] = label_pair_create(vl->plugin, vl->plugin_instance);
 304     m->n_label++;
 305   }
 306
 307   if (strlen(vl->type_instance) != 0) {
 308     char const *name = "type";
 309     if (strlen(vl->plugin_instance) == 0)
 310       name = vl->plugin;
 311
 312     m->label[m->n_label] = label_pair_create(name, vl->type_instance);
 313     m->n_label++;
 314   }
 315
 316   m->label[m->n_label] = label_pair_create("instance", vl->host);
 317   m->n_label++;
 318
 319   for (size_t i = 0; i < m->n_label; i++) {
 320     if (m->label[i] == NULL)
 321       return ENOMEM;
 322   }
 323
 324   return 0;
 325 }
 326
 327 /* metric_cmp compares two metrics. It's prototype makes it easy to use with
 328  * qsort(3) and bsearch(3). */
 329 static int metric_cmp(void const *a, void const *b) {
 330   Io__Prometheus__Client__Metric const *m_a =
 331       *((Io__Prometheus__Client__Metric **)a);
 332   Io__Prometheus__Client__Metric const *m_b =
 333       *((Io__Prometheus__Client__Metric **)b);
 334
 335   if (m_a->n_label < m_b->n_label)
 336     return -1;
 337   else if (m_a->n_label > m_b->n_label)
 338     return 1;
 339
 340   /* Prometheus does not care about the order of labels. All labels in this
 341    * plugin are created by metric_add_labels(), though, and therefore always
 342    * appear in the same order. We take advantage of this and simplify the check
 343    * by making sure all labels are the same in each position. */
 344   for (size_t i = 0; i < m_a->n_label; i++) {
 345     int status = strcmp(m_a->label[i]->name, m_b->label[i]->name);
 346     if (status != 0)
 347       return status;
 348
 349     status = strcmp(m_a->label[i]->value, m_b->label[i]->value);
 350     if (status != 0)
 351       return status;
 352   }
 353
 354   return 0;
 355 }
 356
 357 /* metric_create allocates and initializes a new metric. */
 358 static Io__Prometheus__Client__Metric *metric_create(value_list_t const *vl) {
 359   Io__Prometheus__Client__Metric *msg = calloc(1, sizeof(*msg));
 360   if (msg == NULL)
 361     return NULL;
 362   io__prometheus__client__metric__init(msg);
 363
 364   if (metric_add_labels(msg, vl) != 0) {
 365     metric_destroy(msg);
 366     return NULL;
 367   }
 368
 369   return msg;
 370 }
 371
 372 /* metric_update stores the new value and timestamp in m. */
 373 static int metric_update(Io__Prometheus__Client__Metric *m, value_t value,
 374                          int ds_type, cdtime_t t, cdtime_t interval) {
 375   if (ds_type == DS_TYPE_GAUGE) {
 376     sfree(m->counter);
 377     if (m->gauge == NULL) {
 378       m->gauge = calloc(1, sizeof(*m->gauge));
 379       if (m->gauge == NULL)
 380         return ENOMEM;
 381       io__prometheus__client__gauge__init(m->gauge);
 382     }
 383
 384     m->gauge->value = (double)value.gauge;
 385     m->gauge->has_value = 1;
 386   } else { /* not gauge */
 387     sfree(m->gauge);
 388     if (m->counter == NULL) {
 389       m->counter = calloc(1, sizeof(*m->counter));
 390       if (m->counter == NULL)
 391         return ENOMEM;
 392       io__prometheus__client__counter__init(m->counter);
 393     }
 394
 395     switch (ds_type) {
 396     case DS_TYPE_ABSOLUTE:
 397       m->counter->value = (double)value.absolute;
 398       break;
 399     case DS_TYPE_COUNTER:
 400       m->counter->value = (double)value.counter;
 401       break;
 402     default:
 403       m->counter->value = (double)value.derive;
 404       break;
 405     }
 406     m->counter->has_value = 1;
 407   }
 408
 409   /* Prometheus has a globally configured timeout after which metrics are
 410    * considered stale. This causes problems when metrics have an interval
 411    * exceeding that limit. We emulate the behavior of "pushgateway" and *not*
 412    * send a timestamp value – Prometheus will fill in the current time. */
 413   if (interval <= staleness_delta) {
 414     m->timestamp_ms = CDTIME_T_TO_MS(t);
 415     m->has_timestamp_ms = 1;
 416   } else {
 417     static c_complain_t long_metric = C_COMPLAIN_INIT_STATIC;
 418     c_complain(
 419         LOG_NOTICE, &long_metric,
 420         "write_prometheus plugin: You have metrics with an interval exceeding "
 421         "\"StalenessDelta\" setting (%.3fs). This is suboptimal, please check "
 422         "the collectd.conf(5) manual page to understand what's going on.",
 423         CDTIME_T_TO_DOUBLE(staleness_delta));
 424
 425     m->timestamp_ms = 0;
 426     m->has_timestamp_ms = 0;
 427   }
 428
 429   return 0;
 430 }
 431
 432 /* metric_family_add_metric adds m to the metric list of fam. */
 433 static int metric_family_add_metric(Io__Prometheus__Client__MetricFamily *fam,
 434                                     Io__Prometheus__Client__Metric *m) {
 435   Io__Prometheus__Client__Metric **tmp =
 436       realloc(fam->metric, (fam->n_metric + 1) * sizeof(*fam->metric));
 437   if (tmp == NULL)
 438     return ENOMEM;
 439   fam->metric = tmp;
 440
 441   fam->metric[fam->n_metric] = m;
 442   fam->n_metric++;
 443
 444   /* Sort the metrics so that lookup is fast. */
 445   qsort(fam->metric, fam->n_metric, sizeof(*fam->metric), metric_cmp);
 446
 447   return 0;
 448 }
 449
 450 /* metric_family_delete_metric looks up and deletes the metric corresponding to
 451  * vl. */
 452 static int
 453 metric_family_delete_metric(Io__Prometheus__Client__MetricFamily *fam,
 454                             value_list_t const *vl) {
 455   Io__Prometheus__Client__Metric *key = metric_create(vl);
 456   if (key == NULL)
 457     return ENOMEM;
 458
 459   size_t i;
 460   for (i = 0; i < fam->n_metric; i++) {
 461     if (metric_cmp(&key, &fam->metric[i]) == 0)
 462       break;
 463   }
 464
 465   if (i >= fam->n_metric)
 466     return ENOENT;
 467
 468   metric_destroy(fam->metric[i]);
 469   if ((fam->n_metric - 1) > i)
 470     memmove(&fam->metric[i], &fam->metric[i + 1],
 471             ((fam->n_metric - 1) - i) * sizeof(fam->metric[i]));
 472   fam->n_metric--;
 473
 474   Io__Prometheus__Client__Metric **tmp =
 475       realloc(fam->metric, fam->n_metric * sizeof(*fam->metric));
 476   if ((tmp != NULL) || (fam->n_metric == 0))
 477     fam->metric = tmp;
 478
 479   return 0;
 480 }
 481
 482 /* metric_family_get_metric looks up the matching metric in a metric family,
 483  * allocating it if necessary. */
 484 static Io__Prometheus__Client__Metric *
 485 metric_family_get_metric(Io__Prometheus__Client__MetricFamily *fam,
 486                          value_list_t const *vl) {
 487   Io__Prometheus__Client__Metric *key = metric_create(vl);
 488   if (key == NULL)
 489     return NULL;
 490
 491   /* Metrics are sorted in metric_family_add_metric() so that we can do a binary
 492    * search here. */
 493   Io__Prometheus__Client__Metric **m = bsearch(
 494       &key, fam->metric, fam->n_metric, sizeof(*fam->metric), metric_cmp);
 495
 496   if (m != NULL) {
 497     metric_destroy(key);
 498     return *m;
 499   }
 500
 501   DEBUG("write_prometheus plugin: created new metric in family");
 502   int status = metric_family_add_metric(fam, key);
 503   if (status != 0) {
 504     metric_destroy(key);
 505     return NULL;
 506   }
 507
 508   return key;
 509 }
 510
 511 /* metric_family_update looks up the matching metric in a metric family,
 512  * allocating it if necessary, and updates the metric to the latest value. */
 513 static int metric_family_update(Io__Prometheus__Client__MetricFamily *fam,
 514                                 data_set_t const *ds, value_list_t const *vl,
 515                                 size_t ds_index) {
 516   Io__Prometheus__Client__Metric *m = metric_family_get_metric(fam, vl);
 517   if (m == NULL)
 518     return -1;
 519
 520   return metric_update(m, vl->values[ds_index], ds->ds[ds_index].type, vl->time,
 521                        vl->interval);
 522 }
 523
 524 /* metric_family_destroy frees the memory used by a metric family. */
 525 static void metric_family_destroy(Io__Prometheus__Client__MetricFamily *msg) {
 526   if (msg == NULL)
 527     return;
 528
 529   sfree(msg->name);
 530   sfree(msg->help);
 531
 532   for (size_t i = 0; i < msg->n_metric; i++) {
 533     metric_destroy(msg->metric[i]);
 534   }
 535   sfree(msg->metric);
 536
 537   sfree(msg);
 538 }
 539
 540 /* metric_family_create allocates and initializes a new metric family. */
 541 static Io__Prometheus__Client__MetricFamily *
 542 metric_family_create(char *name, data_set_t const *ds, value_list_t const *vl,
 543                      size_t ds_index) {
 544   Io__Prometheus__Client__MetricFamily *msg = calloc(1, sizeof(*msg));
 545   if (msg == NULL)
 546     return NULL;
 547   io__prometheus__client__metric_family__init(msg);
 548
 549   msg->name = name;
 550
 551   char help[1024];
 552   ssnprintf(
 553       help, sizeof(help),
 554       "write_prometheus plugin: '%s' Type: '%s', Dstype: '%s', Dsname: '%s'",
 555       vl->plugin, vl->type, DS_TYPE_TO_STRING(ds->ds[ds_index].type),
 556       ds->ds[ds_index].name);
 557   msg->help = strdup(help);
 558
 559   msg->type = (ds->ds[ds_index].type == DS_TYPE_GAUGE)
 560                   ? IO__PROMETHEUS__CLIENT__METRIC_TYPE__GAUGE
 561                   : IO__PROMETHEUS__CLIENT__METRIC_TYPE__COUNTER;
 562   msg->has_type = 1;
 563
 564   return msg;
 565 }
 566
 567 /* metric_family_name creates a metric family's name from a data source. This is
 568  * done in the same way as done by the "collectd_exporter" for best possible
 569  * compatibility. In essence, the plugin, type and data source name go in the
 570  * metric family name, while hostname, plugin instance and type instance go into
 571  * the labels of a metric. */
 572 static char *metric_family_name(data_set_t const *ds, value_list_t const *vl,
 573                                 size_t ds_index) {
 574   char const *fields[5] = {"collectd"};
 575   size_t fields_num = 1;
 576
 577   if (strcmp(vl->plugin, vl->type) != 0) {
 578     fields[fields_num] = vl->plugin;
 579     fields_num++;
 580   }
 581   fields[fields_num] = vl->type;
 582   fields_num++;
 583
 584   if (strcmp("value", ds->ds[ds_index].name) != 0) {
 585     fields[fields_num] = ds->ds[ds_index].name;
 586     fields_num++;
 587   }
 588
 589   /* Prometheus best practices:
 590    * cumulative metrics should have a "total" suffix. */
 591   if ((ds->ds[ds_index].type == DS_TYPE_COUNTER) ||
 592       (ds->ds[ds_index].type == DS_TYPE_DERIVE)) {
 593     fields[fields_num] = "total";
 594     fields_num++;
 595   }
 596
 597   char name[5 * DATA_MAX_NAME_LEN];
 598   strjoin(name, sizeof(name), (char **)fields, fields_num, "_");
 599   return strdup(name);
 600 }
 601
 602 /* metric_family_get looks up the matching metric family, allocating it if
 603  * necessary. */
 604 static Io__Prometheus__Client__MetricFamily *
 605 metric_family_get(data_set_t const *ds, value_list_t const *vl,
 606                   size_t ds_index) {
 607   char *name = metric_family_name(ds, vl, ds_index);
 608   if (name == NULL) {
 609     ERROR("write_prometheus plugin: Allocating metric family name failed.");
 610     return NULL;
 611   }
 612
 613   Io__Prometheus__Client__MetricFamily *fam = NULL;
 614   if (c_avl_get(metrics, name, (void *)&fam) == 0) {
 615     sfree(name);
 616     assert(fam != NULL);
 617     return fam;
 618   }
 619
 620   fam = metric_family_create(name, ds, vl, ds_index);
 621   if (fam == NULL) {
 622     ERROR("write_prometheus plugin: Allocating metric family failed.");
 623     sfree(name);
 624     return NULL;
 625   }
 626
 627   /* If successful, "name" is owned by "fam", i.e. don't free it here. */
 628   DEBUG("write_prometheus plugin: metric family \"%s\" has been created.",
 629         name);
 630   name = NULL;
 631
 632   int status = c_avl_insert(metrics, fam->name, fam);
 633   if (status != 0) {
 634     ERROR("write_prometheus plugin: Adding \"%s\" failed.", name);
 635     metric_family_destroy(fam);
 636     return NULL;
 637   }
 638
 639   return fam;
 640 }
 641 /* }}} */
 642
 643 /*
 644  * collectd callbacks
 645  */
 646 static int prom_config(oconfig_item_t *ci) {
 647   for (int i = 0; i < ci->children_num; i++) {
 648     oconfig_item_t *child = ci->children + i;
 649
 650     if (strcasecmp("Port", child->key) == 0) {
 651       int status = cf_util_get_port_number(child);
 652       if (status > 0)
 653         httpd_port = (unsigned short)status;
 654     } else if (strcasecmp("StalenessDelta", child->key) == 0) {
 655       cf_util_get_cdtime(child, &staleness_delta);
 656     } else {
 657       WARNING("write_prometheus plugin: Ignoring unknown configuration option "
 658               "\"%s\".",
 659               child->key);
 660     }
 661   }
 662
 663   return 0;
 664 }
 665
 666 static int prom_init() {
 667   if (metrics == NULL) {
 668     metrics = c_avl_create((void *)strcmp);
 669     if (metrics == NULL) {
 670       ERROR("write_prometheus plugin: c_avl_create() failed.");
 671       return -1;
 672     }
 673   }
 674
 675   if (httpd == NULL) {
 676     unsigned int flags = MHD_USE_THREAD_PER_CONNECTION;
 677 #if MHD_VERSION >= 0x00093300
 678     flags |= MHD_USE_DUAL_STACK;
 679 #endif
 680
 681     httpd = MHD_start_daemon(flags, httpd_port,
 682                              /* MHD_AcceptPolicyCallback = */ NULL,
 683                              /* MHD_AcceptPolicyCallback arg = */ NULL,
 684                              http_handler, NULL, MHD_OPTION_END);
 685     if (httpd == NULL) {
 686       ERROR("write_prometheus plugin: MHD_start_daemon() failed.");
 687       return -1;
 688     }
 689     DEBUG("write_prometheus plugin: Successfully started microhttpd %s",
 690           MHD_get_version());
 691   }
 692
 693   return 0;
 694 }
 695
 696 static int prom_write(data_set_t const *ds, value_list_t const *vl,
 697                       __attribute__((unused)) user_data_t *ud) {
 698   pthread_mutex_lock(&metrics_lock);
 699
 700   for (size_t i = 0; i < ds->ds_num; i++) {
 701     Io__Prometheus__Client__MetricFamily *fam = metric_family_get(ds, vl, i);
 702     if (fam == NULL)
 703       continue;
 704
 705     int status = metric_family_update(fam, ds, vl, i);
 706     if (status != 0) {
 707       ERROR("write_prometheus plugin: Updating metric \"%s\" failed with "
 708             "status %d",
 709             fam->name, status);
 710       continue;
 711     }
 712   }
 713
 714   pthread_mutex_unlock(&metrics_lock);
 715   return 0;
 716 }
 717
 718 static int prom_missing(value_list_t const *vl,
 719                         __attribute__((unused)) user_data_t *ud) {
 720   data_set_t const *ds = plugin_get_ds(vl->type);
 721   if (ds == NULL)
 722     return ENOENT;
 723
 724   pthread_mutex_lock(&metrics_lock);
 725
 726   for (size_t i = 0; i < ds->ds_num; i++) {
 727     Io__Prometheus__Client__MetricFamily *fam = metric_family_get(ds, vl, i);
 728     if (fam == NULL)
 729       continue;
 730
 731     int status = metric_family_delete_metric(fam, vl);
 732     if (status != 0) {
 733       ERROR("write_prometheus plugin: Deleting a metric in family \"%s\" "
 734             "failed with status %d",
 735             fam->name, status);
 736       continue;
 737     }
 738
 739     if (fam->n_metric == 0) {
 740       int status = c_avl_remove(metrics, fam->name, NULL, NULL);
 741       if (status != 0) {
 742         ERROR("write_prometheus plugin: Deleting metric family \"%s\" failed "
 743               "with status %d",
 744               fam->name, status);
 745         continue;
 746       }
 747       metric_family_destroy(fam);
 748     }
 749   }
 750
 751   pthread_mutex_unlock(&metrics_lock);
 752   return 0;
 753 }
 754
 755 static int prom_shutdown() {
 756   if (httpd != NULL) {
 757     MHD_stop_daemon(httpd);
 758     httpd = NULL;
 759   }
 760
 761   pthread_mutex_lock(&metrics_lock);
 762   if (metrics != NULL) {
 763     char *name;
 764     Io__Prometheus__Client__MetricFamily *fam;
 765     while (c_avl_pick(metrics, (void *)&name, (void *)&fam) == 0) {
 766       assert(name == fam->name);
 767       name = NULL;
 768
 769       metric_family_destroy(fam);
 770     }
 771     c_avl_destroy(metrics);
 772     metrics = NULL;
 773   }
 774   pthread_mutex_unlock(&metrics_lock);
 775
 776   return 0;
 777 }
 778
 779 void module_register() {
 780   plugin_register_complex_config("write_prometheus", prom_config);
 781   plugin_register_init("write_prometheus", prom_init);
 782   plugin_register_write("write_prometheus", prom_write,
 783                         /* user data = */ NULL);
 784   plugin_register_missing("write_prometheus", prom_missing,
 785                           /* user data = */ NULL);
 786   plugin_register_shutdown("write_prometheus", prom_shutdown);
 787 }
 788
 789 /* vim: set sw=2 sts=2 et fdm=marker : */