Document the RFC 3164 syslog format compliance
Open
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Since: 3.6.1
Documents:
- https://www.tarantool.io/en/doc/latest/reference/configuration/configuration_reference/#audit-log-syslog
- https://www.tarantool.io/en/doc/latest/admin/logs/#log-destination
- https://www.tarantool.io/en/doc/latest/reference/reference_lua/log/
- https://www.tarantool.io/en/doc/latest/reference/configuration/#confval-log
The syslog format is compliant with
RFC 3164. However, the
length of the message can be up to 16 * 1024 bytes.
Requested by @Serpentian in https://github.com/tarantool/tarantool/commit/04a41f144ac63f223eed27e6ee22bfaae5ee9792.
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
Review the four linked documentation pages and RFC 3164 first, then identify where the syslog format behavior is described. Document that the format is RFC 3164-compliant and that messages may be up to 16 * 1024 bytes; done means the relevant documentation clearly states both facts.
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
- 45/100