diff --git a/modules/concepts/nav.adoc b/modules/concepts/nav.adoc index d8c9a0c45..311f5cd62 100644 --- a/modules/concepts/nav.adoc +++ b/modules/concepts/nav.adoc @@ -24,4 +24,5 @@ ** Observability *** xref:labels.adoc[] *** xref:logging.adoc[] +*** xref:containerdebug.adoc[] ** xref:container-images.adoc[] diff --git a/modules/concepts/pages/containerdebug.adoc b/modules/concepts/pages/containerdebug.adoc new file mode 100644 index 000000000..2dccc5abd --- /dev/null +++ b/modules/concepts/pages/containerdebug.adoc @@ -0,0 +1,24 @@ += 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 + +The tool collects and logs the state of the container every minute. It can also +be triggered manually, by running the `containerdebug` command inside of the +main product container. + +== Output + +The collected information is logged to the Kubernetes pod logs (readable via `kubectl logs `) +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. diff --git a/modules/concepts/pages/logging.adoc b/modules/concepts/pages/logging.adoc index 2b8bc1b61..7bbe0fc00 100644 --- a/modules/concepts/pages/logging.adoc +++ b/modules/concepts/pages/logging.adoc @@ -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.