Enhance Logging for Docker Build Processes in ZenML

[strickvl]

Open Source Contributors Welcomed!

Please comment below if you would like to work on this issue!

Contact Details [Optional]

support@zenml.io

What happened?

In the current ZenML framework, the process of building Docker images (or having them built by a cloud image builder) often lacks clear and informative log messages. Users may find it challenging to understand when and why certain Docker builds are used or not used in their workflows.

Task Description

Improve the logging mechanism in ZenML to provide clear and explicit messages about Docker build processes. This includes logging when Docker builds are initiated, used, or skipped, and the reasons behind these actions. Enhanced logging will aid users in better understanding and debugging their pipeline executions.

Expected Outcome

• Users should receive clear log messages that inform them about the Docker build process, including when builds are triggered, used, or not used, along with the reasons.
• Enhanced logging will improve transparency and aid in troubleshooting and optimizing pipeline executions.
• The documentation should be updated, if necessary, to reflect the improved logging features and provide guidance on interpreting these logs. (Logs shown in documentation might also need updating, depending on whether the output would have been updated by this change.)

Steps to Implement

• Review the current Docker build process and identify key points where logging can be improved.
• Implement detailed and user-friendly log messages that accurately describe the Docker build process and its context within the pipeline execution.
• Ensure that the reasons for using or skipping Docker builds are clearly communicated in the logs.
• Test the updated logging in various scenarios to ensure the messages are clear, accurate, and helpful.
• Update any relevant documentation to guide users on the new log messages related to Docker builds.

Additional Context

Providing detailed and clear logs around Docker builds is crucial for a seamless and transparent user experience, especially for those managing complex pipelines in ZenML.

Code of Conduct

• I agree to follow this project's Code of Conduct