App Configuration Provider Update (Azure#30477)

* Update async_key_vault_reference_provided_clients_sample.py

* Adding disable

* setting retry backoff max

* Update CHANGELOG.md

* Fixing formatting

* Fixed None issue

* Fixing kwargs usage

* Update _azureappconfigurationprovider.py

* fixed retry

* Update README.md

* Update README.md

* setting max time to 2 and max time to 1

* Update _azureappconfigurationproviderasync.py

* Fixed Whitespace and Updated Change Log

* Update sdk/appconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/_azureappconfigurationprovider.py

Co-authored-by: Xiang Yan <[email protected]>

* Review comments, Fixing constant, retry usage

* Update _azureappconfigurationproviderasync.py

* Update CHANGELOG.md

* Updating async too, formatting

* changed get_correlation_context into get_header

* Cleaning up user agent. fixed indentation on async

* fixing headers

* Updated env check

* Update _azureappconfigurationproviderasync.py

* Clean up imports

* Update _azureappconfigurationprovider.py

---------

Co-authored-by: Xiang Yan <[email protected]>

Author: mrm9084

sdk/appconfiguration/azure-appconfiguration-provider/CHANGELOG.md

@@ -10,6 +10,10 @@
 
 ### Other Changes
 
+* Updated to use AZURE_APP_CONFIGURATION_TRACING_DISABLED environment variable to disable tracing.
+* Changed the maximum number of retries to 2 from the default of 3 retries.
+* Changed the maximum back off time between retries to 1 minute from the default of 2 minutes.
+
 ## 1.0.0 (2023-03-09)
 
 ### Breaking Changes

sdk/appconfiguration/azure-appconfiguration-provider/README.md

@@ -21,16 +21,20 @@ Alternatively, get the connection string from the Azure Portal.
 You can create a client with a connection string:
 
 ```python
+from azure.appconfiguration.provider import load
+
 config = load(connection_string="your-connection-string")
 ```
 
 or with AAD:
 
 ```python
+from azure.appconfiguration.provider import load
+
 config = load(endpoint="your-endpoint", credential=DefaultAzureCredential())
 ```
 
-these providers will by default load all configurations with `(No Label)` from your configuration store.
+these providers will by default load all configurations with `(No Label)` from your configuration store into a dictionary of key/values.
 
 ### Features
 
@@ -59,16 +63,23 @@ List of features we are going to add to the Python Provider in the future.
 You can refine or expand the configurations loaded from your store by using `SettingSelector`s. Setting selectors provide a way to pass a key filter and label filter into the provider.
 
 ```python
+from azure.appconfiguration.provider import load, SettingSelector
+from azure.identity import DefaultAzureCredential
+
 selects = {SettingSelector(key_filter="*", label_filter="\0"), SettingSelector(key_filter="*", label_filter="dev")}
 config = load(endpoint=endpoint, credential=DefaultAzureCredential(), selects=selects)
 ```
+
 In this example all configuration with empty label and the dev label are loaded. Because the dev selector is listed last, any configurations from dev take priority over those with `(No Label)` when duplicates are found.
 
 ### Trimming Keys
 
 You can trim the prefix off of keys by providing a list of trimmed key prefixes to the provider. For example, if you have the key(s) like `/application/message` in your configuration store, you could trim `/application/` from them.
 
 ```python
+from azure.appconfiguration.provider import load
+from azure.identity import DefaultAzureCredential
+
 trim_prefixes={"/application/"}
 config = load(endpoint=endpoint, credential=DefaultAzureCredential(), trim_prefixes=trim_prefixes)
 print(config["message"])
@@ -83,14 +94,21 @@ Key Vault References can be resolved by providing credentials to your key vault
 You can provide `AzureAppConfigurationKeyVaultOptions` with a credential and all key vault references will be resolved with it. The provider will attempt to connect to any key vault referenced with the credential provided.
 
 ```python
+from azure.appconfiguration.provider import load, AzureAppConfigurationKeyVaultOptions
+from azure.identity import DefaultAzureCredential
+
 key_vault_options = AzureAppConfigurationKeyVaultOptions(credential=DefaultAzureCredential())
 config = load(endpoint=endpoint, credential=DefaultAzureCredential(), key_vault_options=key_vault_options)
 ```
+
 ### With Clients
 
 You can provide `AzureAppConfigurationKeyVaultOptions` with a list of `SecretClients`.
 
 ```python
+from azure.appconfiguration.provider import load, AzureAppConfigurationKeyVaultOptions
+from azure.identity import DefaultAzureCredential
+
 key_vault_options = AzureAppConfigurationKeyVaultOptions(
     client_configs={key_vault_uri: {'credential': credential}})
 config = load(endpoint=endpoint, credential=DefaultAzureCredential(), key_vault_options=key_vault_options)
@@ -101,6 +119,9 @@ config = load(endpoint=endpoint, credential=DefaultAzureCredential(), key_vault_
 If no Credentials or Clients are provided a secret resolver can be used. Secret resolver provides a way to return any value you want to a key vault reference.
 
 ```python
+from azure.appconfiguration.provider import load, AzureAppConfigurationKeyVaultOptions
+from azure.identity import DefaultAzureCredential
+
 def secret_resolver(uri):
     return "From Secret Resolver"
 
@@ -126,7 +147,7 @@ Check out our Django and Flask examples to see how to use the provider in a web
 This project welcomes contributions and suggestions. Most contributions require
 you to agree to a Contributor License Agreement (CLA) declaring that you have
 the right to, and actually do, grant us the rights to use your contribution.
-For details, visit https://cla.microsoft.com.
+For details, visit <https://cla.microsoft.com>.
 
 When you submit a pull request, a CLA-bot will automatically determine whether
 you need to provide a CLA and decorate the PR appropriately (e.g., label,
@@ -135,11 +156,8 @@ need to do this once across all repos using our CLA.
 
 This project has adopted the
 [Microsoft Open Source Code of Conduct][code_of_conduct]. For more information,
-see the Code of Conduct FAQ or contact [email protected] with any
+see the Code of Conduct FAQ or contact <[email protected]> with any
 additional questions or comments.
 
 [azure_cli]: https://learn.microsoft.com/cli/azure/appconfig
-[cla]: https://cla.microsoft.com
 [code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
-[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/
-[coc_contact]: mailto:[email protected]

sdk/appconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/_azureappconfigurationprovider.py

@@ -16,6 +16,7 @@
 from ._constants import (
     FEATURE_MANAGEMENT_KEY,
     FEATURE_FLAG_PREFIX,
+    REQUEST_TRACING_DISABLED_ENVIRONMENT_VARIABLE,
     ServiceFabricEnvironmentVariable,
     AzureFunctionEnvironmentVariable,
     AzureWebAppEnvironmentVariable,
@@ -117,7 +118,6 @@ def load(*args, **kwargs) -> "AzureAppConfigurationProvider":
             key_filter=select.key_filter, label_filter=select.label_filter
         )
         for config in configurations:
-
             trimmed_key = config.key
             # Trim the key if it starts with one of the prefixes provided
             for trim in provider._trim_prefixes:
@@ -148,26 +148,29 @@ def load(*args, **kwargs) -> "AzureAppConfigurationProvider":
     return provider
 
 
-def _get_correlation_context(key_vault_options: Optional[AzureAppConfigurationKeyVaultOptions]) -> str:
-    correlation_context = "RequestType=Startup"
-    if key_vault_options and (
-        key_vault_options.credential or key_vault_options.client_configs or key_vault_options.secret_resolver
-    ):
-        correlation_context += ",UsesKeyVault"
-    host_type = ""
-    if os.environ.get(AzureFunctionEnvironmentVariable) is not None:
-        host_type = "AzureFunctions"
-    elif os.environ.get(AzureWebAppEnvironmentVariable) is not None:
-        host_type = "AzureWebApps"
-    elif os.environ.get(ContainerAppEnvironmentVariable) is not None:
-        host_type = "ContainerApps"
-    elif os.environ.get(KubernetesEnvironmentVariable) is not None:
-        host_type = "Kubernetes"
-    elif os.environ.get(ServiceFabricEnvironmentVariable) is not None:
-        host_type = "ServiceFabric"
-    if host_type:
-        correlation_context += ",Host=" + host_type
-    return correlation_context
+def _get_headers(key_vault_options: Optional[AzureAppConfigurationKeyVaultOptions], **kwargs) -> str:
+    headers = kwargs.pop("headers", {})
+    if os.environ.get(REQUEST_TRACING_DISABLED_ENVIRONMENT_VARIABLE, default="").lower() != "true":
+        correlation_context = "RequestType=Startup"
+        if key_vault_options and (
+            key_vault_options.credential or key_vault_options.client_configs or key_vault_options.secret_resolver
+        ):
+            correlation_context += ",UsesKeyVault"
+        host_type = ""
+        if AzureFunctionEnvironmentVariable in os.environ:
+            host_type = "AzureFunction"
+        elif AzureWebAppEnvironmentVariable in os.environ:
+            host_type = "AzureWebApp"
+        elif ContainerAppEnvironmentVariable in os.environ:
+            host_type = "ContainerApp"
+        elif KubernetesEnvironmentVariable in os.environ:
+            host_type = "Kubernetes"
+        elif ServiceFabricEnvironmentVariable in os.environ:
+            host_type = "ServiceFabric"
+        if host_type:
+            correlation_context += ",Host=" + host_type
+        headers["Correlation-Context"] = correlation_context
+    return headers
 
 
 def _buildprovider(
@@ -179,17 +182,29 @@ def _buildprovider(
 ) -> "AzureAppConfigurationProvider":
     # pylint:disable=protected-access
     provider = AzureAppConfigurationProvider()
-    headers = kwargs.pop("headers", {})
-    headers["Correlation-Context"] = _get_correlation_context(key_vault_options)
-    useragent = USER_AGENT
+    headers = _get_headers(key_vault_options, **kwargs)
+
+    retry_total = kwargs.pop("retry_total", 2)
+    retry_backoff_max = kwargs.pop("retry_backoff_max", 60)
 
     if connection_string:
         provider._client = AzureAppConfigurationClient.from_connection_string(
-            connection_string, user_agent=useragent, headers=headers, **kwargs
+            connection_string,
+            user_agent=USER_AGENT,
+            headers=headers,
+            retry_total=retry_total,
+            retry_backoff_max=retry_backoff_max,
+            **kwargs
         )
         return provider
     provider._client = AzureAppConfigurationClient(
-        endpoint, credential, user_agent=useragent, headers=headers, **kwargs
+        endpoint,
+        credential,
+        user_agent=USER_AGENT,
+        headers=headers,
+        retry_total=retry_total,
+        retry_backoff_max=retry_backoff_max,
+        **kwargs
     )
     return provider
 

sdk/appconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/_constants.py

@@ -9,7 +9,7 @@
 
 EMPTY_LABEL = "\0"
 
-RequestTracingDisabledEnvironmentVariable = "AZURE_APP_CONFIGURATION_TRACING_DISABLED"
+REQUEST_TRACING_DISABLED_ENVIRONMENT_VARIABLE = "AZURE_APP_CONFIGURATION_TRACING_DISABLED"
 AzureFunctionEnvironmentVariable = "FUNCTIONS_EXTENSION_VERSION"
 AzureWebAppEnvironmentVariable = "WEBSITE_SITE_NAME"
 ContainerAppEnvironmentVariable = "CONTAINER_APP_NAME"

sdk/appconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/aio/_azureappconfigurationproviderasync.py

@@ -12,8 +12,12 @@
 from azure.keyvault.secrets import KeyVaultSecretIdentifier
 
 from .._models import AzureAppConfigurationKeyVaultOptions, SettingSelector
-from .._constants import FEATURE_MANAGEMENT_KEY, FEATURE_FLAG_PREFIX, EMPTY_LABEL
-from .._azureappconfigurationprovider import _is_json_content_type, _get_correlation_context
+from .._constants import (
+    FEATURE_MANAGEMENT_KEY,
+    FEATURE_FLAG_PREFIX,
+    EMPTY_LABEL,
+)
+from .._azureappconfigurationprovider import _is_json_content_type, _get_headers
 from .._user_agent import USER_AGENT
 
 if TYPE_CHECKING:
@@ -108,7 +112,6 @@ async def load(*args, **kwargs) -> "AzureAppConfigurationProvider":
             key_filter=select.key_filter, label_filter=select.label_filter
         )
         async for config in configurations:
-
             trimmed_key = config.key
             # Trim the key if it starts with one of the prefixes provided
             for trim in provider._trim_prefixes:
@@ -148,17 +151,29 @@ def _buildprovider(
 ) -> "AzureAppConfigurationProvider":
     # pylint:disable=protected-access
     provider = AzureAppConfigurationProvider()
-    headers = kwargs.pop("headers", {})
-    headers["Correlation-Context"] = _get_correlation_context(key_vault_options)
-    useragent = USER_AGENT
+    headers = _get_headers(key_vault_options, **kwargs)
+
+    retry_total = kwargs.pop("retry_total", 2)
+    retry_backoff_max = kwargs.pop("retry_backoff_max", 60)
 
     if connection_string:
         provider._client = AzureAppConfigurationClient.from_connection_string(
-            connection_string, user_agent=useragent, headers=headers, **kwargs
+            connection_string,
+            user_agent=USER_AGENT,
+            headers=headers,
+            retry_total=retry_total,
+            retry_backoff_max=retry_backoff_max,
+            **kwargs
         )
         return provider
     provider._client = AzureAppConfigurationClient(
-        endpoint, credential, user_agent=useragent, headers=headers, **kwargs
+        endpoint,
+        credential,
+        user_agent=USER_AGENT,
+        headers=headers,
+        retry_total=retry_total,
+        retry_backoff_max=retry_backoff_max,
+        **kwargs
     )
     return provider