Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: container start error if missing logs directory #313

Merged
merged 1 commit into from
Aug 23, 2024

Conversation

ghost
Copy link

@ghost ghost commented Aug 23, 2024

API PR Checklist

Pre-requisites

  • I have gone through the Contributing guidelines for Submitting a Pull Request (PR) and ensured that this is not a duplicate PR.
  • I have performed unit testing for the new feature added or updated to ensure the new features added are working as expected.
  • I have added/updated test cases to the test suite as applicable.
  • I have performed preliminary testing using the test suite to ensure that any existing features are not impacted and any new features are working as expected as a whole.
  • I have added/updated the required api docs as applicable.
  • I have added/updated the .env.example file with the required values as applicable.

PR Details

PR details have been updated as per the given format (see below)

  • PR title adheres to the format specified in guidelines (e.g., feat: add admin login endpoint)
  • Description has been added
  • Related changes have been added (optional)
  • Screenshots have been added (optional)
  • Query request and response examples have been added (as applicable, in case added or updated)
  • Documentation changes have been listed (as applicable)
  • Test suite/unit testing output is added (as applicable)
  • Pending actions have been added (optional)
  • Any other additional notes have been added (optional)

Additional Information

  • Appropriate label(s) have been added (ready for review should be added if the PR is ready to be reviewed)
  • Assignee(s) and reviewer(s) have been added (optional)

Note: Reviewer should ensure that the checklist and description have been populated and followed correctly, and the PR should be merged only after resolving all conversations and verifying that CI checks pass.


Description:

This PR fixes an error when trying to start the OsmoX API container if the host machine is missing the logs directory. The new code will automatically create the logs directory if it is not present.

Related changes:

  • Directly bind the logs directory instead of using name volume in docker-compose file

Screenshots:

N/A

Query request and response:

N/A

Documentation changes:

N/A

Test suite/unit testing output:

N/A

Pending actions:

N/A

Additional notes:

N/A

Summary by CodeRabbit

  • New Features

    • Enhanced log management by redirecting logs from a managed Docker volume to a local directory, improving accessibility for developers.
  • Chores

    • Removed the named volume configuration for logs to streamline the application's log handling process.

Directly bind the logs directory instead of using name volume
@ghost ghost added bug Something isn't working ready for review labels Aug 23, 2024
@ghost ghost self-assigned this Aug 23, 2024
Copy link

coderabbitai bot commented Aug 23, 2024

Walkthrough

The changes involve updating the Docker Compose configuration for the osmox-api service. The log storage method has been modified from a named volume to a direct path mapping to a local directory (./logs). This adjustment removes the osmox-api-logs volume and alters how logs are accessed and persisted.

Changes

Files Change Summary
apps/api/docker-compose.yml Removed named volume osmox-api-logs and changed log mapping from osmox-api-logs:/app/logs to ./logs:/app/logs.

Poem

In the garden where code bunnies hop,
We’ve changed logs from a cloud to a crop.
With logs in a folder, neat and bright,
Developers dance with pure delight!
No more searching in Docker’s deep gloom,
Now logs bloom freely, bringing joy to the room! 🌼🐇


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
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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6606e17 and 1ca3f81.

Files selected for processing (1)
  • apps/api/docker-compose.yml (2 hunks)
Additional comments not posted (1)
apps/api/docker-compose.yml (1)

17-17: Ensure the existence of the ./logs directory.

The volume mapping for the osmox-api service has been changed from a named volume to a direct path. Ensure that the ./logs directory exists on the host machine before starting the container to prevent errors.

Consider adding a script or instruction to create the directory if it doesn't exist.

@xixas xixas merged commit 9ccea2e into main Aug 23, 2024
6 checks passed
@xixas xixas deleted the fix/missing-logs-folder branch August 23, 2024 05:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working ready for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant