[Monitor] Fix version in user agent strings (Azure#39866)

In all the Azure Monitor Ingestion and Query clients, the sdk_moniker
keyword argument passed to the UserAgentPolicy was always set to
"unknown". This update will make it reflect the actual package version.

Signed-off-by: Paul Van Eck <[email protected]>

Author: pvaneck

sdk/monitor/azure-monitor-ingestion/CHANGELOG.md

@@ -8,6 +8,8 @@
 
 ### Bugs Fixed
 
+- Fixed an issue where the package version in operation user agent strings was always set to "unknown" instead of the actual package version. ([#39866](https://github.com/Azure/azure-sdk-for-python/pull/39866))
+
 ### Other Changes
 
 ## 1.0.4 (2024-06-11)

sdk/monitor/azure-monitor-ingestion/azure/monitor/ingestion/_patch.py

@@ -6,8 +6,14 @@
 
 Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize
 """
+from typing import Any, TYPE_CHECKING
+
 from ._client import LogsIngestionClient as GeneratedClient
 from ._models import LogsUploadError
+from ._version import SDK_MONIKER
+
+if TYPE_CHECKING:
+    from azure.core.credentials import TokenCredential
 
 
 class LogsIngestionClient(GeneratedClient):
@@ -41,6 +47,10 @@ class LogsIngestionClient(GeneratedClient):
             :caption: Creating the LogsIngestionClient for use with a sovereign cloud (i.e. non-public cloud).
     """
 
+    def __init__(self, endpoint: str, credential: "TokenCredential", **kwargs: Any) -> None:
+        kwargs.setdefault("sdk_moniker", SDK_MONIKER)
+        super().__init__(endpoint=endpoint, credential=credential, **kwargs)
+
 
 __all__ = ["LogsIngestionClient", "LogsUploadError"]
 

sdk/monitor/azure-monitor-ingestion/azure/monitor/ingestion/_version.py

@@ -7,3 +7,4 @@
 # --------------------------------------------------------------------------
 
 VERSION = "1.0.5"
+SDK_MONIKER = f"monitor-ingestion/{VERSION}"

sdk/monitor/azure-monitor-ingestion/azure/monitor/ingestion/aio/_patch.py

@@ -6,8 +6,12 @@
 
 Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize
 """
-from typing import List
+from typing import List, Any, TYPE_CHECKING
 from ._client import LogsIngestionClient as GeneratedClient
+from .._version import SDK_MONIKER
+
+if TYPE_CHECKING:
+    from azure.core.credentials_async import AsyncTokenCredential
 
 
 class LogsIngestionClient(GeneratedClient):
@@ -41,6 +45,10 @@ class LogsIngestionClient(GeneratedClient):
             :caption: Creating the LogsIngestionClient for use with a sovereign cloud (i.e. non-public cloud).
     """
 
+    def __init__(self, endpoint: str, credential: "AsyncTokenCredential", **kwargs: Any) -> None:
+        kwargs.setdefault("sdk_moniker", SDK_MONIKER)
+        super().__init__(endpoint=endpoint, credential=credential, **kwargs)
+
 
 __all__: List[str] = ["LogsIngestionClient"]
 

sdk/monitor/azure-monitor-ingestion/tests/test_logs_ingestion.py

@@ -13,6 +13,7 @@
 
 from azure.core.exceptions import HttpResponseError
 from azure.monitor.ingestion import LogsIngestionClient
+from azure.monitor.ingestion._version import VERSION
 
 from base_testcase import LogsIngestionClientTestCase
 
@@ -153,3 +154,10 @@ def test_invalid_logs_format(self, monitor_info, logs):
 
         with pytest.raises(ValueError):
             client.upload(rule_id="rule", stream_name="stream", logs=logs)
+
+    def test_user_agent_version(self, monitor_info):
+        client = self.get_client(
+            LogsIngestionClient, self.get_credential(LogsIngestionClient), endpoint=monitor_info["dce"]
+        )
+
+        assert f"monitor-ingestion/{VERSION}" in client._config.user_agent_policy._user_agent

sdk/monitor/azure-monitor-ingestion/tests/test_logs_ingestion_async.py

@@ -13,6 +13,7 @@
 
 from azure.core.exceptions import HttpResponseError
 from azure.monitor.ingestion.aio import LogsIngestionClient
+from azure.monitor.ingestion._version import VERSION
 
 from base_testcase import LogsIngestionClientTestCase
 
@@ -169,3 +170,12 @@ async def test_invalid_logs_format(self, monitor_info, logs):
             with pytest.raises(ValueError):
                 await client.upload(rule_id="rule", stream_name="stream", logs=logs)
         await credential.close()
+
+    @pytest.mark.asyncio
+    async def test_user_agent_version(self, monitor_info):
+        credential = self.get_credential(LogsIngestionClient, is_async=True)
+        client = self.get_client(LogsIngestionClient, credential, endpoint=monitor_info["dce"])
+
+        async with client:
+            assert f"azsdk-python-monitor-ingestion/{VERSION}" in client._config.user_agent_policy.user_agent
+        await credential.close()

sdk/monitor/azure-monitor-query/CHANGELOG.md

@@ -8,6 +8,8 @@
 
 ### Bugs Fixed
 
+- Fixed an issue where the package version in operation user agent strings was always set to "unknown" instead of the actual package version. ([#39866](https://github.com/Azure/azure-sdk-for-python/pull/39866))
+
 ### Other Changes
 
 ## 1.4.1 (2025-01-14)

sdk/monitor/azure-monitor-query/azure/monitor/query/_logs_query_client.py

@@ -22,6 +22,7 @@
 )
 from ._models import LogsBatchQuery, LogsQueryResult, LogsQueryPartialResult
 from ._exceptions import LogsQueryError
+from ._version import SDK_MONIKER
 
 JSON = MutableMapping[str, Any]
 
@@ -67,6 +68,7 @@ def __init__(self, credential: TokenCredential, **kwargs: Any) -> None:
         audience = kwargs.pop("audience", f"{parsed_endpoint.scheme}://{parsed_endpoint.netloc}")
         self._endpoint = endpoint
         auth_policy = kwargs.pop("authentication_policy", None)
+        kwargs.setdefault("sdk_moniker", SDK_MONIKER)
         self._client = MonitorQueryClient(
             credential=credential,
             authentication_policy=auth_policy or get_authentication_policy(credential, audience),
@@ -132,9 +134,7 @@ def query_workspace(
 
         generated_response: JSON = {}
         try:
-            generated_response = self._query_op.execute(
-                workspace_id=workspace_id, body=body, prefer=prefer, **kwargs
-            )
+            generated_response = self._query_op.execute(workspace_id=workspace_id, body=body, prefer=prefer, **kwargs)
         except HttpResponseError as err:
             process_error(err, LogsQueryError)
 

sdk/monitor/azure-monitor-query/azure/monitor/query/_metrics_client.py

@@ -15,6 +15,7 @@
 from ._models import MetricsQueryResult
 from ._enums import MetricAggregationType
 from ._helpers import get_authentication_policy, get_timespan_iso8601_endpoints, get_subscription_id_from_resource
+from ._version import SDK_MONIKER
 
 JSON = MutableMapping[str, Any]
 
@@ -59,7 +60,7 @@ def __init__(self, endpoint: str, credential: TokenCredential, **kwargs: Any) ->
         authentication_policy = kwargs.pop("authentication_policy", None) or get_authentication_policy(
             credential, audience
         )
-
+        kwargs.setdefault("sdk_moniker", SDK_MONIKER)
         self._client = MonitorBatchMetricsClient(
             credential=credential, endpoint=self._endpoint, authentication_policy=authentication_policy, **kwargs
         )

sdk/monitor/azure-monitor-query/azure/monitor/query/_metrics_query_client.py

@@ -15,6 +15,7 @@
 from ._generated.metrics._client import MonitorMetricsClient
 from ._models import MetricsQueryResult, MetricDefinition, MetricNamespace
 from ._helpers import get_authentication_policy, construct_iso8601
+from ._version import SDK_MONIKER
 
 
 class MetricsQueryClient(object):  # pylint: disable=client-accepts-api-version-keyword
@@ -57,7 +58,7 @@ def __init__(self, credential: TokenCredential, **kwargs: Any) -> None:
         authentication_policy = kwargs.pop("authentication_policy", None) or get_authentication_policy(
             credential, audience
         )
-
+        kwargs.setdefault("sdk_moniker", SDK_MONIKER)
         self._client = MonitorMetricsClient(
             credential=credential, endpoint=self._endpoint, authentication_policy=authentication_policy, **kwargs
         )