update enable_aws_metrics

Author: xiazhvera

awscrt/mqtt.py

@@ -331,7 +331,7 @@ class Connection(NativeResource):
         proxy_options (Optional[awscrt.http.HttpProxyOptions]):
             Optional proxy options for all connections.
 
-        enable_metrics (bool): If true, append AWS IoT metrics to the username. (Default to true)
+        enable_aws_metrics (bool): If true, append AWS IoT metrics to the username. (Default to true)
         """
 
     def __init__(self,
@@ -358,7 +358,7 @@ def __init__(self,
                  on_connection_success=None,
                  on_connection_failure=None,
                  on_connection_closed=None,
-                 enable_metrics=True
+                 enable_aws_metrics=True
                  ):
 
         assert isinstance(client, Client) or isinstance(client, Mqtt5Client)
@@ -408,7 +408,7 @@ def __init__(self,
         self.protocol_operation_timeout_ms = protocol_operation_timeout_ms
         self.will = will
 
-        if enable_metrics:
+        if enable_aws_metrics:
             username = username if username else ""
             username += _get_awsiot_metrics_str(username)
 

awscrt/mqtt5.py

@@ -1372,6 +1372,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_aws_metrics (bool): Whether to append AWS IoT metrics to the username field during CONNECT. Default: True
     """
     host_name: str
     port: int = None
@@ -1398,6 +1399,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_aws_metrics: bool = True
 
 
 def _check_callback(callback):
@@ -1758,11 +1760,10 @@ class Client(NativeResource):
 
     Args:
         client_options (ClientOptions): The ClientOptions dataclass to used to configure the new Client.
-        enable_metrics (bool): Whether to append AWS IoT metrics to the username field during CONNECT. Default: True
 
     """
 
-    def __init__(self, client_options: ClientOptions, enable_metrics: bool = True):
+    def __init__(self, client_options: ClientOptions):
 
         super().__init__()
 
@@ -1789,7 +1790,7 @@ def __init__(self, client_options: ClientOptions, enable_metrics: bool = True):
             will = connect_options.will
 
         username = connect_options.username
-        if enable_metrics:
+        if client_options.enable_aws_metrics:
             username = username if username else ""
             username += _get_awsiot_metrics_str(username)
         connect_options.username = username

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)
+            enable_aws_metrics=False)
         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)
+            enable_aws_metrics=False)
         connection.connect().result(TIMEOUT)
         connection.disconnect().result(TIMEOUT)
 

test/test_mqtt5.py

@@ -230,7 +230,7 @@ def _test_direct_connect_basic_auth(self):
             host_name=input_host_name,
             port=input_port,
             connect_options=connect_options,
-            enable_metrics=False
+            enable_aws_metrics=False
         )
         callbacks = Mqtt5TestCallbacks()
         client = self._create_client(client_options=client_options, callbacks=callbacks)
@@ -413,7 +413,7 @@ def _test_websocket_connect_basic_auth(self):
             client_id=create_client_id(),
             username=input_username,
             password=input_password,
-            enable_metrics=False
+            enable_aws_metrics=False
         )
         client_options = mqtt5.ClientOptions(
             host_name=input_host_name,