syslog-ng / syslog-ng/syslog-ng.github.io

Document how to write logs in RFC5424 format

Open Beginner friendly
#306 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
JavaScript
Stars
6
Forks
15
Avg merge
4h 32m
Merged PRs (30d)
5

Description

What section you wish to enhance

Maybe "The Configuration File", maybe "Destinations > File", maybe "Template and Rewrite"?

Description of the problem

The first thing I wanted to do after installing syslog-ng was update the log format to be RFC5424 instead of legacy format. I wasn't able to find out how to do this by searching the documentation site.

Proposed solution

Provide a simple example of how to use standard RFC5424 for local logs, including structured data support.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the documentation site's sections "The Configuration File," "Destinations > File," and "Template and Rewrite" to find the most suitable location. Add a simple local-log example using standard RFC5424 format with structured data support, then verify that the example explains how to produce the requested format.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.