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

Feat/view logs dashboard #1369

Closed

Conversation

MontejoJorge
Copy link
Collaborator

@MontejoJorge MontejoJorge commented Apr 16, 2024

Resolves #1006

Summary by CodeRabbit

  • New Features
    • Introduced real-time logs viewing capabilities for applications.
    • Added the ability to interact with logs, such as following updates and adjusting display settings.
  • Enhancements
    • Updated the app details page to display different tabs based on the application's status.
  • Style
    • Implemented new styles for the log terminal component to enhance user interface aesthetics.
  • Bug Fixes
    • Improved error handling in socket connections to prevent issues when data is null or undefined.

Copy link
Contributor

coderabbitai bot commented Apr 16, 2024

Walkthrough

The recent updates focus on enhancing the dashboard's functionality by enabling users to view real-time logs of running applications within the dashboard. This feature is achieved through WebSocket communication for streaming logs directly to the client, along with integration of Docker commands for log retrieval and display.

Changes

File Path Change Summary
packages/worker/src/lib/docker/docker-helpers.ts Introduces new imports for handling Docker commands and socket events, adding functions for logging functionality.
src/app/(dashboard)/app-store/[id]/components/AppDetailsTabs/LogsTerminal.tsx Introduces LogsTerminal component for displaying real-time logs with features like log following, line limit setting, and line wrapping.
src/lib/socket/useSocketEmit.ts Introduces useSocketEmit custom hook for managing socket communication in React components, including connection establishment and event emission.

Assessment against linked issues

Objective Addressed Explanation
View logs in dashboard (#1006)

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

CodeRabbit Configration 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.

@steveiliop56
Copy link
Collaborator

Very good job! But the logs unfortunately didn't show anything on my testing (with nginx) and also the max lines thing is locked. I can't change the number on that.

@MontejoJorge
Copy link
Collaborator Author

Very good job! But the logs unfortunately didn't show anything on my testing (with nginx) and also the max lines thing is locked. I can't change the number on that.

The max line option is not done yet

@MontejoJorge MontejoJorge marked this pull request as ready for review April 20, 2024 10:24
@MontejoJorge
Copy link
Collaborator Author

Merged in #1445

@MontejoJorge MontejoJorge deleted the feat/view-logs-dashboard branch May 30, 2024 06:00
@MontejoJorge MontejoJorge restored the feat/view-logs-dashboard branch June 3, 2024 08:19
@MontejoJorge MontejoJorge reopened this Jun 3, 2024
@MontejoJorge MontejoJorge marked this pull request as draft June 3, 2024 08:20
@MontejoJorge MontejoJorge removed the request for review from meienberger June 3, 2024 08:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

View logs in dashboard
2 participants