Standardize logging (#105)

Author: simonkurtz-MSFT

.github/copilot-instructions.python.md

@@ -21,6 +21,7 @@ applyTo: "**/*.py"
 - Keep all imports at the top of the file.
 - Use type hints and concise docstrings (PEP 257).
 - Use 4-space indentation and PEP 8 conventions.
+- Surround an equal sign by a space on each side.
 - Use only straight quotes (U+0027 and U+0022), not typographic quotes.
 - Use whitespace to separate logical sections and add a blank line before `return` statements.
 - Use f-strings unless there is no interpolation.

.vscode/settings.json

@@ -8,23 +8,7 @@
         "./.venv/Scripts/python.exe"
     ],
     "jupyter.kernels.excludePythonEnvironments": [
-        "**/anaconda3/**",
-        "**/conda/**",
-        "**/miniconda3/**",
-        "**/python3.*",
-        "*/site-packages/*",
-        "/bin/python",
-        "/bin/python3",
-        "/opt/python/*/bin/python*",
-        "/usr/bin/python",
-        "/usr/bin/python3",
-        "/usr/local/bin/python",
-        "/usr/local/bin/python3",
-        "python",
-        "python3",
-        "**/.venv/**/python*",
-        "**/Scripts/python*",
-        "**/bin/python*"
+        "apim-samples"
     ],
     "search.exclude": {
         "**/.venv": true,
@@ -66,11 +50,5 @@
     "plantuml.exportFormat": "svg",
     "plantuml.java": "C:\\Program Files\\OpenJDK\\jdk-22.0.2\\bin\\java.exe",
     "plantuml.diagramsRoot": "assets/diagrams/src",
-    "plantuml.exportOutDir": "assets/diagrams/out",
-    "jupyter.kernels.filter": [
-        {
-            "path": "apim-samples",
-            "type": "pythonEnvironment"
-        }
-    ]
-}
+    "plantuml.exportOutDir": "assets/diagrams/out"
+}

README.md

@@ -160,6 +160,16 @@ If you encounter import errors (e.g., `ModuleNotFoundError: No module named 'req
 
 For detailed troubleshooting of setup issues, see [Import Troubleshooting Guide][import-troubleshooting].
 
+---
+
+## 🔎 Logging and Output
+
+The Python helpers in this repo use standard-library `logging` (not ad-hoc `print()`), so you can control verbosity via environment variables.
+
+- `APIM_SAMPLES_LOG_LEVEL`: Controls the overall verbosity (`DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL`). Default: `INFO`.
+   - When set to `DEBUG`, the Azure CLI runner in [shared/python/azure_resources.py](shared/python/azure_resources.py) will also add `--debug` to simple `az ...` commands.
+- `APIM_SAMPLES_CONSOLE_WIDTH`: Optional wrap width for long lines (defaults to `120`).
+
 📘 **For comprehensive troubleshooting including deployment errors, authentication issues, and more, see our main [Troubleshooting Guide][troubleshooting].**
 
 ## 🚀 Running a Sample

infrastructure/afd-apim-pe/create_infrastructure.py

@@ -13,21 +13,16 @@
 
 
 def create_infrastructure(location: str, index: int, apim_sku: APIM_SKU, no_aca: bool = False) -> None:
-    try:
-        # Check if infrastructure already exists to determine messaging
-        infrastructure_exists = az.does_resource_group_exist(az.get_infra_rg_name(INFRASTRUCTURE.AFD_APIM_PE, index))
-
-        # Create custom APIs for AFD-APIM-PE with optional Container Apps backends
-        custom_apis = _create_afd_specific_apis(not no_aca)
+    # Check if infrastructure already exists to determine messaging
+    infrastructure_exists = az.does_resource_group_exist(az.get_infra_rg_name(INFRASTRUCTURE.AFD_APIM_PE, index))
 
-        infra = AfdApimAcaInfrastructure(location, index, apim_sku, infra_apis = custom_apis)
-        result = infra.deploy_infrastructure(infrastructure_exists)
+    # Create custom APIs for AFD-APIM-PE with optional Container Apps backends
+    custom_apis = _create_afd_specific_apis(not no_aca)
 
-        sys.exit(0 if result.success else 1)
+    infra = AfdApimAcaInfrastructure(location, index, apim_sku, infra_apis = custom_apis)
+    result = infra.deploy_infrastructure(infrastructure_exists)
 
-    except Exception as e:
-        print(f'\n💥 Error: {str(e)}')
-        sys.exit(1)
+    raise SystemExit(0 if result.success else 1)
 
 def _create_afd_specific_apis(use_aca: bool = True) -> list[API]:
     """

infrastructure/apim-aca/create_infrastructure.py

@@ -13,22 +13,16 @@
 
 
 def create_infrastructure(location: str, index: int, apim_sku: APIM_SKU) -> None:
-    try:
-        # Check if infrastructure already exists to determine messaging
-        infrastructure_exists = az.does_resource_group_exist(az.get_infra_rg_name(INFRASTRUCTURE.APIM_ACA, index))
-
-        # Create custom APIs for APIM-ACA with Container Apps backends
-        custom_apis = _create_aca_specific_apis()
+    # Check if infrastructure already exists to determine messaging
+    infrastructure_exists = az.does_resource_group_exist(az.get_infra_rg_name(INFRASTRUCTURE.APIM_ACA, index))
 
-        infra = ApimAcaInfrastructure(location, index, apim_sku, infra_apis = custom_apis)
-        result = infra.deploy_infrastructure(infrastructure_exists)
+    # Create custom APIs for APIM-ACA with Container Apps backends
+    custom_apis = _create_aca_specific_apis()
 
-        sys.exit(0 if result.success else 1)
-
-    except Exception as e:
-        print(f'\n💥 Error: {str(e)}')
-        sys.exit(1)
+    infra = ApimAcaInfrastructure(location, index, apim_sku, infra_apis = custom_apis)
+    result = infra.deploy_infrastructure(infrastructure_exists)
 
+    raise SystemExit(0 if result.success else 1)
 
 def _create_aca_specific_apis() -> list[API]:
     """

infrastructure/appgw-apim-pe/create_infrastructure.py

@@ -13,21 +13,16 @@
 
 
 def create_infrastructure(location: str, index: int, apim_sku: APIM_SKU, no_aca: bool = False) -> None:
-    try:
-        # Check if infrastructure already exists to determine messaging
-        infrastructure_exists = az.does_resource_group_exist(az.get_infra_rg_name(INFRASTRUCTURE.APPGW_APIM_PE, index))
-
-        # Create custom APIs for APPGW-APIM-PE with optional Container Apps backends
-        custom_apis = _create_appgw_specific_apis(not no_aca)
+    # Check if infrastructure already exists to determine messaging
+    infrastructure_exists = az.does_resource_group_exist(az.get_infra_rg_name(INFRASTRUCTURE.APPGW_APIM_PE, index))
 
-        infra = AppGwApimPeInfrastructure(location, index, apim_sku, infra_apis = custom_apis)
-        result = infra.deploy_infrastructure(infrastructure_exists)
+    # Create custom APIs for APPGW-APIM-PE with optional Container Apps backends
+    custom_apis = _create_appgw_specific_apis(not no_aca)
 
-        sys.exit(0 if result.success else 1)
+    infra = AppGwApimPeInfrastructure(location, index, apim_sku, infra_apis = custom_apis)
+    result = infra.deploy_infrastructure(infrastructure_exists)
 
-    except Exception as e:
-        print(f'\n💥 Error: {str(e)}')
-        sys.exit(1)
+    raise SystemExit(0 if result.success else 1)
 
 def _create_appgw_specific_apis(use_aca: bool = True) -> list[API]:
     """

infrastructure/appgw-apim-pe/main.bicep

@@ -146,7 +146,7 @@ resource nsgAppGw 'Microsoft.Network/networkSecurityGroups@2024-05-01' = {
           sourceAddressPrefix: 'AzureLoadBalancer'
           destinationAddressPrefix: '*'
           access: 'Allow'
-          priority: 130
+          priority: 120
           direction: 'Inbound'
         }
       }
@@ -221,10 +221,10 @@ module vnetModule '../../shared/bicep/modules/vnet/v1/vnet.bicep' = {
   }
 }
 
-var apimSubnetResourceId            = '${vnetModule.outputs.vnetId}/subnets/${apimSubnetName}'
-var acaSubnetResourceId             = '${vnetModule.outputs.vnetId}/subnets/${acaSubnetName}'
-var appgwSubnetResourceId           = '${vnetModule.outputs.vnetId}/subnets/${appgwSubnetName}'
-var privateEndpointSubnetResourceId = '${vnetModule.outputs.vnetId}/subnets/${privateEndpointSubnetName}'
+var apimSubnetResourceId  = '${vnetModule.outputs.vnetId}/subnets/${apimSubnetName}'
+var acaSubnetResourceId   = '${vnetModule.outputs.vnetId}/subnets/${acaSubnetName}'
+var appgwSubnetResourceId = '${vnetModule.outputs.vnetId}/subnets/${appgwSubnetName}'
+var peSubnetResourceId    = '${vnetModule.outputs.vnetId}/subnets/${privateEndpointSubnetName}'
 
 // 4. User Assigned Managed Identity
 // https://github.com/Azure/bicep-registry-modules/tree/main/avm/res/managed-identity/user-assigned-identity
@@ -340,6 +340,7 @@ module acaModule2 '../../shared/bicep/modules/aca/v1/containerapp.bicep' = if (u
 module apimModule '../../shared/bicep/modules/apim/v1/apim.bicep' = {
   name: 'apimModule'
   params: {
+    apimName: apimName
     apimSku: apimSku
     appInsightsInstrumentationKey: appInsightsInstrumentationKey
     appInsightsId: appInsightsId
@@ -421,11 +422,13 @@ module apisModule '../../shared/bicep/modules/apim/v1/api.bicep' = [for api in a
     appInsightsId: appInsightsId
     api: api
   }
-  dependsOn: [
+  dependsOn: useACA ? [
     apimModule
     backendModule1
     backendModule2
     backendPoolModule
+  ] : [
+    apimModule
   ]
 }]
 
@@ -436,7 +439,7 @@ resource apimPrivateEndpoint 'Microsoft.Network/privateEndpoints@2024-05-01' = {
   location: location
   properties: {
     subnet: {
-      id: privateEndpointSubnetResourceId
+      id: peSubnetResourceId
     }
     privateLinkServiceConnections: [
       {
@@ -476,7 +479,7 @@ module apimDnsPrivateLinkModule '../../shared/bicep/modules/dns/v1/dns-private-l
     dnsZoneName: 'privatelink.azure-api.net'
     vnetId: vnetModule.outputs.vnetId
     vnetLinkName: 'link-apim'
-    enableDnsZoneGroup: true
+    enableDnsZoneGroup: false
     dnsZoneGroupName: 'dnsZoneGroup-apim'
     dnsZoneConfigName: 'config-apim'
   }
@@ -553,7 +556,7 @@ module appgwModule 'br/public:avm/res/network/application-gateway:0.7.2' = {
         properties: {
           backendAddresses: [
             {
-              fqdn: replace(apimModule.outputs.gatewayUrl, 'https://', '')
+              fqdn: '${apimName}.azure-api.net'
             }
           ]
         }
@@ -624,9 +627,6 @@ module appgwModule 'br/public:avm/res/network/application-gateway:0.7.2' = {
       }
     ]
   }
-  dependsOn: [
-    apimPrivateDnsZoneGroup
-  ]
 }
 
 

infrastructure/simple-apim/clean-up.ipynb

@@ -11,27 +11,9 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "👉🏽 \u001b[1;34mCleaning up resources for simple-apim - 1\u001b[0m \n",
-      "👉🏽 \u001b[1;34mResource group : apim-infra-simple-apim-1\u001b[0m \n",
-      "👉🏽 \u001b[1;34mFound 1 resource(s) to clean up. Processing in parallel...\u001b[0m \n",
-      "👉🏽 \u001b[1;34mStarting parallel cleanup of 1 resource(s) with 1 worker(s)...\u001b[0m \n",
-      "👉🏽 \u001b[1;34mDeleting and purging apim 'apim-pwpn7jvwjh7em'...\u001b[0m \n",
-      "✅ \u001b[1;32m✓ Cleaned up apim 'apim-pwpn7jvwjh7em' (1/1)\u001b[0m ⌚ 15:32:07.104892 \n",
-      "\n",
-      "✅ \u001b[1;32mAll 1 resource(s) cleaned up successfully!\u001b[0m ⌚ 15:32:07.104892 \n",
-      "ℹ️ \u001b[1;32mDeleting resource group 'apim-infra-simple-apim-1'...\u001b[0m ⌚ 15:32:07.104892 \n",
-      "ℹ️ \u001b[1;32mCleanup completed.\u001b[0m ⌚ 15:33:26.835597 \n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "from apimtypes import INFRASTRUCTURE\n",
     "from infrastructures import cleanup_infra_deployments\n",

infrastructure/simple-apim/create.ipynb

@@ -54,9 +54,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "APIM Samples Python 3.12",
+   "display_name": ".venv (3.12.10)",
    "language": "python",
-   "name": "apim-samples"
+   "name": "python3"
   },
   "language_info": {
    "codemirror_mode": {

infrastructure/simple-apim/create_infrastructure.py

@@ -9,19 +9,15 @@
 import azure_resources as az
 from apimtypes import APIM_SKU, INFRASTRUCTURE
 from infrastructures import SimpleApimInfrastructure
+from console import print_plain
 
 
 def create_infrastructure(location: str, index: int, apim_sku: APIM_SKU) -> None:
-    try:
-        # Check if infrastructure already exists to determine messaging
-        infrastructure_exists = az.does_resource_group_exist(az.get_infra_rg_name(INFRASTRUCTURE.SIMPLE_APIM, index))
-
-        result = SimpleApimInfrastructure(location, index, apim_sku).deploy_infrastructure(infrastructure_exists)
-        sys.exit(0 if result.success else 1)
+    # Check if infrastructure already exists to determine messaging
+    infrastructure_exists = az.does_resource_group_exist(az.get_infra_rg_name(INFRASTRUCTURE.SIMPLE_APIM, index))
 
-    except Exception as e:
-        print(f'\n💥 Error: {str(e)}')
-        sys.exit(1)
+    result = SimpleApimInfrastructure(location, index, apim_sku).deploy_infrastructure(infrastructure_exists)
+    raise SystemExit(0 if result.success else 1)
 
 def main():
     """
@@ -38,7 +34,7 @@ def main():
     try:
         apim_sku = APIM_SKU(args.sku)
     except ValueError:
-        print(f"Error: Invalid SKU '{args.sku}'. Valid options are: {', '.join([sku.value for sku in APIM_SKU])}")
+        print_plain(f"Error: Invalid SKU '{args.sku}'. Valid options are: {', '.join([sku.value for sku in APIM_SKU])}")
         sys.exit(1)
 
     create_infrastructure(args.location, args.index, apim_sku)