Add documentation for the log configuration #45940
Conversation
vapopov
added
no-changelog
github-actions
bot
requested review from
mmcallister,
ptgott,
xinding33 and
zmb3
|
🤖 Vercel preview here: https://docs-l9f2tvxbw-goteleport.vercel.app/docs/ver/preview |
| Other available options for defining the output include `stdout` (aliases `out` or `1`), `syslog` for writing | ||
| to the syslog file, or a filepath for direct writing to a log file destination. | ||
|
|
||
| Severity has several levels, which are sorted by increasing priority (means that if `info` is selected, `warn` and `err` also applied): |
There was a problem hiding this comment.
| Severity has several levels, which are sorted by increasing priority (means that if `info` is selected, `warn` and `err` also applied): | |
| Severity has several levels, which are sorted by decreasing priority (means that if `info` is selected, `warn` and `err` also applied): |
There was a problem hiding this comment.
slog misleads, they have different ordering with logrus
slog.LevelError = 8
slog.LevelWarn = 4
logrus.ErrorLevel = 2
logrus.WarnLevel = 3
|
🤖 Vercel preview here: https://docs-cm3ka1jr8-goteleport.vercel.app/docs/ver/preview |
| Other available options for defining the output include `stdout` (aliases `out` or `1`), `syslog` for writing | ||
| to the syslog file, or a filepath for direct writing to a log file destination. | ||
|
|
||
| Severity has several levels, which are sorted by decreasing priority (means that if `info` is selected, `warn` and `err` also applied): |
There was a problem hiding this comment.
(means that if `info` is selected, `warn` and `err` also applied)
We should fix the grammar here and make this a complete sentence. I think it would make sense to separate this into its own sentence rather than use parentheses.
| to the syslog file, or a filepath for direct writing to a log file destination. | ||
|
|
||
| Severity has several levels, which are sorted by decreasing priority (means that if `info` is selected, `warn` and `err` also applied): | ||
| - `err`, `error` - used for errors that should definitely be noted. |
There was a problem hiding this comment.
What does "should definitely be noted" mean?
There was a problem hiding this comment.
Means that these log messages indicate actions are required to fix them, errors may lead to an unpredictable state of the application
There was a problem hiding this comment.
I would say, "Logs that require action from the user" instead of "Should definitely be noted".
| - `debug` - usually only enabled when debugging, verbose logging. | ||
| - `trace` - designates more detailed informational events than the debug. |
There was a problem hiding this comment.
The descriptions here are self evident, I think. Is there anything we can say about the kinds of logs a user can expect when enabling debug or trace-level logging?
There was a problem hiding this comment.
trace usually shows very detail information like sequence of method executions
Did simple search by code base, so we don't use this level that much:
s.log.WithField("event", event).Trace("sessionCache: Received watcher event")
s.log.WithField("session_id", s.ID()).Trace("session will be recorded at proxy")
log.WithFields(log.Fields{
"src_addr": fmt.Sprintf("%v", source),
"dst_addr": fmt.Sprintf("%v", destination),
"cluster_name": p.clusterName}).Trace("Successfully generated signed PROXY header")
// Okta plugin.
log.Trace("Collating plugin resource")
log.Trace("Installing plugin")| - `debug` - usually only enabled when debugging, verbose logging. | ||
| - `trace` - designates more detailed informational events than the debug. | ||
|
|
||
| The default format for log output is `text`. Another available format is `json`, which may simplify log |
There was a problem hiding this comment.
What does "may simplify" mean here?
There was a problem hiding this comment.
means that json already has a structure for parsing with field names, if we use text, usually regular expression is used to extract data from text message
|
🤖 Vercel preview here: https://docs-2zyouwui1-goteleport.vercel.app/docs/ver/preview |
| - `warn`, `warning` - non-critical entries that deserve attention. | ||
| - `info` or empty value - general operational entries about what's going on inside the application. | ||
| - `debug` - usually only enabled when debugging, verbose logging. | ||
| - `trace` - designates more detailed information about actions and events. |
There was a problem hiding this comment.
Do we ever use "trace" level in our code? I don't think we do?
There was a problem hiding this comment.
we use, but very limited #45940 (comment), so might be better to remove?
|
@ptgott, could you please take another look at the PR? |
|
🤖 Vercel preview here: https://docs-kxytd1emr-goteleport.vercel.app/docs/ver/preview |
public-teleport-github-review-bot
bot
removed request for
mmcallister and
xinding33
vapopov
force-pushed
the
vapopov/log-filesystem-watcher-doc
branch
from
38decd6
to
aa5ac4b
Compare
|
🤖 Vercel preview here: https://docs-m1lb76i8a-goteleport.vercel.app/docs/ver/preview |
In this PR added documentation for the logger configuration in Teleport, since filesystem watcher added for the log file we should noted about new behaviour in case of move/rename/delete the log file. Also sample configuration for logrotate is added.
Related: #43359