Skip to content

Updated User Guide with configuration for container information logging #847

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rquidute merged 2 commits into from
Jan 21, 2026
Merged

Updated User Guide with configuration for container information logging #847

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2a5d0f4
Added Container Logging Configuration section
rquidute Jan 19, 2026
bc66fbb
Code review
rquidute Jan 19, 2026
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
29 changes: 27 additions & 2 deletions docs/Matter_TH_User_Guide/Matter_TH_User_Guide.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,8 @@ endif::[]
| 51 | 19-Nov-2025 | [Apple]Antonio Melo Jr. | * Adding symbolic links to the custom folder paths in the custom Test Cases section.
| 52 | 05-Jan-2026 | [Apple]Antonio Melo Jr. | * Adding the Test-Harness CLI section. +
* Fixing some git clone commands to include the recursive submodules flag.
| 53 | 07-Jan-2026 | [Apple]Romulo Quidute | * Adding Troubleshooting for the hanging with ModuleNotFoundError issue.
| 53 | 19-Jan-2026 | [Apple]Romulo Quidute | * Adding Troubleshooting for the hanging with ModuleNotFoundError issue. +
* Added Container Logging Configuration section.
|===

<<<
Expand Down Expand Up @@ -1887,7 +1888,31 @@ ENABLE_REALTIME_PYTHON_TEST_LOGS=True
ENABLE_REALTIME_PYTHON_TEST_LOGS=False
----

After changing this configuration, restart the TH backend container:
===== Container Logging Configuration
The TH supports optional logging of container operations for debugging and troubleshooting purposes:

* *Container logging disabled (default)*: No container operation logs are displayed
* *Container logging enabled*: Displays detailed Docker container operations including creation, destruction, and file copy operations

To configure container logging, set the `ENABLE_CONTAINER_LOGS` environment variable in the `./backend/app/core/config.py` file:

[source,shell]
----
# Enable container logging
ENABLE_CONTAINER_LOGS=True

# Disable container logging (default)
ENABLE_CONTAINER_LOGS=False
----

When enabled, the following container information will be logged:

* Container creation and docker run commands
* Container destruction (kill and remove commands)
* File copy operations between host and container
* Container execution commands

NOTE: After changing any configuration in `./backend/app/core/config.py`, restart the TH backend container:
[source,shell]
----
docker restart certification-tool_backend_1
Expand Down
Binary file modified docs/Matter_TH_User_Guide/Matter_TH_User_Guide.pdf
View file
Open in desktop
Binary file not shown.