Feature Request: Add Enhanced Deployment Error Reporting and Logging #440
Conversation
Tatsinnit
left a comment
Tatsinnit
left a comment
There was a problem hiding this comment.
Thank you so much for this, all changes look fairly comprehensive, so it will be super great to get regular eyes for review like @bosesuneha or @davidgamero , I noticed something which you could simplify but its for inspiration only: https://github.com/Azure/k8s-deploy/pull/440/files#r2213055224
Thank you once again for this PR. ❤️
There was a problem hiding this comment.
Pull Request Overview
This PR enhances deployment diagnostics by adding comprehensive error reporting, detailed logging, and container-level troubleshooting capabilities to the manifest stability checking functionality. The improvements focus on providing actionable feedback when Kubernetes deployments fail.
- Aggregated rollout error collection with detailed error messages including resource type, name, and namespace
- Enhanced container diagnostics with a new
getContainerErrorsfunction to extract specific container failure reasons - Verbose failure logging that captures and displays
kubectl describeoutputs for failed resources
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/utilities/manifestStabilityUtils.ts | Adds error aggregation, detailed logging, container diagnostics, and improved error handling for deployment failures |
| src/utilities/manifestStabilityUtils.test.ts | Comprehensive test suite covering error scenarios, resource-specific behaviors, and the new container error extraction functionality |
6 participants
This PR enhances deployment diagnostics by providing more specific and actionable error reporting during rollout failures. Key improvements include:
Improved Manifest Stability: Adds detailed error reporting and logging to help identify deployment issues more precisely.
Aggregated Rollout Errors: Collects and throws a comprehensive error message summarizing all rollout failures.
Container Diagnostics: Introduces getContainerErrors to extract container status for better pod-level troubleshooting.
Verbose Failure Logging: Captures detailed kubectl describe outputs for rollout status, pod, and service checks to aid debugging.
Additionally, this PR includes unit tests to verify:
Proper aggregation of detailed error messages.
Accurate logging of describe outputs during failure scenarios.
This PR will close issue #288