in_windows_exporter_metrics: Implement Windows Service metrics

Signed-off-by: Hiroshi Hatake <[email protected]>

Author: cosmo0920

plugins/in_windows_exporter_metrics/CMakeLists.txt

@@ -14,6 +14,7 @@ set(src
   we_wmi_cpu_info.c
   we_wmi_logon.c
   we_wmi_system.c
+  we_wmi_service.c
   )
 
 set(libs

plugins/in_windows_exporter_metrics/we.c

@@ -35,6 +35,13 @@
 #include "we_logical_disk.h"
 #include "we_cs.h"
 
+/* wmi collectors */
+#include "we_wmi_cpu_info.h"
+#include "we_wmi_logon.h"
+#include "we_wmi_system.h"
+#include "we_wmi_thermalzone.h"
+#include "we_wmi_service.h"
+
 static int we_timer_cpu_metrics_cb(struct flb_input_instance *ins,
                                    struct flb_config *config, void *in_context)
 {
@@ -125,6 +132,16 @@ static int we_timer_wmi_system_metrics_cb(struct flb_input_instance *ins,
     return 0;
 }
 
+static int we_timer_wmi_service_metrics_cb(struct flb_input_instance *ins,
+                                           struct flb_config *config, void *in_context)
+{
+    struct flb_ne *ctx = in_context;
+
+    we_wmi_service_update(ctx);
+
+    return 0;
+}
+
 struct flb_we_callback {
     char *name;
     void (*func)(char *, void *, void *);
@@ -240,6 +257,13 @@ static void we_wmi_system_update_cb(char *name, void *p1, void *p2)
     we_wmi_system_update(ctx);
 }
 
+static void we_wmi_service_update_cb(char *name, void *p1, void *p2)
+{
+    struct flb_we *ctx = p1;
+
+    we_wmi_service_update(ctx);
+}
+
 static int we_update_cb(struct flb_we *ctx, char *name)
 {
     int ret;
@@ -262,6 +286,7 @@ struct flb_we_callback ne_callbacks[] = {
     { "thermalzone", we_wmi_thermalzone_update_cb },
     { "logon", we_wmi_logon_update_cb },
     { "system", we_wmi_system_update_cb },
+    { "service", we_wmi_service_update_cb },
     { 0 }
 };
 
@@ -295,6 +320,7 @@ static int in_we_init(struct flb_input_instance *in,
     ctx->coll_wmi_cpu_info_fd = -1;
     ctx->coll_wmi_logon_fd = -1;
     ctx->coll_wmi_system_fd = -1;
+    ctx->coll_wmi_service_fd = -1;
 
     ctx->callback = flb_callback_create(in->name);
     if (!ctx->callback) {
@@ -574,6 +600,31 @@ static int in_we_init(struct flb_input_instance *in,
                         return -1;
                     }
                 }
+                else if (strncmp(entry->str, "service", 7) == 0) {
+                    if (ctx->wmi_service_scrape_interval == 0) {
+                        flb_plg_debug(ctx->ins, "enabled metrics %s", entry->str);
+                        metric_idx = 9;
+                    }
+                    else {
+                        /* Create the service collector */
+                        ret = flb_input_set_collector_time(in,
+                                                           we_timer_wmi_service_metrics_cb,
+                                                           ctx->wmi_service_scrape_interval, 0,
+                                                           config);
+                        if (ret == -1) {
+                            flb_plg_error(ctx->ins,
+                                          "could not set service collector for Windows Exporter Metrics plugin");
+                            return -1;
+                        }
+                        ctx->coll_wmi_service_fd = ret;
+                    }
+
+                    /* Initialize service metric collectors */
+                    ret = we_wmi_service_init(ctx);
+                    if (ret) {
+                        return -1;
+                    }
+                }
                 else {
                     flb_plg_warn(ctx->ins, "Unknown metrics: %s", entry->str);
                     metric_idx = -1;
@@ -644,6 +695,9 @@ static int in_we_exit(void *data, struct flb_config *config)
                 else if (strncmp(entry->str, "system", 6) == 0) {
                     we_wmi_system_exit(ctx);
                 }
+                else if (strncmp(entry->str, "service", 7) == 0) {
+                    we_wmi_service_exit(ctx);
+                }
                 else {
                     flb_plg_warn(ctx->ins, "Unknown metrics: %s", entry->str);
                 }
@@ -681,6 +735,9 @@ static int in_we_exit(void *data, struct flb_config *config)
     if (ctx->coll_wmi_system_fd != -1) {
         we_wmi_system_exit(ctx);
     }
+    if (ctx->coll_wmi_service_fd != -1) {
+        we_wmi_service_exit(ctx);
+    }
 
     flb_we_config_destroy(ctx);
 
@@ -721,6 +778,9 @@ static void in_we_pause(void *data, struct flb_config *config)
     if (ctx->coll_wmi_system_fd != -1) {
         flb_input_collector_pause(ctx->coll_wmi_system_fd, ctx->ins);
     }
+    if (ctx->coll_wmi_service_fd != -1) {
+        flb_input_collector_pause(ctx->coll_wmi_service_fd, ctx->ins);
+    }
 }
 
 static void in_we_resume(void *data, struct flb_config *config)
@@ -757,6 +817,9 @@ static void in_we_resume(void *data, struct flb_config *config)
     if (ctx->coll_wmi_system_fd != -1) {
         flb_input_collector_resume(ctx->coll_wmi_system_fd, ctx->ins);
     }
+    if (ctx->coll_wmi_service_fd != -1) {
+        flb_input_collector_resume(ctx->coll_wmi_service_fd, ctx->ins);
+    }
 }
 
 /* Configuration properties map */
@@ -822,9 +885,14 @@ static struct flb_config_map config_map[] = {
      0, FLB_TRUE, offsetof(struct flb_we, wmi_system_scrape_interval),
      "scrape interval to collect system metrics from the node."
     },
+    {
+     FLB_CONFIG_MAP_TIME, "collector.service.scrape_interval", "0",
+     0, FLB_TRUE, offsetof(struct flb_we, wmi_service_scrape_interval),
+     "scrape interval to collect service metrics from the node."
+    },
     {
      FLB_CONFIG_MAP_CLIST, "metrics",
-     "cpu,cpu_info,os,net,logical_disk,cs,thermalzone,logon,system",
+     "cpu,cpu_info,os,net,logical_disk,cs,thermalzone,logon,system,service",
      0, FLB_TRUE, offsetof(struct flb_we, metrics),
      "Comma separated list of keys to enable metrics."
     },
@@ -843,6 +911,11 @@ static struct flb_config_map config_map[] = {
      0, FLB_TRUE, offsetof(struct flb_we, raw_allowing_nic),
      "Specify to be scribable regex for net metrics by name of NIC."
     },
+    {
+     FLB_CONFIG_MAP_STR, "we.service.where", NULL,
+     0, FLB_TRUE, offsetof(struct flb_we, raw_where_clause),
+     "Specify the where clause for retrieving service metrics."
+    },
     /* EOF */
     {0}
 };

plugins/in_windows_exporter_metrics/we.h

@@ -145,6 +145,15 @@ struct we_wmi_system_counters {
     int                    operational;
 };
 
+struct we_wmi_service_counters {
+    struct wmi_query_spec *info;
+    struct cmt_gauge *information;
+    struct cmt_gauge *state;
+    struct cmt_gauge *start_mode;
+    struct cmt_gauge *status;
+    int operational;
+};
+
 struct we_os_counters {
     struct cmt_gauge *info;
     struct cmt_gauge *users;
@@ -178,6 +187,7 @@ struct flb_we {
     char *raw_allowing_disk;
     char *raw_denying_disk;
     char *raw_allowing_nic;
+    char *raw_where_clause;
 
     struct flb_regex *allowing_disk_regex;
     struct flb_regex *denying_disk_regex;
@@ -203,6 +213,7 @@ struct flb_we {
     int wmi_cpu_info_scrape_interval;
     int wmi_logon_scrape_interval;
     int wmi_system_scrape_interval;
+    int wmi_service_scrape_interval;
 
     int coll_cpu_fd;                                    /* collector fd (cpu)    */
     int coll_net_fd;                                    /* collector fd (net)  */
@@ -213,6 +224,7 @@ struct flb_we {
     int coll_wmi_cpu_info_fd;                           /* collector fd (wmi_cpu_info) */
     int coll_wmi_logon_fd;                              /* collector fd (wmi_logon)    */
     int coll_wmi_system_fd;                             /* collector fd (wmi_system)    */
+    int coll_wmi_service_fd;                            /* collector fd (wmi_service) */
 
     /*
      * Metrics Contexts
@@ -228,7 +240,7 @@ struct flb_we {
     struct we_wmi_cpu_info_counters *wmi_cpu_info;
     struct we_wmi_logon_counters *wmi_logon;
     struct we_wmi_system_counters *wmi_system;
-
+    struct we_wmi_service_counters *wmi_service;
 };
 
 typedef int (*collector_cb)(struct flb_we *);

plugins/in_windows_exporter_metrics/we_wmi.c

@@ -231,6 +231,28 @@ static double wmi_get_property_value(struct flb_we *ctx, char *raw_property_key,
     return val;
 }
 
+static char *wmi_get_property_str_value(struct flb_we *ctx, char *raw_property_key,
+                                        IWbemClassObject *class_obj)
+{
+    VARIANT prop;
+    char *strprop;
+    char *str_val = NULL;
+    HRESULT hr;
+    wchar_t *wproperty;
+
+
+    VariantInit(&prop);
+    wproperty = we_convert_str(raw_property_key);
+    hr = class_obj->lpVtbl->Get(class_obj, wproperty, 0, &prop, 0, 0);
+    if (FAILED(hr)) {
+        flb_plg_warn(ctx->ins, "Retrive prop failed. Error code = %x", hr);
+    }
+    str_val = convert_prop_to_str(&prop, FLB_TRUE);
+    VariantClear(&prop);
+    flb_free(wproperty);
+
+    return str_val;
+}
 
 static inline int wmi_update_metrics(struct flb_we *ctx, struct wmi_query_spec *spec,
                                      double val, IWbemClassObject *class_obj, uint64_t timestamp)
@@ -279,12 +301,21 @@ static inline int wmi_execute_query(struct flb_we *ctx, struct wmi_query_spec *s
     size_t size;
 
     size = 14 + strlen(spec->wmi_counter);
+    if (spec->where_clause != NULL) {
+        size += 7 + strlen(spec->where_clause);
+    }
     query = flb_calloc(size, sizeof(char *));
     if (!query) {
         flb_errno();
         return -1;
     }
-    snprintf(query, size, "SELECT * FROM %s", spec->wmi_counter);
+    if (spec->where_clause != NULL) {
+        snprintf(query, size, "SELECT * FROM %s WHERE %s", spec->wmi_counter, spec->where_clause);
+    }
+    else {
+        snprintf(query, size, "SELECT * FROM %s", spec->wmi_counter);
+    }
+    flb_trace("[wmi] query = %s", query);
     wquery = we_convert_str(query);
     flb_free(query);
 
@@ -519,6 +550,12 @@ double we_wmi_get_property_value(struct flb_we *ctx, char *raw_property_key, IWb
     return wmi_get_property_value(ctx, raw_property_key, class_obj);
 }
 
+char *we_wmi_get_property_str_value(struct flb_we *ctx, char *raw_property_key,
+                                    IWbemClassObject *class_obj)
+{
+    return wmi_get_property_str_value(ctx, raw_property_key, class_obj);
+}
+
 int we_wmi_update_counters(struct flb_we *ctx, struct wmi_query_spec *spec, uint64_t timestamp, double val, int metric_label_count, char **metric_label_set)
 {
     wmi_update_counters(spec, timestamp, val, metric_label_count, metric_label_set);

plugins/in_windows_exporter_metrics/we_wmi.h

@@ -34,6 +34,7 @@ struct wmi_query_spec {
     char *wmi_property;
     int label_property_count;
     char **label_property_keys;
+    char *where_clause;
 };
 
 int we_wmi_init(struct flb_we *ctx);
@@ -50,6 +51,8 @@ int we_wmi_coinitialize(struct flb_we *ctx);
 int we_wmi_execute_query(struct flb_we *ctx, struct wmi_query_spec *spec, IEnumWbemClassObject **out_enumerator);
 double we_wmi_get_value(struct flb_we *ctx, struct wmi_query_spec *spec, IWbemClassObject *class_obj);
 double we_wmi_get_property_value(struct flb_we *ctx, char *raw_property_key, IWbemClassObject *class_obj);
+char *we_wmi_get_property_str_value(struct flb_we *ctx, char *raw_property_key,
+                                    IWbemClassObject *class_obj);
 int we_wmi_update_counters(struct flb_we *ctx, struct wmi_query_spec *spec,
                            uint64_t timestamp, double val, int metric_label_count, char **metric_label_set);
 

plugins/in_windows_exporter_metrics/we_wmi_cpu_info.c

@@ -84,6 +84,7 @@ int we_wmi_cpu_info_init(struct flb_we *ctx)
     ctx->wmi_cpu_info->info->label_property_keys[4] = "l2cachesize" ;
     ctx->wmi_cpu_info->info->label_property_keys[5] = "l3cachesize" ;
     ctx->wmi_cpu_info->info->label_property_keys[6] = "name" ;
+    ctx->wmi_cpu_info->info->where_clause = NULL;
 
     ctx->wmi_cpu_info->operational = FLB_TRUE;
 

plugins/in_windows_exporter_metrics/we_wmi_logon.c

@@ -70,6 +70,7 @@ int we_wmi_logon_init(struct flb_we *ctx)
     ctx->wmi_logon->info->wmi_property = "LogonType";
     ctx->wmi_logon->info->label_property_count = 1;
     ctx->wmi_logon->info->label_property_keys[0] = "status" ;
+    ctx->wmi_logon->info->where_clause = NULL;
 
     ctx->wmi_logon->operational = FLB_TRUE;