[Cosmos] deprecating old diagnostics (Azure#31133)

* removing old diagnostics

* remove weird uses of record diagnostics

* Revert "removing old diagnostics"

This reverts commit a6d69c1.

* mark diagnostics.py for deprecation

* Update diagnostics.py

* Update diagnostics.py

* Update test_diagnostics.py

* Update diagnostics.py

* CaseInsensitiveDict from azrue.core

* errors importing case insensitive dict which we don't need anyway

* Update test_diagnostics.py

* module-level get_attr returns warning

* Update diagnostics.py

* Update diagnostics.py

* commenting this out to see if pipelines still fail

* retrying the get_attr

* Update diagnostics.py

* Update diagnostics.py

* remove caseinsensitivedict

* Update test_diagnostics.py

* update core version

* Update test_diagnostics.py

* Update CHANGELOG.md

Author: simorenoh

sdk/cosmos/azure-cosmos/CHANGELOG.md

@@ -9,14 +9,16 @@
 #### Bugs Fixed
 
 #### Other Changes
+* Marked the outdated `diagnostics.py` file for deprecation since we now recommend the use of our `CosmosHttpLoggingPolicy` for diagnostics.
+For more on the `CosmosHttpLoggingPolicy` see our [README](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/cosmos/azure-cosmos#logging-diagnostics).
 
 ### 4.5.1 (2023-09-12)
 
 #### Bugs Fixed
 * Fixed bug when query with DISTINCT + OFFSET/LIMIT operators returns unexpected result. See [PR 31925](https://github.com/Azure/azure-sdk-for-python/pull/31925).
 
 #### Other Changes
-- Added additional checks for resource creation using specific characters that cause issues. See [PR 31861](https://github.com/Azure/azure-sdk-for-python/pull/31861).
+* Added additional checks for resource creation using specific characters that cause issues. See [PR 31861](https://github.com/Azure/azure-sdk-for-python/pull/31861).
 
 ### 4.5.0 (2023-08-09)
 

sdk/cosmos/azure-cosmos/README.md

@@ -607,10 +607,10 @@ HTTP status code 409: The ID (name) provided for the container is already in use
 The container name must be unique within the database.""")
 
 ```
-### Logging
+### Logging Diagnostics
 
 This library uses the standard
-[logging](https://docs.python.org/3.5/library/logging.html) library for logging.
+[logging](https://docs.python.org/3.5/library/logging.html) library for logging diagnostics.
 Basic information about HTTP sessions (URLs, headers, etc.) is logged at INFO
 level.
 

sdk/cosmos/azure-cosmos/azure/cosmos/diagnostics.py

@@ -20,13 +20,19 @@
 # SOFTWARE.
 
 """Diagnostic tools for Azure Cosmos database service operations.
+IMPORTANT: This file has been marked for deprecation and will be removed in the future. For diagnostics logging in our
+SDK, please use our CosmosHttpLoggingPolicy outlined in our README.
 """
 
-from requests.structures import CaseInsensitiveDict
+from azure.core.utils import CaseInsensitiveDict
+import warnings
 
 
-class RecordDiagnostics(object):
-    """Record Response headers from Cosmos read operations.
+class _RecordDiagnostics(object):
+    """This file is currently deprecated and will be removed in the future. Please use our CosmosHttpLoggingPolicy
+    for logging SDK diagnostics moving forward. More information on this can be found in our README.
+
+    Record Response headers from Cosmos read operations.
 
     The full response headers are stored in the ``headers`` property.
 
@@ -84,3 +90,16 @@ def __getattr__(self, name):
         if key in self._common:
             return self._headers[key]
         raise AttributeError(name)
+
+
+def __getattr__(name):
+    if name == 'RecordDiagnostics':
+        warnings.warn(
+            "RecordDiagnostics is deprecated and should not be used. " +
+            "For logging diagnostics information for the SDK, please use our CosmosHttpLoggingPolicy. " +
+            "For more information on this, please see our README.",
+            DeprecationWarning
+        )
+        return _RecordDiagnostics
+
+    raise AttributeError(f"module 'azure.cosmos.diagnostics' has no attribute {name}")

sdk/cosmos/azure-cosmos/setup.py

@@ -72,6 +72,6 @@
     packages=find_packages(exclude=exclude_packages),
     python_requires=">=3.6",
     install_requires=[
-        'azure-core<2.0.0,>=1.23.0'
+        'azure-core<2.0.0,>=1.25.0'
     ],
 )

sdk/cosmos/azure-cosmos/test/test_crud.py

@@ -43,7 +43,6 @@
 import test_config
 import azure.cosmos._base as base
 import azure.cosmos.cosmos_client as cosmos_client
-from azure.cosmos.diagnostics import RecordDiagnostics
 from azure.cosmos.partition_key import PartitionKey
 from azure.cosmos import _retry_utility
 import requests
@@ -210,16 +209,10 @@ def test_collection_crud(self):
         before_create_collections_count = len(collections)
         collection_id = 'test_collection_crud ' + str(uuid.uuid4())
         collection_indexing_policy = {'indexingMode': 'consistent'}
-        created_recorder = RecordDiagnostics()
         created_collection = created_db.create_container(id=collection_id,
                                                          indexing_policy=collection_indexing_policy,
-                                                         partition_key=PartitionKey(path="/pk", kind="Hash"), 
-                                                         response_hook=created_recorder)
+                                                         partition_key=PartitionKey(path="/pk", kind="Hash"))
         self.assertEqual(collection_id, created_collection.id)
-        assert isinstance(created_recorder.headers, Mapping)
-        assert 'Content-Type' in created_recorder.headers
-        assert isinstance(created_recorder.body, Mapping)
-        assert 'id' in created_recorder.body
 
         created_properties = created_collection.read()
         self.assertEqual('consistent', created_properties['indexingPolicy']['indexingMode'])

sdk/cosmos/azure-cosmos/test/test_crud_async.py

@@ -40,7 +40,6 @@
 from azure.cosmos.http_constants import HttpHeaders, StatusCodes
 import azure.cosmos._base as base
 from azure.cosmos.aio import CosmosClient, _retry_utility_async
-from azure.cosmos.diagnostics import RecordDiagnostics
 from azure.cosmos.partition_key import PartitionKey
 import requests
 from urllib3.util.retry import Retry
@@ -198,16 +197,10 @@ async def test_collection_crud(self):
         before_create_collections_count = len(collections)
         collection_id = 'test_collection_crud ' + str(uuid.uuid4())
         collection_indexing_policy = {'indexingMode': 'consistent'}
-        created_recorder = RecordDiagnostics()
         created_collection = await created_db.create_container(id=collection_id,
                                                                indexing_policy=collection_indexing_policy,
-                                                               partition_key=PartitionKey(path="/pk", kind="Hash"),
-                                                               response_hook=created_recorder)
+                                                               partition_key=PartitionKey(path="/pk", kind="Hash"))
         self.assertEqual(collection_id, created_collection.id)
-        assert isinstance(created_recorder.headers, Mapping)
-        assert 'Content-Type' in created_recorder.headers
-        assert isinstance(created_recorder.body, Mapping)
-        assert 'id' in created_recorder.body
 
         created_properties = await created_collection.read()
         self.assertEqual('consistent', created_properties['indexingPolicy']['indexingMode'])

sdk/cosmos/azure-cosmos/test/test_diagnostics.py

@@ -1,11 +1,9 @@
-import unittest
 import pytest
 import azure.cosmos.diagnostics as m
 
 _common = {
     'x-ms-activity-id',
     'x-ms-session-token',
-
     'x-ms-item-count',
     'x-ms-request-quota',
     'x-ms-resource-usage',
@@ -15,7 +13,8 @@
 _headers = dict(zip(_common, _common))
 _headers['other'] = 'other'
 
-class BaseUnitTests(unittest.TestCase):
+
+class TestOldDiagnostics:
 
     def test_init(self):
         rh = m.RecordDiagnostics()
@@ -33,7 +32,7 @@ def test_headers_case(self):
         rh_headers = rh.headers
         for key in rh.headers.keys():
             assert key.upper() in rh_headers
-            assert key.lower() in rh_headers 
+            assert key.lower() in rh_headers
 
     def test_common_attrs(self):
         rh = m.RecordDiagnostics()