Set client.software.name and .version (KIP-511)

edenhill · edenhill · commit 21d89e192471 · 2020-03-06T21:09:56.000+01:00
diff --git a/confluent_kafka/src/confluent_kafka.c b/confluent_kafka/src/confluent_kafka.c
@@ -1672,6 +1672,24 @@ static int common_conf_set_special(PyObject *confdict, rd_kafka_conf_t *conf,
         return 1;
 }
 
+
+/**
+ * @brief KIP-511: Set client.software.name and .version which is reported
+ *          to the broker.
+ *          Errors are ignored here since this is best-effort.
+ */
+static void common_conf_set_software (rd_kafka_conf_t *conf) {
+        char version[128];
+
+        rd_kafka_conf_set(conf, "client.software.name",
+                          "confluent-kafka-python", NULL, 0);
+
+        snprintf(version, sizeof(version), "%s-rdkafka-%s",
+                 CFL_VERSION_STR, rd_kafka_version_str(), NULL, 0);
+        rd_kafka_conf_set(conf, "client.software.version", version, NULL, 0);
+}
+
+
 /**
  * Common config setup for Kafka client handles.
  *
@@ -1745,6 +1763,10 @@ rd_kafka_conf_t *common_conf_setup (rd_kafka_type_t ktype,
 
 	conf = rd_kafka_conf_new();
 
+        /* Set software name and verison prior to applying the confdict to
+         * allow even higher-level clients to override it. */
+        common_conf_set_software(conf);
+
         /*
          * Set debug contexts first to capture all events including plugin loading
          */
@@ -2288,13 +2310,11 @@ static PyObject *libversion (PyObject *self, PyObject *args) {
 			     rd_kafka_version());
 }
 
-/*
- * Version hex representation
- * 0xMMmmRRPP
- * MM=major, mm=minor, RR=revision, PP=patchlevel (not used)
+/**
+ * @brief confluent-kafka-python version.
  */
 static PyObject *version (PyObject *self, PyObject *args) {
-	return Py_BuildValue("si", "1.3.0", 0x01030000);
+	return Py_BuildValue("si", CFL_VERSION_STR, CFL_VERSION);
 }
 
 static PyMethodDef cimpl_methods[] = {
diff --git a/confluent_kafka/src/confluent_kafka.h b/confluent_kafka/src/confluent_kafka.h
@@ -34,6 +34,16 @@
 #endif
 
 
+/**
+ * @brief confluent-kafka-python version, must match that of setup.py.
+ *
+ * Hex version representation:
+ *  0xMMmmRRPP
+ *  MM=major, mm=minor, RR=revision, PP=patchlevel (not used)
+ */
+#define CFL_VERSION     0x01040000
+#define CFL_VERSION_STR "1.4.0"
+
 /**
  * Minimum required librdkafka version. This is checked both during
  * build-time (just below) and runtime (see confluent_kafka.c).
