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

Implement ubiquity-os logger instead of console logs #247

Open
shiv810 opened this issue Jan 6, 2025 · 6 comments
Open

Implement ubiquity-os logger instead of console logs #247

shiv810 opened this issue Jan 6, 2025 · 6 comments

Comments

@shiv810
Copy link
Collaborator

shiv810 commented Jan 6, 2025

           It's the kernel so our logger instance does not exist here, but yes ideally we should use it.

Originally posted by ZZZ in #179 (comment)

Currently the kernel uses plain console.log to log messages. We should implement https://www.github.com/ubiquity-os/ubiquity-os-logger for more detailed / prettier logs.

Copy link

test-app-ubo bot commented Jan 6, 2025

Note

The following contributors may be suitable for this task:

ariesgun

81% Match ubiquity-os-marketplace/command-wallet#4

0x4007

77% Match ubiquity/ubiquibot#665

gitcoindev

75% Match ubiquity/ubiquibot#899

@ShivTestOrg ShivTestOrg deleted a comment from test-app-ubo bot Jan 6, 2025
@ShivTestOrg ShivTestOrg deleted a comment from test-app-ubo bot Jan 6, 2025
@ShivTestOrg ShivTestOrg deleted a comment from test-app-ubo bot Jan 6, 2025
@ShivTestOrg ShivTestOrg deleted a comment from test-app-ubo bot Jan 6, 2025
@ShivTestOrg ShivTestOrg deleted a comment from test-app-ubo bot Jan 6, 2025
@ShivTestOrg ShivTestOrg deleted a comment from test-app-ubo bot Jan 6, 2025
@ShivTestOrg ShivTestOrg deleted a comment from test-app-ubo bot Jan 13, 2025
@ShivTestOrg ShivTestOrg deleted a comment from test-app-ubo bot Jan 13, 2025
@ShivTestOrg ShivTestOrg deleted a comment from test-app-ubo bot Jan 13, 2025
@ShivTestOrg ShivTestOrg deleted a comment from test-app-ubo bot Jan 14, 2025
@ShivTestOrg ShivTestOrg deleted a comment from test-app-ubo bot Jan 14, 2025
@ShivTestOrg ShivTestOrg deleted a comment from test-app-ubo bot Jan 14, 2025
@shiv810
Copy link
Collaborator Author

shiv810 commented Jan 14, 2025

/ask explain the issue and how was this discovered ?

Copy link

test-app-ubo bot commented Jan 14, 2025

! An error occurred

Copy link

test-app-ubo bot commented Jan 14, 2025

The issue revolves around the current logging mechanism within the kernel of the project. Specifically, the kernel is utilizing plain console.log statements to log messages. This approach lacks the detailed structure, consistency, and aesthetic formatting that a dedicated logging system can provide.

How Was This Discovered?

During development and code reviews, it became evident that the absence of a standardized logger was leading to inconsistent and less informative logs. Relying solely on console.log made it challenging to maintain uniformity across different parts of the application, hindering effective debugging and monitoring. Recognizing the need for more robust logging, the team identified this gap and proposed integrating the ubiquity-os/ubiquity-os-logger to enhance the logging capabilities.

Desired Outcome:

  • Consistency: Implement a unified logging system across the kernel to ensure all logs follow a consistent format and structure.
  • Enhanced Details: Utilize the logger to provide more comprehensive and detailed log messages, facilitating easier debugging and monitoring.
  • Aesthetic Formatting: Improve the readability of logs by adopting prettier and more organized log outputs.
  • Integration: Seamlessly integrate the logger with existing tools like Octokit and GitHub Actions to maintain smooth workflow operations.

Addressing this issue by adopting a dedicated logger will significantly improve the maintainability and observability of the project, ensuring that logs are both informative and easy to interpret.

@shiv810
Copy link
Collaborator Author

shiv810 commented Jan 14, 2025

/ask who pointed out that this was missing ? and in which issue was this identified ?

Copy link

test-app-ubo bot commented Jan 14, 2025

The missing logger was pointed out by @0x4007 in Pull Request #179 of the ubiquity-os-kernel repository. This issue was initially identified in Issue #247.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant