Skip to content

docs: Describe how the containerdebug logs are collected - #975

Merged
siegfriedweber merged 3 commits into
mainfrom
feat/collect-containerdebug-logs
Nov 10, 2026
Merged

siegfriedweber merged 3 commits into
mainfrom
feat/collect-containerdebug-logs

Conversation

@siegfriedweber

Copy link
Copy Markdown
Member

Description

The Output section 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_PERIOD and FILE_LOG_MAX_FILES variables which the operators set instead. It also explains that the events carry the container name containerdebug although 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

  • AI review done, findings addressed

Reviewer

  • Useful comments and logging
  • Docs added or updated per the style guide

Acceptance

  • Check for release notes and docs

@siegfriedweber siegfriedweber self-assigned this Nov 4, 2026
@netlify

netlify Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for stackable-docs ready!

Name Link
🔨 Latest commit c362c2b
🔍 Latest deploy log https://app.netlify.com/projects/stackable-docs/deploys/6af2e08bca8690e4c2c8e7b3
😎 Deploy Preview https://deploy-preview-975--stackable-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@NickLarsenNZ NickLarsenNZ left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think a few small tweaks might be needed.

@siegfriedweber
siegfriedweber added this pull request to the merge queue Nov 10, 2026
Merged via the queue into main with commit 1373295 Nov 10, 2026
7 checks passed
@siegfriedweber
siegfriedweber deleted the feat/collect-containerdebug-logs branch November 10, 2026 13:02
@siegfriedweber siegfriedweber moved this to Development: Done in Stackable Engineering Nov 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Development: Done

Development

Successfully merging this pull request may close these issues.

2 participants