chore: Added logs to allow capturing request id and processing for he…

[nidhi-nair]

…alth related endpoints

Description

Tip

Add a TL;DR when the description is longer than 500 words or extremely technical (helps the content, marketing, and DevRel team).

Please also include relevant motivation and context. List any dependencies that are required for this change. Add links to Notion, Figma or any other documents that might be relevant to the PR.

Fixes #Issue Number
or
Fixes Issue URL

Warning

If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.

Automation

/ok-to-test tags=""

🔍 Cypress test results

Caution

If you modify the content in this section, you are likely to disrupt the CI result for your PR.

Communication

Should the DevRel and Marketing teams inform users about this change?

• Yes
• No

Summary by CodeRabbit

• New Features
  • Enhanced logging functionality added to the server health check and tenant configuration processes for better monitoring and traceability.
• Bug Fixes
  • Improved observability of server health checks without altering existing functionality.

[coderabbitai]

Walkthrough

The recent changes involve the addition of logging functionality to the HealthCheckControllerCE and TenantControllerCE classes. The Lombok @Slf4j annotation has been introduced in both classes, allowing for the creation of logger instances. Debug log statements have been added to the getHealth and getTenantConfig methods to log specific messages related to health checks and tenant configuration retrieval, respectively. These modifications enhance the observability of the server's operations without altering the existing logic.

Changes

Files	Change Summary
app/server/appsmith-server/src/main/java/com/appsmith/server/controllers/ce/HealthCheckControllerCE.java app/server/appsmith-server/src/main/java/com/appsmith/server/controllers/ce/TenantControllerCE.java	Added @Slf4j annotation to enable logging and included debug statements in getHealth and getTenantConfig methods.

Poem

In the code where health checks dwell,
Logs now whisper, all is well.
Tenants' configs, clear as day,
With each log, we pave the way.
Debugging paths, so bright and clear,
Monitoring made simple, never fear! 🌟

Tip

New features

Walkthrough comment now includes:

• Possibly related PRs: A list of potentially related PRs to help you recall past context.
• Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs. You can also provide custom labeling instructions in the UI or configuration file.

Notes:

• Please share any feedback in the discussion post on our Discord.
• Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

---

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?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 58b07dd and c3fb1e9.

Files selected for processing (2)

• app/server/appsmith-server/src/main/java/com/appsmith/server/controllers/ce/HealthCheckControllerCE.java (2 hunks)
• app/server/appsmith-server/src/main/java/com/appsmith/server/controllers/ce/TenantControllerCE.java (3 hunks)

Additional comments not posted (6)

app/server/appsmith-server/src/main/java/com/appsmith/server/controllers/ce/HealthCheckControllerCE.java (3)

9-9: Good addition of the Slf4j annotation.

The inclusion of the @Slf4j annotation is a wise choice, as it enables logging within the class without cluttering the code with boilerplate logger setup. This is a neat way to keep our code clean and maintainable.

---

15-15: Proper use of Slf4j at class level.

Placing the @Slf4j annotation at the class level ensures that all methods within the class can utilize the log object for logging as needed. This is a strategic placement that enhances the logging capabilities of the class effectively.

---

24-24: Appropriate logging before performing operations.

The debug log statement "Checking server health ..." is well-placed before the invocation of the health check service. This allows for better traceability and debugging of the health check process, which is crucial for maintaining the reliability of our server.

app/server/appsmith-server/src/main/java/com/appsmith/server/controllers/ce/TenantControllerCE.java (3)

10-10: Good addition of the Slf4j annotation.

The inclusion of the @Slf4j annotation is a wise choice, as it enables logging within the class without cluttering the code with boilerplate logger setup. This is a neat way to keep our code clean and maintainable.

---

20-20: Proper use of Slf4j at class level.

Placing the @Slf4j annotation at the class level ensures that all methods within the class can utilize the log object for logging as needed. This is a strategic placement that enhances the logging capabilities of the class effectively.

---

42-42: Appropriate logging before performing operations.

The debug log statement "Attempting to retrieve tenant configuration ..." is well-placed before the invocation of the tenant configuration retrieval process. This allows for better traceability and debugging of the tenant configuration process, which is crucial for maintaining the reliability of our tenant management.

[github-actions]

Failed server tests

• com.appsmith.server.fork.ApplicationForkingServiceTests#cloneApplicationForkWithConfigurationTrueWithActionsThrice