Updated log messages (#148)

* Updated log messages

* Enable local hook to remove __init__.py files

* Updated documentation

* Update project version to 0.3.18

* Update changelog for version v0.3.18

Updated version number and log message details.

Author: xop5

cfa/cloudops/_function_app_client.py

@@ -105,6 +105,9 @@ def _find_available_function_app(self) -> str:
         result = self.conn.sql(query).fetchdf()
         if not result.empty:
             available_function_app = result.iloc[0]["FunctionAppName"]
+            logger.info(
+                f"FunctionAppClient._find_available_function_app: Found available function app: {available_function_app}"
+            )
         return available_function_app
 
     def _allocate_function_app(self):
@@ -120,6 +123,9 @@ def _allocate_function_app(self):
             TO '{FUNCTION_APPS_CSV_PATH}'
             (HEADER, DELIMITER ',', OVERWRITE 1)
         """)
+        logger.info(
+            f"FunctionAppClient._allocate_function_app: Assigned function app to user package: {self.function_app_name}"
+        )
         return True
 
     def _log_into_portal(self) -> bool:
@@ -146,12 +152,12 @@ def _log_into_portal(self) -> bool:
                 check=True,
             )
             logger.info(
-                "cfaazurefunction.log_into_portal(): Logged into Azure Portal successfully "
+                "FunctionAppClient.log_into_portal(): Logged into Azure Portal successfully "
             )
             return True
         except subprocess.CalledProcessError as e:
             logger.error(
-                f"cfaazurefunction.log_into_portal(): Error logging into Azure Portal.{e}"
+                f"FunctionAppClient.log_into_portal(): Error logging into Azure Portal.{e}"
             )
             return False
 
@@ -173,12 +179,12 @@ def _enable_health_check(self):
                 check=True,
             )
             logger.info(
-                "cfaazurefunction.enable_health_check(): Function health check enabled."
+                "FunctionAppClient.enable_health_check(): Function health check enabled."
             )
             return True
         except subprocess.CalledProcessError as e:
             logger.error(
-                f"cfaazurefunction.enable_health_check(): Error updating health check {e}"
+                f"FunctionAppClient.enable_health_check(): Error updating health check {e}"
             )
             return False
 
@@ -200,12 +206,12 @@ def _update_app_settings(self, settings: List[Tuple[str, str]]):
                 arguments.append(f"{key}={value}")
             subprocess.run(arguments, check=True)
             logger.info(
-                "cfaazurefunction.update_app_settings(): Function app settings updated successfully."
+                "FunctionAppClient.update_app_settings(): Function app settings updated successfully."
             )
             return True
         except subprocess.CalledProcessError as e:
             logger.error(
-                f"cfaazurefunction.update_app_settings(): Error updating app settings for Function App {e}"
+                f"FunctionAppClient.update_app_settings(): Error updating app settings for Function App {e}"
             )
             return False
 
@@ -289,7 +295,7 @@ def _publish_function(
             os.chdir(parent_path)
             self._delete_deployment_folder()
             logger.info(
-                "cfaazurefunction.publish_function(): Function app published successfully to {self.function_app_name}."
+                "FunctionAppClient.publish_function(): Function app published successfully to {self.function_app_name}."
             )
 
             # Now update the schedule in function app
@@ -382,7 +388,7 @@ def my_function():
             function_name = self._find_available_function_app()
             if not function_name:
                 logger.error(
-                    "cfaazurefunction.deploy_function(): Deployment aborted because no function apps are available. Please provision additional function apps."
+                    "FunctionAppClient.deploy_function(): Deployment aborted because no function apps are available. Please provision additional function apps."
                 )
                 return False
             self.function_app_name = function_name
@@ -398,7 +404,7 @@ def my_function():
             return False
         if not self._allocate_function_app():
             logger.info(
-                "cfaazurefunction.deploy_function(): Unable to assign function app to user provided applicaion."
+                "FunctionAppClient.deploy_function(): Unable to assign function app to user provided application."
             )
         if not self._restart_function():
             logger.error(

changelog.md

@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 The versioning pattern is `major.minor.patch`.
 
 ---
+## v0.3.18
+- updated log messages in `FunctionAppClient` module to store the correct class name
+
 ## v0.3.17
 - set a maximum version for libraries to avoid breaking changes from updates
 
@@ -15,6 +18,7 @@ The versioning pattern is `major.minor.patch`.
 
 ## v0.3.15
 - set an upper limit for azure-mgmt-batch package to undo its breaking changes
+>>>>>>> main
 
 ## v0.3.14
 - fixed defect in `batch_helpers.get_rel_mnt_path` function for getting optional mount configuration in a pool

docs/FunctionAppClient/index.md

@@ -303,9 +303,9 @@ FunctionAppClient performs the following operations when the user invokes the `d
 
 | Sequence | Operation        | Purpose                                                                                           | Error Log Prefix                                                                           |
 |----------|------------------|---------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------|
-| 1        | log_into_portal  | Log into Azure portal as service principal                                                       | `cfaazurefunction.log_into_portal(): Error logging into Azure Portal.`                     |
-| 2        | publish_function | Create a zip file with Python template and user package. Upload the zip file to function app created in the previous step. | `cfaazurefunction.publish_function(): Error publishing Function App`                       |
-| 3        | restart_function | Restart the function app                                                                          | `cfaazurefunction.restart_function(): Error restarting Function App`                       |
+| 1        | log_into_portal  | Log into Azure portal as service principal                                                       | `FunctionAppClient.log_into_portal(): Error logging into Azure Portal.`                     |
+| 2        | publish_function | Create a zip file with Python template and user package. Upload the zip file to function app created in the previous step. | `FunctionAppClient.publish_function(): Error publishing Function App`                       |
+| 3        | restart_function | Restart the function app                                                                          | `FunctionAppClient.restart_function(): Error restarting Function App`                       |
 
 All errors and exceptions encountered during deployment shall be written to the console (e.g., Shell, PowerShell). The error log prefix indicates which stage that error occurred in.
 
@@ -327,29 +327,29 @@ Select logs from cfatimer panel:
 ### Detailed Error Messages
 
 ### Login Errors:
-- `cfaazurefunction.retrieve_secret()`: Unable to connect to Key Vault: `AZURE_SERVICE_PRINCIPAL_ID` environment variable is missing.
-- `cfaazurefunction.retrieve_secret()`: One of these must be provided: `AZURE_SERVICE_PRINCIPAL_SECRET_NAME` or `AZURE_SERVICE_PRINCIPAL_SECRET`
-- `cfaazurefunction.log_into_portal()`: Error logging into Azure Portal.
+- `FunctionAppClient.retrieve_secret()`: Unable to connect to Key Vault: `AZURE_SERVICE_PRINCIPAL_ID` environment variable is missing.
+- `FunctionAppClient.retrieve_secret()`: One of these must be provided: `AZURE_SERVICE_PRINCIPAL_SECRET_NAME` or `AZURE_SERVICE_PRINCIPAL_SECRET`
+- `FunctionAppClient.log_into_portal()`: Error logging into Azure Portal.
 
 ### Health Check Errors:
-- `cfaazurefunction.enable_health_check()`: Error updating health check
+- `FunctionAppClient.enable_health_check()`: Error updating health check
 
 ### App Settings Errors:
-- `cfaazurefunction.update_app_settings()`: Error updating app settings for Function App
+- `FunctionAppClient.update_app_settings()`: Error updating app settings for Function App
 
 ### Publishing Errors:
-- `cfaazurefunction.publish_function()`: Error publishing Function App
+- `FunctionAppClient.publish_function()`: Error publishing Function App
 
 ### Restart Errors:
-- `cfaazurefunction.restart_function()`: Error restarting Function App
+- `FunctionAppClient.restart_function()`: Error restarting Function App
 
 ### Deployment Errors:
 
-- `cfaazurefunction.deploy_function()`: Deployment aborted due to missing service principal credentials.
-- `cfaazurefunction.deploy_function()`: Deployment aborted due to login failure.
-- `cfaazurefunction.deploy_function()`: Deployment aborted because no function apps are available.
-- `cfaazurefunction.deploy_function()`: Deployment did not complete because Function App publish operation failed.
-- `cfaazurefunction.deploy_function()`: Deployment was completed however Function App restart operation failed.
+- `FunctionAppClient.deploy_function()`: Deployment aborted due to missing service principal credentials.
+- `FunctionAppClient.deploy_function()`: Deployment aborted due to login failure.
+- `FunctionAppClient.deploy_function()`: Deployment aborted because no function apps are available.
+- `FunctionAppClient.deploy_function()`: Deployment did not complete because Function App publish operation failed.
+- `FunctionAppClient.deploy_function()`: Deployment was completed however Function App restart operation failed.
 
 ### Permissions Issues
 Ensure the Service Principal has the necessary permissions to read from and write to the Azure Blob Storage.

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cfa.cloudops"
-version = "0.3.17"
+version = "0.3.18"
 description = "Cloud storage, batch, functions, MLOps assistance"
 authors = [
     {name = "Ryan Raasch", email = "xng3@cdc.gov"}