Introduce Opt-out for Metrics

Author: rakshil14-2

awscrt/mqtt.py

@@ -332,7 +332,7 @@ class Connection(NativeResource):
         proxy_options (Optional[awscrt.http.HttpProxyOptions]):
             Optional proxy options for all connections.
 
-        enable_metrics (bool): Enable IoT SDK metrics in MQTT CONNECT packet username field, including SDK name, version, and platform. Default to True.
+        disable_metrics (bool): Disable IoT SDK metrics in MQTT CONNECT packet username field, including SDK name, version, and platform. Default to False.
 
         metrics (Optional[AWSIoTMetrics]) :  Optional metrics configuration for IoT SDK metrics reporting. If provided, the CRT will use the given metrics. If None, a default AWSIoTMetrics will be created.
         """
@@ -361,7 +361,7 @@ def __init__(self,
                  on_connection_success=None,
                  on_connection_failure=None,
                  on_connection_closed=None,
-                 enable_metrics=True,
+                 disable_metrics=False,
                  metrics=None,
                  ):
 
@@ -415,7 +415,7 @@ def __init__(self,
         self.password = password
         self.socket_options = socket_options if socket_options else SocketOptions()
         self.proxy_options = proxy_options if proxy_options else websocket_proxy_options
-        if enable_metrics:
+        if not disable_metrics:
             self._metrics = create_metrics_mqtt3(metrics, self.proxy_options, self.client.tls_ctx)
         else:
             self._metrics = None

awscrt/mqtt5.py

@@ -1371,7 +1371,7 @@ class ClientOptions:
         on_lifecycle_event_connection_success_fn (Callable[[LifecycleConnectSuccessData],]): Callback for Lifecycle Event Connection Success.
         on_lifecycle_event_connection_failure_fn (Callable[[LifecycleConnectFailureData],]): Callback for Lifecycle Event Connection Failure.
         on_lifecycle_event_disconnection_fn (Callable[[LifecycleDisconnectData],]): Callback for Lifecycle Event Disconnection.
-        enable_metrics (bool): Enable IoT SDK metrics in MQTT CONNECT packet username field, including SDK name, version, and platform. Default to True.
+        disable_metrics (bool): Disable IoT SDK metrics in MQTT CONNECT packet username field, including SDK name, version, and platform. Default to False.
         metrics (Optional[AWSIoTMetrics]) :  Optional metrics configuration for IoT SDK metrics reporting. If provided, the CRT will use the given metrics. If None, a default AWSIoTMetrics will be created.
 
     """
@@ -1400,7 +1400,7 @@ class ClientOptions:
     on_lifecycle_event_connection_success_fn: Callable[[LifecycleConnectSuccessData], None] = None
     on_lifecycle_event_connection_failure_fn: Callable[[LifecycleConnectFailureData], None] = None
     on_lifecycle_event_disconnection_fn: Callable[[LifecycleDisconnectData], None] = None
-    enable_metrics: bool = True
+    disable_metrics: bool = False
     metrics: Optional[AWSIoTMetrics] = None
 
 
@@ -1430,7 +1430,7 @@ def __init__(self, client_options: ClientOptions):
         self._on_lifecycle_connection_failure_cb = _check_callback(
             client_options.on_lifecycle_event_connection_failure_fn)
         self._on_lifecycle_disconnection_cb = _check_callback(client_options.on_lifecycle_event_disconnection_fn)
-        self._enable_metrics = client_options.enable_metrics
+        self._disable_metrics = client_options.disable_metrics
 
     def _ws_handshake_transform(self, http_request_binding, http_headers_binding, native_userdata):
         if self._ws_handshake_transform_cb is None:
@@ -1778,7 +1778,7 @@ def __init__(
             keep_alive_secs: int,
             ack_timeout_secs: int,
             clean_session: int,
-            enable_metrics: bool):
+            disable_metrics: bool):
         self.host_name = host_name
         self.port = port
         self.client_id = "" if client_id is None else client_id
@@ -1789,7 +1789,7 @@ def __init__(
         self.keep_alive_secs: int = 1200 if keep_alive_secs is None else keep_alive_secs
         self.ack_timeout_secs: int = 0 if ack_timeout_secs is None else ack_timeout_secs
         self.clean_session: bool = True if clean_session is None else clean_session
-        self.enable_metrics: bool = True if enable_metrics is None else enable_metrics
+        self.disable_metrics: bool = False if disable_metrics is None else disable_metrics
 
 
 class Client(NativeResource):
@@ -1821,7 +1821,7 @@ def __init__(self, client_options: ClientOptions):
             socket_options = SocketOptions()
 
         # Handle metrics configuration
-        if client_options.enable_metrics:
+        if not client_options.disable_metrics:
             self._metrics = create_metrics_mqtt5(client_options)
         else:
             self._metrics = None
@@ -1877,7 +1877,7 @@ def __init__(self, client_options: ClientOptions):
                                                  client_options.ack_timeout_sec,
                                                  client_options.topic_aliasing_options,
                                                  websocket_is_none,
-                                                 client_options.enable_metrics,
+                                                 not client_options.disable_metrics,
                                                  self._metrics,
                                                  core)
 
@@ -1894,7 +1894,7 @@ def __init__(self, client_options: ClientOptions):
             ack_timeout_secs=client_options.ack_timeout_sec,
             clean_session=(
                 client_options.session_behavior < ClientSessionBehaviorType.REJOIN_ALWAYS if client_options.session_behavior else True),
-            enable_metrics=client_options.enable_metrics)
+            disable_metrics=client_options.disable_metrics)
 
     def start(self):
         """Notifies the MQTT5 client that you want it maintain connectivity to the configured endpoint.
@@ -2148,5 +2148,5 @@ def new_connection(self, on_connection_interrupted=None, on_connection_resumed=N
             websocket_proxy_options=None,
             websocket_handshake_transform=None,
             proxy_options=None,
-            enable_metrics=self.adapter_options.enable_metrics
+            disable_metrics=self.adapter_options.disable_metrics
         )

test/test_mqtt.py

@@ -630,7 +630,7 @@ def _test_mqtt311_direct_connect_basic_auth(self):
             port=input_port,
             username=input_username,
             password=input_password,
-            enable_metrics=False)
+            disable_metrics=True)
         connection.connect().result(TIMEOUT)
         connection.disconnect().result(TIMEOUT)
 
@@ -762,7 +762,7 @@ def sign_function(transform_args, **kwargs):
             password=input_password,
             use_websockets=True,
             websocket_handshake_transform=sign_function,
-            enable_metrics=False)
+            disable_metrics=True)
         connection.connect().result(TIMEOUT)
         connection.disconnect().result(TIMEOUT)
 
@@ -853,7 +853,7 @@ def _test_mqtt311_direct_connect_basic_auth_metrics_enabled(self):
         bootstrap = ClientBootstrap(elg, resolver)
         client = Client(bootstrap, None)
 
-        # Create connection with enable_metrics=True explicitly
+        # Create connection with disable_metrics=False explicitly
         # This should fail because metrics appends to username, corrupting basic auth
         connection = Connection(
             client=client,
@@ -862,7 +862,7 @@ def _test_mqtt311_direct_connect_basic_auth_metrics_enabled(self):
             port=input_port,
             username=input_username,
             password=input_password,
-            enable_metrics=True)
+            disable_metrics=False)
 
         # Connection should fail because metrics corrupts the username for basic auth
         exception_occurred = False

test/test_mqtt5.py

@@ -217,7 +217,7 @@ def _test_direct_connect_minimum(self):
 
         client_options = mqtt5.ClientOptions(
             host_name=input_host_name,
-            enable_metrics=False
+            disable_metrics=True
         )
         callbacks = Mqtt5TestCallbacks()
         client = self._create_client(client_options=client_options, callbacks=callbacks)
@@ -244,7 +244,7 @@ def _test_direct_connect_basic_auth(self):
             host_name=input_host_name,
             port=input_port,
             connect_options=connect_options,
-            enable_metrics=False
+            disable_metrics=True
         )
         callbacks = Mqtt5TestCallbacks()
         client = self._create_client(client_options=client_options, callbacks=callbacks)
@@ -431,7 +431,7 @@ def _test_websocket_connect_basic_auth(self):
             host_name=input_host_name,
             port=input_port,
             connect_options=connect_options,
-            enable_metrics=False
+            disable_metrics=True
         )
         callbacks = Mqtt5TestCallbacks()
         client_options.websocket_handshake_transform = callbacks.ws_handshake_transform
@@ -2216,13 +2216,13 @@ def _test_direct_connect_basic_auth_metrics_enabled(self):
             host_name=input_host_name,
             port=input_port,
             connect_options=connect_options,
-            enable_metrics=True
+            disable_metrics=False
         )
         callbacks = Mqtt5TestCallbacks()
         client = self._create_client(client_options=client_options, callbacks=callbacks)
 
         # Verify metrics are enabled
-        self.assertTrue(client_options.enable_metrics)
+        self.assertFalse(client_options.disable_metrics)
 
         client.start()
         # Connection should fail because metrics corrupts the username for basic auth