fix(webapi): ensure correct health checks are used in probes #1249
Conversation
📝 WalkthroughWalkthroughThe changes in this pull request involve updates to the health probe paths in Bicep templates for Azure container apps. Specifically, the paths for liveness, readiness, and startup probes have been modified to include a new prefix Changes
Possibly related PRs
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
.azure/applications/web-api-eu/main.bicep (1)
Line range hint
94-114: Summary: Health check paths consistently updated.The changes to the Liveness, Readiness, and Startup probe paths are consistent and align with the PR objectives. The addition of the '/health' prefix to all paths improves the structure and consistency of health checks.
These changes should not affect other parts of the deployment, but ensure that the corresponding endpoints in the application code are updated to match these new paths.
Consider documenting these new health check paths in your project's documentation to ensure that developers and operations teams are aware of the changes.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (2)
- .azure/applications/web-api-eu/main.bicep (3 hunks)
- .azure/applications/web-api-so/main.bicep (3 hunks)
🧰 Additional context used
🔇 Additional comments (6)
.azure/applications/web-api-eu/main.bicep (3)
103-105: LGTM: Readiness probe path updated consistently.The change from '/readiness' to '/health/readiness' is consistent with the update made to the Liveness probe and aligns with the PR objectives.
94-96: LGTM: Liveness probe path updated correctly.The change from '/liveness' to '/health/liveness' aligns with the PR objectives and improves consistency in health check paths.
To ensure this change is reflected in the application code, please run the following command:
112-114: LGTM: Startup probe path updated consistently.The change from '/startup' to '/health/startup' completes the consistent update of all three probe paths, ensuring a uniform structure for health checks.
To ensure all health check paths are consistently updated in the application code, please run the following command:
✅ Verification successful
To rectify the verification process, please run the following command:
Please run the following commands to verify the health check paths:
Please run the following commands to further verify the health check paths:
Verified: All health check paths are correctly updated. No residual '/startup' paths were found outside '/health/'.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify that all updated health check paths are used in the application code rg --type csharp -g "app.MapHealthChecks\(\"/health/(liveness|readiness|startup)\""Length of output: 480
Script:
# #!/bin/bash # Verify that all updated health check paths are used in the application code rg 'app\.MapHealthChecks\("/health/(liveness|readiness|startup)"\)' --type csharp .Length of output: 85
Script:
# #!/bin/bash # Verify that the updated health check path '/health/startup' is used in the application code rg 'app\.MapHealthChecks\("/health/startup"\)' --type csharp .Length of output: 64
Script:
# #!/bin/bash # Check for any remaining instances of '/startup' in the application code rg '/startup' --type csharp .Length of output: 192
Script:
# #!/bin/bash # Verify that all health check endpoints use the updated '/health/startup' path rg 'app\.MapHealth\w+\("/health/startup"\)' --type csharp .Length of output: 61
Script:
# #!/bin/bash # Check for any remaining instances of '/startup' not under '/health/' rg 'app\.MapHealth\w+\("/(?!(health))startup"\)' --type csharp .Length of output: 334
.azure/applications/web-api-so/main.bicep (3)
98-98: LGTM: Liveness probe path updated correctly.The liveness probe path has been updated to include the '/health' prefix, which aligns with the PR objectives of ensuring consistent health check endpoints.
107-107: LGTM: Readiness probe path updated correctly.The readiness probe path has been updated to include the '/health' prefix, maintaining consistency with the liveness probe and aligning with the PR objectives.
116-116: LGTM: Startup probe path updated correctly. All probe paths are now consistent.The startup probe path has been updated to include the '/health' prefix, completing the set of changes for all three probe types. This change:
- Ensures consistency across all health check endpoints.
- Aligns with the PR objectives of updating health check paths.
- Improves maintainability by following a uniform pattern.
To ensure these changes are reflected in the actual application code, please run the following script:
This script will help verify that the application code has been updated to match these new health check paths.
✅ Verification successful
Action Required: Correction Needed in Health Check Endpoint Verification Script
The previous verification script encountered an error due to a missing pattern argument in the
rgcommand. Please run the corrected script below to ensure that the health check endpoints in the application code match the updated paths in the Bicep template.
: Startup probe path updated and correctly mapped in the application code.
The startup probe path has been successfully updated to
/health/startupin the Bicep template and is correctly mapped within the application code. This ensures that:
- The startup probe aligns with the application's health check endpoints.
- All related health check configurations are consistent and functional.
- No deprecated paths remain, enhancing maintainability and reliability.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify that the health check endpoints in the application code match the updated paths in the Bicep template. # Test: Search for health check endpoint definitions in the application code rg --type csharp -g 'app\.Map(Health|Liveness|Readiness|Startup)' -A 5Length of output: 469
Script:
#!/bin/bash # Description: Verify that the health check endpoints in the application code match the updated paths in the Bicep template. # Test: Search for health check endpoint definitions in the application code rg 'app\.Map(Health|Liveness|Readiness|Startup)' --type csharp -A 5Length of output: 1843
🤖 I have created a release *beep* *boop* --- ## [1.23.0](v1.22.0...v1.23.0) (2024-10-10) ### Features * **infra:** upgrade postgresql SKU in test ([#1257](#1257)) ([5a751af](5a751af)) * **webAPI:** Add legacy HTML support for MainContentReference ([#1256](#1256)) ([482b38a](482b38a)) ### Bug Fixes * Add missing return types for Transmissions and Activities in OpenAPI spec ([#1244](#1244)) ([972870d](972870d)) * **graphQL:** Missing MediaType on dialog attachment url ([#1264](#1264)) ([3919343](3919343)) * Refactor probes and add more health checks ([#1159](#1159)) ([6889a96](6889a96)) * **webapi:** ensure correct health checks are used in probes ([#1249](#1249)) ([f951152](f951152)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
Description
Changed the paths of health checks, so have to ensure we use the same endpoints in the probes
Related Issue(s)
Verification
Documentation
docs-directory, Altinnpedia or a separate linked PR in altinn-studio-docs., if applicable)Summary by CodeRabbit
/healthprefix, enhancing health check organization.