Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions modules/concepts/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,5 @@
** Observability
*** xref:labels.adoc[]
*** xref:logging.adoc[]
*** xref:containerdebug.adoc[]
** xref:container-images.adoc[]
23 changes: 23 additions & 0 deletions modules/concepts/pages/containerdebug.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
= Container environment

All Stackable-managed products regularly log information about their operating
environment, such as available disk interfaces and network interfaces.

This logging is performed by our https://github.com/stackabletech/containerdebug[containerdebug] tool.

NOTE: This tool is intended as a debugging aid, and the particular information or
format should not be considered stable.

== Interval

This runs every minute. It can also be triggered manually, by running the
`containerdebug` command, inside of the main product container.

== Output

This information is logged to the Kubernetes pod logs (readable via `kubectl logs <pod>`)
and to the xref:logging.adoc#architecture[shared Stackable log dir]
(for pickup by the Vector log agent).

Additionally, it is written as JSON to `/stackable/log/containerdebug-state.json`.
This file only contains the output from the _latest_ containerdebug run.
1 change: 1 addition & 0 deletions modules/concepts/pages/logging.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ This way you can get a detailed view of the operations of a component while view
Logging for each product is configured in the Stacklet resource.
For advanced log configurations, supplying custom product specific log configuration files is also supported.

[#architecture]
== Architecture

Below you can see the overall architecture using ZooKeeper as an example.
Expand Down
Loading