fix: wait for healthy services

[de-sh]

Fixes #XXXX.

Description

Currently docker compose doesn't consider if service is healthy

---

This PR has:

• been tested to ensure log ingestion and log query works.
• added comments explaining the "why" and the intent of the code wherever would not be obvious for an unfamiliar reader.
• added documentation for new or modified features or behaviors.

Summary by CodeRabbit

• New Features

  • Enhanced service orchestration with health check conditions ensuring that services start only when their dependencies are stable.

• Chores

  • Updated container configurations to include additional utilities and debugging support, improving deployment consistency and overall system stability.

[nitisht]

Let's also switch back to github runners?

[coderabbitai]

Walkthrough

The pull request updates Docker and Docker Compose configurations. In Dockerfile.debug, a command is added to update the package list and install curl in the final stage. Several Docker Compose files have their service dependency definitions modified to enforce health check conditions via the depends_on directive. Additionally, selected services now use Dockerfile.debug instead of the default Dockerfile, and a logging environment variable (RUST_LOG=warn) has been introduced. These changes adjust service startup sequences based on dependency health.

Changes

File(s)	Change Summary
Dockerfile.debug	Added a command before setting the working directory to update the package list and install curl.
docker-compose-distributed-test-with-kafka.yaml, docker-compose-test-with-kafka.yaml	Updated service dependencies in depends_on to include health check conditions; changed specific service dockerfile references to Dockerfile.debug; added RUST_LOG=warn for logging in Kafka-related services.
docker-compose-distributed-test.yaml, docker-compose-test.yaml	Modified service configurations by enforcing condition: service_healthy in depends_on directives; updated dockerfile references to Dockerfile.debug; added RUST_LOG=warn environment variables.

Sequence Diagram(s)

sequenceDiagram
    participant Minio
    participant Parseable
    participant Ingest
    participant Quest

    Note over Minio,Parseable: Health Check Stage
    Minio->>Parseable: Health OK
    Parseable->>Ingest: Health OK
    Ingest->>Quest: Health OK
    Quest->>System: Startup Complete

Loading

sequenceDiagram
    participant Minio
    participant Kafka0 as Kafka-0
    participant Parseable
    participant KafkaLG as Kafka-Log-Generator
    participant Quest

    Note over Minio,Kafka0: Dependency Health Checks
    Minio->>Parseable: Health OK
    Kafka0->>Parseable: Health OK
    Parseable->>Quest: Health OK
    Kafka0->>KafkaLG: Health OK
    KafkaLG->>System: Startup Complete

Loading

Poem

Hoppin' through code with a skip and a cheer,
Curl now arrives to lend a helping ear.
Health checks guard each service with care,
Debugged Dockerfiles make our startup fair.
I nibble on carrots and code with delight,
A rabbit sings praises for changes so bright! 🐰✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 23993f4 and 3cf10a2.

📒 Files selected for processing (5)

• Dockerfile.debug (1 hunks)
• docker-compose-distributed-test-with-kafka.yaml (4 hunks)
• docker-compose-distributed-test.yaml (7 hunks)
• docker-compose-test-with-kafka.yaml (3 hunks)
• docker-compose-test.yaml (3 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (9)

• GitHub Check: Build Default x86_64-pc-windows-msvc
• GitHub Check: Build Default aarch64-apple-darwin
• GitHub Check: Build Default aarch64-unknown-linux-gnu
• GitHub Check: Build Kafka aarch64-apple-darwin
• GitHub Check: Build Default x86_64-unknown-linux-gnu
• GitHub Check: Quest Smoke and Load Tests for Standalone deployments
• GitHub Check: coverage
• GitHub Check: Quest Smoke and Load Tests for Distributed deployments
• GitHub Check: Build Kafka x86_64-unknown-linux-gnu

🔇 Additional comments (10)

Dockerfile.debug (1)

37-37: LGTM! The addition of curl is necessary for health checks.

The installation of curl is correctly placed and efficiently combines apt update and apt install to minimize layers.

docker-compose-test.yaml (2)

30-30: LGTM! The service configuration is properly updated.

The changes to use Dockerfile.debug and add RUST_LOG=warn are consistent with other services.

Also applies to: 46-46

---

48-49: LGTM! Health check conditions are properly configured.

The service dependencies now correctly wait for healthy status, which aligns with the PR objective.

Also applies to: 81-82

docker-compose-distributed-test.yaml (2)

31-31: LGTM! Service configurations are properly updated.

The changes to use Dockerfile.debug and add RUST_LOG=warn are consistent across services.

Also applies to: 48-48, 68-68, 86-86

---

57-58: LGTM! Health check conditions are properly configured.

The service dependencies now correctly wait for healthy status, which aligns with the PR objective.

Also applies to: 95-98, 129-134

docker-compose-test-with-kafka.yaml (2)

152-152: LGTM! Service configuration is properly updated.

The kafka-log-generator service now uses Dockerfile.debug for consistency with other services.

---

52-55: LGTM! Health check conditions are properly configured.

The service dependencies now correctly wait for healthy status, which aligns with the PR objective.

Also applies to: 87-88, 159-160

docker-compose-distributed-test-with-kafka.yaml (3)

60-60: LGTM! Service configuration is properly updated.

The changes to use Dockerfile.debug and add RUST_LOG=warn are consistent with other services.

Also applies to: 77-77

---

14-17: LGTM! Health check conditions are properly configured.

The service dependencies now correctly wait for healthy status, which aligns with the PR objective.

Also applies to: 216-221

---

1-1: Overall changes look great!

The changes successfully address the PR objective by:

1. Adding curl for health checks
2. Consistently implementing health check conditions across all services
3. Standardizing debug configurations and logging

The implementation is thorough and consistent across all files.

---

🪧 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>, 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 generate docstrings to generate docstrings for this PR. (Beta)
• @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 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 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.