hashicorp / hashicorp/consul

Clarify documentation for `-syslog` option

Open
#20,810 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
30.1k
Forks
4.6k
Avg merge
1d 18h
Merged PRs (30d)
39

Description

https://developer.hashicorp.com/consul/docs/agent/config/cli-flags#_log_file
> [-syslog](https://developer.hashicorp.com/consul/docs/agent/config/cli-flags#_syslog) - This flag enables logging to syslog. This is only supported on Linux and macOS. It will result in an error if provided on Windows.

From the documentation it is not clear: will this option disable logging to file, or it will log both: to file and to syslog.

Thanks.

Contributor guide

Open the contributing guide

Research direction

Start with the linked Consul CLI flags documentation, especially the -syslog and -log-file sections. Determine whether -syslog replaces file logging or enables both, then update the page so this behavior and the platform limitation are explicit.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.