snmp plugin: Implemented new configuration options
[collectd.git] / src / snmp.c
index b616f67..dde6079 100644 (file)
@@ -44,17 +44,21 @@ struct oid_s {
 };
 typedef struct oid_s oid_t;
 
-union instance_u {
-  char string[DATA_MAX_NAME_LEN];
+struct instance_s {
+  bool configured;
+  bool is_plugin;
   oid_t oid;
 };
-typedef union instance_u instance_t;
+typedef struct instance_s instance_t;
 
 struct data_definition_s {
   char *name; /* used to reference this from the `Collect' option */
   char *type; /* used to find the data_set */
   bool is_table;
   instance_t instance;
+  char *plugin_name;
+  char *plugin_instance;
+  char *type_instance;
   char *instance_prefix;
   oid_t *values;
   size_t values_len;
@@ -209,7 +213,6 @@ static void csnmp_host_definition_destroy(void *arg) /* {{{ */
  *  +-> call_snmp_init_once
  *  +-> csnmp_config_add_data
  *  !   +-> csnmp_config_add_data_instance
- *  !   +-> csnmp_config_add_data_instance_prefix
  *  !   +-> csnmp_config_add_data_values
  *  +-> csnmp_config_add_host
  *      +-> csnmp_config_add_host_version
@@ -219,15 +222,16 @@ static void csnmp_host_definition_destroy(void *arg) /* {{{ */
  *      +-> csnmp_config_add_host_security_level
  */
 static void call_snmp_init_once(void) {
-  static int have_init = 0;
+  static int have_init;
 
   if (have_init == 0)
     init_snmp(PACKAGE_NAME);
   have_init = 1;
 } /* void call_snmp_init_once */
 
-static int csnmp_config_add_data_instance(data_definition_t *dd,
-                                          oconfig_item_t *ci) {
+static int csnmp_config_add_data_instance_oid(data_definition_t *dd,
+                                              oconfig_item_t *ci,
+                                              bool is_plugin) {
   char buffer[DATA_MAX_NAME_LEN];
   int status;
 
@@ -235,36 +239,28 @@ static int csnmp_config_add_data_instance(data_definition_t *dd,
   if (status != 0)
     return status;
 
-  if (dd->is_table) {
-    /* Instance is an OID */
-    dd->instance.oid.oid_len = MAX_OID_LEN;
-
-    if (!read_objid(buffer, dd->instance.oid.oid, &dd->instance.oid.oid_len)) {
-      ERROR("snmp plugin: read_objid (%s) failed.", buffer);
-      return -1;
-    }
-  } else {
-    /* Instance is a simple string */
-    sstrncpy(dd->instance.string, buffer, sizeof(dd->instance.string));
+  if (dd->instance.configured) {
+    ERROR("snmp plugin: Only one of options `TypeInstanceOID', "
+          "`PluginInstanceOID' or `Instance' can be used in `Data' block.");
+    return -1;
   }
 
-  return 0;
-} /* int csnmp_config_add_data_instance */
+  dd->instance.is_plugin = is_plugin;
+  dd->instance.configured = true;
 
-static int csnmp_config_add_data_instance_prefix(data_definition_t *dd,
-                                                 oconfig_item_t *ci) {
-  int status;
+  if (strlen(buffer) == 0) {
+    return 0;
+  }
 
-  if (!dd->is_table) {
-    WARNING("snmp plugin: data %s: InstancePrefix is ignored when `Table' "
-            "is set to `false'.",
-            dd->name);
+  dd->instance.oid.oid_len = MAX_OID_LEN;
+
+  if (!read_objid(buffer, dd->instance.oid.oid, &dd->instance.oid.oid_len)) {
+    ERROR("snmp plugin: read_objid (%s) failed.", buffer);
     return -1;
   }
 
-  status = cf_util_get_string(ci, &dd->instance_prefix);
-  return status;
-} /* int csnmp_config_add_data_instance_prefix */
+  return 0;
+} /* int csnmp_config_add_data_instance_oid */
 
 static int csnmp_config_add_data_values(data_definition_t *dd,
                                         oconfig_item_t *ci) {
@@ -315,9 +311,6 @@ static int csnmp_config_add_data_blacklist(data_definition_t *dd,
     }
   }
 
-  dd->ignores_len = 0;
-  dd->ignores = NULL;
-
   for (int i = 0; i < ci->values_num; ++i) {
     if (strarray_add(&(dd->ignores), &(dd->ignores_len),
                      ci->values[i].value.string) != 0) {
@@ -342,6 +335,14 @@ static int csnmp_config_add_data(oconfig_item_t *ci) {
 
   dd->scale = 1.0;
   dd->shift = 0.0;
+  dd->ignores_len = 0;
+  dd->ignores = NULL;
+
+  dd->plugin_name = strdup("snmp");
+  if (dd->plugin_name == NULL) {
+    ERROR("snmp plugin: Can't allocate memory");
+    return ENOMEM;
+  }
 
   for (int i = 0; i < ci->children_num; i++) {
     oconfig_item_t *option = ci->children + i;
@@ -350,10 +351,35 @@ static int csnmp_config_add_data(oconfig_item_t *ci) {
       status = cf_util_get_string(option, &dd->type);
     else if (strcasecmp("Table", option->key) == 0)
       status = cf_util_get_boolean(option, &dd->is_table);
-    else if (strcasecmp("Instance", option->key) == 0)
-      status = csnmp_config_add_data_instance(dd, option);
+    else if (strcasecmp("Plugin", option->key) == 0)
+      status = cf_util_get_string(option, &dd->plugin_name);
+    else if (strcasecmp("Instance", option->key) == 0) {
+      if (dd->is_table) {
+        /* Instance is OID */
+        WARNING("snmp plugin: Option `Instance' is deprecated, please update "
+                "Data \"%s\" block to use option `TypeInstanceOID'.",
+                dd->name);
+        status = csnmp_config_add_data_instance_oid(dd, option,
+                                                    false /* type instance */);
+      } else {
+        /* Instance is a simple string */
+        WARNING("snmp plugin: Option `Instance' is deprecated, please update "
+                "Data \"%s\" block to use option `TypeInstance'.",
+                dd->name);
+        status = cf_util_get_string(option, &dd->type_instance);
+      }
+    } else if (strcasecmp("PluginInstance", option->key) == 0)
+      status = cf_util_get_string(option, &dd->plugin_instance);
+    else if (strcasecmp("TypeInstance", option->key) == 0)
+      status = cf_util_get_string(option, &dd->type_instance);
+    else if (strcasecmp("PluginInstanceOID", option->key) == 0)
+      status = csnmp_config_add_data_instance_oid(dd, option,
+                                                  true /* plugin instance */);
+    else if (strcasecmp("TypeInstanceOID", option->key) == 0)
+      status = csnmp_config_add_data_instance_oid(dd, option,
+                                                  false /* type instance */);
     else if (strcasecmp("InstancePrefix", option->key) == 0)
-      status = csnmp_config_add_data_instance_prefix(dd, option);
+      status = cf_util_get_string(option, &dd->instance_prefix);
     else if (strcasecmp("Values", option->key) == 0)
       status = csnmp_config_add_data_values(dd, option);
     else if (strcasecmp("Shift", option->key) == 0)
@@ -374,6 +400,37 @@ static int csnmp_config_add_data(oconfig_item_t *ci) {
   } /* for (ci->children) */
 
   while (status == 0) {
+    if (dd->is_table) {
+      if (dd->plugin_instance && dd->instance.is_plugin) {
+        WARNING("snmp plugin: Option `PluginInstance' will be ignored for "
+                "Data `%s'",
+                dd->name);
+      }
+      if (dd->type_instance && !dd->instance.is_plugin) {
+        WARNING("snmp plugin: Option `TypeInstance' will be ignored for Data "
+                "`%s'",
+                dd->name);
+      }
+    } else {
+      if (dd->instance.configured) {
+        if (dd->instance.is_plugin) {
+          WARNING("snmp plugin: Option `PluginInstanceOID' will be ignored for "
+                  "Data `%s'",
+                  dd->name);
+        } else {
+          WARNING("snmp plugin: Option `TypeInstanceOID' will be ignored for "
+                  "Data `%s'",
+                  dd->name);
+        }
+      }
+
+      if (dd->instance_prefix) {
+        WARNING("snmp plugin: data %s: InstancePrefix is ignored when `Table' "
+                "is set to `false'.",
+                dd->name);
+      }
+    }
+
     if (dd->type == NULL) {
       WARNING("snmp plugin: `Type' not given for data `%s'", dd->name);
       status = -1;
@@ -390,6 +447,10 @@ static int csnmp_config_add_data(oconfig_item_t *ci) {
 
   if (status != 0) {
     sfree(dd->name);
+    sfree(dd->type);
+    sfree(dd->plugin_name);
+    sfree(dd->plugin_instance);
+    sfree(dd->type_instance);
     sfree(dd->instance_prefix);
     sfree(dd->values);
     sfree(dd->ignores);
@@ -398,9 +459,16 @@ static int csnmp_config_add_data(oconfig_item_t *ci) {
   }
 
   DEBUG("snmp plugin: dd = { name = %s, type = %s, is_table = %s, values_len = "
-        "%" PRIsz " }",
+        "%" PRIsz ",",
         dd->name, dd->type, (dd->is_table) ? "true" : "false", dd->values_len);
 
+  DEBUG("snmp plugin:        plugin_instance = %s, type_instance = %s,",
+        dd->plugin_instance, dd->type_instance);
+
+  DEBUG("snmp plugin:        instance_by_oid = %s, to_plugin_instance = %s }",
+        (dd->instance.oid.oid_len > 0) ? "true" : "SUBID",
+        (dd->instance.is_plugin) ? "true" : "false");
+
   if (data_head == NULL)
     data_head = dd;
   else {
@@ -589,7 +657,6 @@ static int csnmp_config_add_host(oconfig_item_t *ci) {
 
   for (int i = 0; i < ci->children_num; i++) {
     oconfig_item_t *option = ci->children + i;
-    status = 0;
 
     if (strcasecmp("Address", option->key) == 0)
       status = cf_util_get_string(option, &hd->address);
@@ -598,13 +665,13 @@ static int csnmp_config_add_host(oconfig_item_t *ci) {
     else if (strcasecmp("Version", option->key) == 0)
       status = csnmp_config_add_host_version(hd, option);
     else if (strcasecmp("Timeout", option->key) == 0)
-      cf_util_get_cdtime(option, &hd->timeout);
+      status = cf_util_get_cdtime(option, &hd->timeout);
     else if (strcasecmp("Retries", option->key) == 0)
-      cf_util_get_int(option, &hd->retries);
+      status = cf_util_get_int(option, &hd->retries);
     else if (strcasecmp("Collect", option->key) == 0)
-      csnmp_config_add_host_collect(hd, option);
+      status = csnmp_config_add_host_collect(hd, option);
     else if (strcasecmp("Interval", option->key) == 0)
-      cf_util_get_cdtime(option, &hd->interval);
+      status = cf_util_get_cdtime(option, &hd->interval);
     else if (strcasecmp("Username", option->key) == 0)
       status = cf_util_get_string(option, &hd->username);
     else if (strcasecmp("AuthProtocol", option->key) == 0)
@@ -1135,7 +1202,7 @@ static int csnmp_dispatch_table(host_definition_t *host,
     value_table_ptr[i] = value_table[i];
 
   sstrncpy(vl.host, host->name, sizeof(vl.host));
-  sstrncpy(vl.plugin, "snmp", sizeof(vl.plugin));
+  sstrncpy(vl.plugin, data->plugin_name, sizeof(vl.plugin));
 
   vl.interval = host->interval;
 
@@ -1220,11 +1287,27 @@ static int csnmp_dispatch_table(host_definition_t *host,
       else
         sstrncpy(temp, instance_list_ptr->instance, sizeof(temp));
 
-      if (data->instance_prefix == NULL)
-        sstrncpy(vl.type_instance, temp, sizeof(vl.type_instance));
-      else
-        snprintf(vl.type_instance, sizeof(vl.type_instance), "%s%s",
-                 data->instance_prefix, temp);
+      if (data->instance.is_plugin) {
+        if (data->instance_prefix == NULL)
+          sstrncpy(vl.plugin_instance, temp, sizeof(vl.plugin_instance));
+        else
+          snprintf(vl.plugin_instance, sizeof(vl.plugin_instance), "%s%s",
+                   data->instance_prefix, temp);
+
+        if (data->type_instance)
+          sstrncpy(vl.type_instance, data->type_instance,
+                   sizeof(vl.type_instance));
+      } else {
+        if (data->instance_prefix == NULL)
+          sstrncpy(vl.type_instance, temp, sizeof(vl.type_instance));
+        else
+          snprintf(vl.type_instance, sizeof(vl.type_instance), "%s%s",
+                   data->instance_prefix, temp);
+
+        if (data->plugin_instance)
+          sstrncpy(vl.plugin_instance, data->plugin_instance,
+                   sizeof(vl.plugin_instance));
+      }
     }
 
     vl.values_len = data->values_len;
@@ -1234,12 +1317,7 @@ static int csnmp_dispatch_table(host_definition_t *host,
     for (i = 0; i < data->values_len; i++)
       vl.values[i] = value_table_ptr[i]->value;
 
-    /* If we get here `vl.type_instance' and all `vl.values' have been set
-     * vl.type_instance can be empty, i.e. a blank port description on a
-     * switch if you're using IF-MIB::ifDescr as Instance.
-     */
-    if (vl.type_instance[0] != '\0')
-      plugin_dispatch_values(&vl);
+    plugin_dispatch_values(&vl);
 
     /* prevent leakage of pointer to local variable. */
     vl.values_len = 0;
@@ -1598,9 +1676,13 @@ static int csnmp_read_value(host_definition_t *host, data_definition_t *data) {
   }
 
   sstrncpy(vl.host, host->name, sizeof(vl.host));
-  sstrncpy(vl.plugin, "snmp", sizeof(vl.plugin));
+  sstrncpy(vl.plugin, data->plugin_name, sizeof(vl.plugin));
   sstrncpy(vl.type, data->type, sizeof(vl.type));
-  sstrncpy(vl.type_instance, data->instance.string, sizeof(vl.type_instance));
+  if (data->type_instance)
+    sstrncpy(vl.type_instance, data->type_instance, sizeof(vl.type_instance));
+  if (data->plugin_instance)
+    sstrncpy(vl.plugin_instance, data->plugin_instance,
+             sizeof(vl.plugin_instance));
 
   vl.interval = host->interval;
 
@@ -1714,6 +1796,10 @@ static int csnmp_shutdown(void) {
 
     sfree(data_this->name);
     sfree(data_this->type);
+    sfree(data_this->plugin_name);
+    sfree(data_this->plugin_instance);
+    sfree(data_this->type_instance);
+    sfree(data_this->instance_prefix);
     sfree(data_this->values);
     sfree(data_this->ignores);
     sfree(data_this);