Repository navigation
docs: Describe how the containerdebug logs are collected - #975
siegfriedweber wants to merge 1 commit into
Conversation
✅ Deploy Preview for stackable-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
NickLarsenNZ
left a comment
NickLarsenNZ
left a comment
There was a problem hiding this comment.
I think a few small tweaks might be needed.
| The collected information is logged to the Kubernetes pod logs (readable via `kubectl logs <pod>`) | ||
| and to the xref:observability/logging.adoc#architecture[shared Stackable log dir] | ||
| (for pickup by the Vector log agent). | ||
| containerdebug writes its output to three places: the pod logs, a rotating log file for the log aggregation, and a state file with the result of the latest run. |
There was a problem hiding this comment.
I assume this means STDOUT/STDERR. maybe we could say console logs. Unless Pod logs has been used in other places to mean the same thing.
There was a problem hiding this comment.
I assume...
I see it clarified below. Maybe its fine. Leaving the comment in case you have an opinion.
| [CAUTION] | ||
| ==== | ||
| If you override `FILE_LOG_DIRECTORY`, then the directory has to stay exactly one level below `/stackable/log`, because the Vector agent takes the container name from that path segment. | ||
| A directory next to it, such as `/stackable/log/<product>`, mixes the containerdebug events into the logs of that container. |
There was a problem hiding this comment.
I think this is a little hard to understand. I'm guessing it means if the user were to set FILE_LOG_DIR to the product directory, then the containerdebug logs would be mixed with the product logs.
|
|
||
| === State file | ||
|
|
||
| The collected information is additionally written as JSON to `/stackable/log/containerdebug-state.json`. |
There was a problem hiding this comment.
I assume this doesn't get scraped by vector.
Description
The
Outputsection of the containerdebug page said that the collected information goes to the shared Stackable log dir for pickup by the Vector agent, without saying how that is enabled. It has in fact not happened since containerdebug 0.2.0, which no longer reads the environment variable that the operators were setting.This splits the section into pod logs, aggregated log files and state file, and documents the
FILE_LOG_DIRECTORY,FILE_LOG_ROTATION_PERIODandFILE_LOG_MAX_FILESvariables which the operators set instead. It also explains that the events carry the container namecontainerdebugalthough no container of that name exists, which path an override has to keep, and that the file log level is independent of the log configuration of the product container. The link to containerdebug now points at the crate in operator-rs, where the tool lives.Part of stackabletech/issues#909
Docs
Checklist
Author
Reviewer
Acceptance