Document syslog format
Open
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 57
- Forks
- 165
- Avg merge
- 1m
- Merged PRs (30d)
- 2
Description
From a discord discussion, someone was having trouble getting syslog working. Ended up being the expected format on the collectors end.
Apparently the Concourse syslog drainer exports logs in RFC3164. We should document this.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the Concourse syslog drainer documentation and the section covering collector configuration. Document that the drainer exports logs in RFC3164 format, with the work complete when users can find the expected format needed to configure their collectors.
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
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100