Skip to content

Implement Logging Using RFC 5424 Syslog Format #387

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

Open
da2ce7 opened this issue Aug 27, 2023 · 1 comment
Open

Implement Logging Using RFC 5424 Syslog Format #387

da2ce7 opened this issue Aug 27, 2023 · 1 comment
Labels
- Admin - Enjoyable to Install and Setup our Software Enhancement / Feature Request Something New Help Wanted More Contributions are Appreciated and extra attention is needed. Needs Research We Need to Know More About This
Milestone

Comments

@da2ce7
Copy link
Contributor

da2ce7 commented Aug 27, 2023

Implement Logging

Enhance the program's logging functionality by adopting the RFC 5424 syslog format. This format ensures structured, consistent log entries that align with industry best practices. Follow these steps to implement the update:

Integrate RFC 5424 Format:

Revise the logging mechanism to adhere to the RFC 5424, ensuring each log entry includes priority level, timestamp, hostname, program name, and structured data when applicable.

Manage Severity Levels:

Implement the recommended severity levels (e.g., emergency, alert, warning, notice, info, debug) to accurately reflect the importance of log messages.

Configure Log Rotation:

Develop a log rotation strategy to control log file size and retention, preventing excessive disk space consumption.

Define Log Directory:

Designate a dedicated directory (e.g., /var/log/torrust/tracker) for log files, maintaining alignment with Linux directory structure conventions.

Enforce Permissions:

Apply appropriate permissions and ownership to log files and directories to ensure authorized access and modification.

Dynamic Log Levels:

Enable log level configuration (e.g., INFO, DEBUG, ERROR) to control verbosity based on configuration settings.

Test and Document:

Thoroughly test the updated logging mechanism, verifying adherence to RFC 5424 and proper handling of structured data. Document the changes for clarity.

Expected Outcomes:

  • Consistent and structured log entries following RFC 5424.
  • Efficient log file management with rotation and controlled disk space usage.
  • Improved program monitoring and troubleshooting through enhanced log data.
@da2ce7 da2ce7 changed the title Use a Logfile for Logging Implement Logging Using RFC 5424 Syslog Format Aug 27, 2023
@da2ce7 da2ce7 added Help Wanted More Contributions are Appreciated and extra attention is needed. Enhancement / Feature Request Something New labels Aug 27, 2023
@da2ce7 da2ce7 moved this to Next in Developer Experience Sep 21, 2023
@da2ce7 da2ce7 added - Admin - Enjoyable to Install and Setup our Software Needs Research We Need to Know More About This labels Oct 10, 2023
@cgbosse cgbosse moved this to Feature request in Torrust Solution Jan 8, 2024
@cgbosse cgbosse added this to the v3.1.0 milestone Jan 16, 2024
@josecelano josecelano mentioned this issue Feb 8, 2024
6 tasks
@josecelano
Copy link
Member

Relates to: torrust/torrust-demo#4

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
- Admin - Enjoyable to Install and Setup our Software Enhancement / Feature Request Something New Help Wanted More Contributions are Appreciated and extra attention is needed. Needs Research We Need to Know More About This
Projects
Status: Feature & Enhancement request
Archived in project
Development

No branches or pull requests

3 participants