Skip to content

Commit 02a44b6

Browse files
authored
Add basic containerdebug logs (#699)
* Add basic containerdebug logs * Try to clarify wording a bit
1 parent 3570a68 commit 02a44b6

File tree

3 files changed

+26
-0
lines changed

3 files changed

+26
-0
lines changed

modules/concepts/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,5 @@
2424
** Observability
2525
*** xref:labels.adoc[]
2626
*** xref:logging.adoc[]
27+
*** xref:containerdebug.adoc[]
2728
** xref:container-images.adoc[]
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
= Container environment
2+
3+
All Stackable-managed products regularly log information about their operating
4+
environment, such as available disk interfaces and network interfaces.
5+
6+
This logging is performed by our https://github.com/stackabletech/containerdebug[containerdebug] tool.
7+
8+
NOTE: This tool is intended as a debugging aid, and the particular information or
9+
format should not be considered stable.
10+
11+
== Interval
12+
13+
The tool collects and logs the state of the container every minute. It can also
14+
be triggered manually, by running the `containerdebug` command inside of the
15+
main product container.
16+
17+
== Output
18+
19+
The collected information is logged to the Kubernetes pod logs (readable via `kubectl logs <pod>`)
20+
and to the xref:logging.adoc#architecture[shared Stackable log dir]
21+
(for pickup by the Vector log agent).
22+
23+
Additionally, it is written as JSON to `/stackable/log/containerdebug-state.json`.
24+
This file only contains the output from the _latest_ containerdebug run.

modules/concepts/pages/logging.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ This way you can get a detailed view of the operations of a component while view
3030
Logging for each product is configured in the Stacklet resource.
3131
For advanced log configurations, supplying custom product specific log configuration files is also supported.
3232

33+
[#architecture]
3334
== Architecture
3435

3536
Below you can see the overall architecture using ZooKeeper as an example.

0 commit comments

Comments
 (0)