Skip to content
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

auth, rec: update option text and docs to clarify logging is to stderr, not stdout #12989

Merged
merged 1 commit into from Mar 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/settings.rst
Expand Up @@ -601,7 +601,7 @@ regression testing.
- Boolean
- Default: no

Do not log to syslog, only to stdout. Use this setting when running
Do not log to syslog, only to stderr. Use this setting when running
inside a supervisor that handles logging (like systemd).

.. warning::
Expand Down Expand Up @@ -961,7 +961,7 @@ to at least 5 to see the logs.
- Bool
- Default: yes

When printing log lines to stdout, prefix them with timestamps.
When printing log lines to stderr, prefix them with timestamps.
Disable this if the process supervisor timestamps these lines already.

.. note::
Expand Down
2 changes: 1 addition & 1 deletion pdns/auth-main.cc
Expand Up @@ -195,7 +195,7 @@ static void declareArguments()
::arg().set("control-console", "Debugging switch - don't use") = "no"; // but I know you will!
::arg().set("loglevel", "Amount of logging. Higher is more. Do not set below 3") = "4";
::arg().setSwitch("loglevel-show", "Include log level indicator in log output") = "no";
::arg().set("disable-syslog", "Disable logging to syslog, useful when running inside a supervisor that logs stdout") = "no";
::arg().set("disable-syslog", "Disable logging to syslog, useful when running inside a supervisor that logs stderr") = "no";
::arg().set("log-timestamp", "Print timestamps in log lines") = "yes";
::arg().set("distributor-threads", "Default number of Distributor (backend) threads to start") = "3";
::arg().set("signing-threads", "Default number of signer threads to start") = "3";
Expand Down
2 changes: 1 addition & 1 deletion pdns/recursordist/docs/running.rst
Expand Up @@ -9,7 +9,7 @@ Logging
In a production environment, you will want to be able to monitor PowerDNS performance.
Furthermore, PowerDNS can perform a configurable amount of operational logging.

On modern Linux distributions, the PowerDNS recursor logs to stdout, which is consumed by ``systemd-journald``.
On modern Linux distributions, the PowerDNS recursor logs to stderr, which is consumed by ``systemd-journald``.
This means that looking into the logs that are produced, `journalctl <https://www.freedesktop.org/software/systemd/man/journalctl.html>`_ can be used::

# journalctl -u pdns-recursor -n 100
Expand Down
6 changes: 3 additions & 3 deletions pdns/recursordist/settings/table.py
Expand Up @@ -535,9 +535,9 @@
'section' : 'logging',
'type' : LType.Bool,
'default' : 'false',
'help' : 'Disable logging to syslog, useful when running inside a supervisor that logs stdout',
'help' : 'Disable logging to syslog, useful when running inside a supervisor that logs stderr',
'doc' : '''
Do not log to syslog, only to stdout.
Do not log to syslog, only to stderr.
Use this setting when running inside a supervisor that handles logging (like systemd).
**Note**: do not use this setting in combination with :ref:`setting-daemon` as all logging will disappear.
''',
Expand Down Expand Up @@ -1261,7 +1261,7 @@
'oldname' : 'log-timestamp',
'type' : LType.Bool,
'default' : 'true',
'help' : 'Print timestamps in log lines, useful to disable when running with a tool that timestamps stdout already',
'help' : 'Print timestamps in log lines, useful to disable when running with a tool that timestamps stderr already',
'doc' : '''

''',
Expand Down