doc/03-Configuration.md: Logging Fields in Journald #743
Conversation
oxzi
force-pushed
the
doc-03-systemd-journald-appendix
branch
from
1a0d39d
to
6080e33
Compare
doc/03-Configuration.md
Outdated
| When examining the journal with `journalctl`, fields containing additional information are hidden by default. | ||
| Setting an appropriate | ||
| [`--output` option](https://www.freedesktop.org/software/systemd/man/latest/journalctl.html#Output%20Options) | ||
| will include them, such as: `journalctl --output verbose` or `journalctl --output json`. |
There was a problem hiding this comment.
I would also add --unit 'icingadb.service' to those example commands given that this is all about Icinga DB.
There was a problem hiding this comment.
I get your point. However, including the --unit argument for both examples makes this sentence very long, hiding the highlighted --output argument.
Setting an appropriate --output option will include them, such as:
journalctl --unit icingadb.service --output verboseorjournalctl --unit icingadb.service --output json.
Thus, I would prefer to drop journalctl and just show the two --output arguments.
Setting an appropriate --output option will include them, such as:
--output verboseor--output json.
There was a problem hiding this comment.
However, including the
--unitargument for both examples makes this sentence very long, hiding the highlighted--outputargument.
But I don't quite get your point. Isn't this docs snippet supposed to help someone find the Icinga DB fields? I mean, OK, you want to highlight the --output argument even more, but in the end the user just needs a copy-pasteable one without having to construct the full command on his own. Personally, this just doesn't seem like a good approach to only partially document something.
There was a problem hiding this comment.
My assumption is that users have a basic understanding of journalctl, as otherwise they simply cannot operate it. Using it without any further parameter would result in logs since last log vacuum, which might have never happened. Thus, they might want to use -f or -n 100 or --since today or something else..
I don't see any one-command-fits-it-all. My intention was just to point out that the necessary details are hidden, which is a non-default behavior, compared to most other software out there.
I have added a line showing one generic copy-pastable journalctl command.
oxzi
force-pushed
the
doc-03-systemd-journald-appendix
branch
from
6080e33
to
b94b334
Compare
oxzi
force-pushed
the
doc-03-systemd-journald-appendix
branch
from
b94b334
to
6d47b33
Compare
While working on an issue where the additional logging information provided by zap fields was missing, I realized that our documentation did not indicate how to view them. So a new documentation section has been added explaining how to view the fields when using the `systemd-journald` logging output. Also removes one trailing space.
oxzi
force-pushed
the
doc-03-systemd-journald-appendix
branch
from
6d47b33
to
813cf9f
Compare
While working on an issue where the additional logging information provided by zap fields was missing, I realized that our documentation did not indicate how to view them. So a new documentation section has been added explaining how to view the fields when using the `systemd-journald` logging output. Also removes one trailing space. This change is an almost identical replica of <Icinga/icingadb#743>.
While working on an issue where the additional logging information provided by zap fields was missing, I realized that our documentation did not indicate how to view them. So a new documentation section has been added explaining how to view the fields when using the
systemd-journaldlogging output.Also removes one trailing space.