Add SDK metrics string into Connect packet

Author: vareddy

README.md

@@ -27,6 +27,10 @@ Primary aspects are:
 
 For more information on the Architecture of the SDK refer [here](http://aws-iot-device-sdk-embedded-c-docs.s3-website-us-east-1.amazonaws.com/index.html)
 
+## Collection of Metrics
+Beginning with Release v2.2.0 of the SDK, AWS collects usage metrics indicating which language and version of the SDK is being used. This allows us to prioritize our resources towards addressing issues faster in SDKs that see the most and is an important data point. However, we do understand that not all customers would want to report this data by default. In that case, the sending of usage metrics can be easily disabled by the user by setting the `DISABLE_METRICS` flag to true in the
+`aws_iot_config.h` for each application.
+
 ## How to get started ?
 Ensure you understand the AWS IoT platform and create the necessary certificates and policies. For more information on the AWS IoT platform please visit the [AWS IoT developer guide](http://docs.aws.amazon.com/iot/latest/developerguide/iot-security-identity.html).
 

samples/linux/shadow_sample/aws_iot_config.h

@@ -53,4 +53,6 @@
 #define AWS_IOT_MQTT_MIN_RECONNECT_WAIT_INTERVAL 1000 ///< Minimum time before the First reconnect attempt is made as part of the exponential back-off algorithm
 #define AWS_IOT_MQTT_MAX_RECONNECT_WAIT_INTERVAL 128000 ///< Maximum time interval after which exponential back-off will stop attempting to reconnect.
 
+#define DISABLE_METRICS false ///< Disable the collection of metrics by setting this to true
+
 #endif /* SRC_SHADOW_IOT_SHADOW_CONFIG_H_ */

samples/linux/shadow_sample_console_echo/aws_iot_config.h

@@ -53,4 +53,6 @@
 #define AWS_IOT_MQTT_MIN_RECONNECT_WAIT_INTERVAL 1000 ///< Minimum time before the First reconnect attempt is made as part of the exponential back-off algorithm
 #define AWS_IOT_MQTT_MAX_RECONNECT_WAIT_INTERVAL 128000 ///< Maximum time interval after which exponential back-off will stop attempting to reconnect.
 
+#define DISABLE_METRICS false ///< Disable the collection of metrics by setting this to true
+
 #endif /* SRC_SHADOW_IOT_SHADOW_CONFIG_H_ */

samples/linux/subscribe_publish_cpp_sample/aws_iot_config.h

@@ -53,4 +53,6 @@
 #define AWS_IOT_MQTT_MIN_RECONNECT_WAIT_INTERVAL 1000 ///< Minimum time before the First reconnect attempt is made as part of the exponential back-off algorithm
 #define AWS_IOT_MQTT_MAX_RECONNECT_WAIT_INTERVAL 128000 ///< Maximum time interval after which exponential back-off will stop attempting to reconnect.
 
+#define DISABLE_METRICS false ///< Disable the collection of metrics by setting this to true
+
 #endif /* SRC_SHADOW_IOT_SHADOW_CONFIG_H_ */

samples/linux/subscribe_publish_library_sample/aws_iot_config.h

@@ -53,4 +53,6 @@
 #define AWS_IOT_MQTT_MIN_RECONNECT_WAIT_INTERVAL 1000 ///< Minimum time before the First reconnect attempt is made as part of the exponential back-off algorithm
 #define AWS_IOT_MQTT_MAX_RECONNECT_WAIT_INTERVAL 128000 ///< Maximum time interval after which exponential back-off will stop attempting to reconnect.
 
+#define DISABLE_METRICS false ///< Disable the collection of metrics by setting this to true
+
 #endif /* SRC_SHADOW_IOT_SHADOW_CONFIG_H_ */

samples/linux/subscribe_publish_sample/aws_iot_config.h

@@ -53,4 +53,6 @@
 #define AWS_IOT_MQTT_MIN_RECONNECT_WAIT_INTERVAL 1000 ///< Minimum time before the First reconnect attempt is made as part of the exponential back-off algorithm
 #define AWS_IOT_MQTT_MAX_RECONNECT_WAIT_INTERVAL 128000 ///< Maximum time interval after which exponential back-off will stop attempting to reconnect.
 
+#define DISABLE_METRICS false ///< Disable the collection of metrics by setting this to true
+
 #endif /* SRC_SHADOW_IOT_SHADOW_CONFIG_H_ */

src/aws_iot_mqtt_client_connect.c

@@ -39,9 +39,17 @@
 extern "C" {
 #endif
 
+#include <stdio.h>
+
 #include <aws_iot_mqtt_client.h>
 #include "aws_iot_mqtt_client_interface.h"
 #include "aws_iot_mqtt_client_common_internal.h"
+#include "aws_iot_version.h"
+
+#if !DISABLE_METRICS
+#define SDK_METRICS_LEN 25
+#define SDK_METRICS_TEMPLATE "?SDK=C&Version=%d.%d.%d"
+#endif
 
 typedef union {
 	uint8_t all;    /**< all connect flags */
@@ -456,7 +464,9 @@ static IoT_Error_t _aws_iot_mqtt_internal_connect(AWS_IoT_Client *pClient, IoT_C
 IoT_Error_t aws_iot_mqtt_connect(AWS_IoT_Client *pClient, IoT_Client_Connect_Params *pConnectParams) {
 	IoT_Error_t rc, disconRc;
 	ClientState clientState;
-
+#if !DISABLE_METRICS
+	char pUsernameTemp[SDK_METRICS_LEN] = {0};
+#endif
 	FUNC_ENTRY;
 
 	if(NULL == pClient) {
@@ -473,6 +483,13 @@ IoT_Error_t aws_iot_mqtt_connect(AWS_IoT_Client *pClient, IoT_Client_Connect_Par
 
 	aws_iot_mqtt_set_client_state(pClient, clientState, CLIENT_STATE_CONNECTING);
 
+#if !DISABLE_METRICS
+	if (NULL != pConnectParams) {
+		pConnectParams->usernameLen = snprintf(pUsernameTemp, SDK_METRICS_LEN, SDK_METRICS_TEMPLATE, VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH);
+		pConnectParams->pUsername = (char*)&pUsernameTemp;
+	}
+#endif
+
 	rc = _aws_iot_mqtt_internal_connect(pClient, pConnectParams);
 
 	if(SUCCESS != rc) {

tests/integration/include/aws_iot_config.h

@@ -48,4 +48,6 @@
 #define AWS_IOT_MQTT_MIN_RECONNECT_WAIT_INTERVAL 1000		///< Minimum time before the First reconnect attempt is made as part of the exponential back-off algorithm
 #define AWS_IOT_MQTT_MAX_RECONNECT_WAIT_INTERVAL 128000		///< Maximum time interval after which exponential back-off will stop attempting to reconnect.
 
+#define DISABLE_METRICS false ///< Disable the collection of metrics by setting this to true
+
 #endif /* SRC_SHADOW_IOT_SHADOW_CONFIG_H_ */