search

lantanagroup / link-cloud

1 stars 1 forks source link

LNK-2883: Added Kafka health check to .NET services #494

Open dvargaslantana opened 2 days ago

dvargaslantana commented 2 days ago

Also added a missing health check endpoint to the Submission service.

Summary by CodeRabbit

Release Notes

These enhancements improve the application's reliability and monitoring of Kafka services, ensuring better operational oversight.

coderabbitai[bot] commented 2 days ago

Walkthrough

The pull request introduces modifications across multiple Program.cs files in various DotNet projects to enhance health check functionalities for Kafka services. A new using directive for LantanaGroup.Link.Shared.Application.Health is added, and a KafkaHealthCheckConfiguration variable is instantiated in the RegisterServices method. This variable is used to register Kafka health checks alongside existing database health checks. Additionally, a new class KafkaHealthCheckConfiguration is introduced to facilitate these health checks, and the docker-compose.yml file is updated to include a dedicated Kafka topic for health monitoring.

Changes

File Path Change Summary
DotNet/Account/Program.cs Added using directive; instantiated kafkaHealthOptions for Kafka health check registration.
DotNet/Audit/Program.cs Added using directive; updated RegisterServices and SetupMiddleware methods for Kafka checks.
DotNet/Census/Program.cs Added using directive; updated health checks to include Kafka.
DotNet/DataAcquisition/Program.cs Added using directive; modified health checks to include Kafka health check.
DotNet/Normalization/Program.cs Added using directive; updated health checks to include Kafka.
DotNet/Notification/Program.cs Added using directive; updated health check registration to include Kafka.
DotNet/QueryDispatch/Program.cs Added using directives; updated health checks and logging setup for Kafka.
DotNet/Report/Program.cs Added using directive; updated health checks to include Kafka.
DotNet/Shared/Application/Health/KafkaHealthConfiguration.cs Added KafkaHealthCheckConfiguration class with methods for health check options.
DotNet/Shared/Shared.csproj Added package reference for AspNetCore.HealthChecks.Kafka.
DotNet/Submission/Program.cs Added using directive; configured health checks and middleware for Kafka.
DotNet/Tenant/Program.cs Added using directive; updated health checks to include Kafka.
docker-compose.yml Added Kafka topic Service-Healthcheck and updated health check command for kafka_b service.

Possibly related PRs

Suggested reviewers

📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Files that changed from the base of the PR and between 9ad5acb711b96bbd190ab2353e32039781209f8b and ea7d3f4c07ad9700bb06c72ca0df739990654a75.
📒 Files selected for processing (1) * DotNet/Shared/Application/Health/KafkaHealthConfiguration.cs (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1) * DotNet/Shared/Application/Health/KafkaHealthConfiguration.cs
--- 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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@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. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.