diff options
| author |   Breno Leitao <leitao@debian.org> | 2025-02-28 04:50:23 -0800 |
|---|---|---|
| committer |   Paolo Abeni <pabeni@redhat.com> | 2025-03-04 15:28:28 +0100 |
| commit | 7010b619830f639bdb930ed1da3766fbb379d5dc (patch) | |
| tree | 3d95e98959626c558a349b8c6c34031cb3ddfe09 | |
| parent | netconsole: add task name to extra data fields (diff) | |
| download | wireguard-linux-7010b619830f639bdb930ed1da3766fbb379d5dc.tar.xz wireguard-linux-7010b619830f639bdb930ed1da3766fbb379d5dc.zip | |
netconsole: docs: document the task name feature
Add documentation for the netconsole task name feature in
Documentation/networking/netconsole.rst. This explains how to enable
task name via configfs and demonstrates the output format.
The documentation includes:
- How to enable/disable the feature via taskname_enabled
- The format of the task name in the output
- An example showing the task name appearing in messages
Signed-off-by: Breno Leitao <leitao@debian.org>
Reviewed-by: Simon Horman <horms@kernel.org>
Signed-off-by: Paolo Abeni <pabeni@redhat.com>
| -rw-r--r-- | Documentation/networking/netconsole.rst | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/Documentation/networking/netconsole.rst b/Documentation/networking/netconsole.rst index 84803c59968a..ae82a6337a8d 100644 --- a/Documentation/networking/netconsole.rst +++ b/Documentation/networking/netconsole.rst @@ -240,6 +240,34 @@ Delete `userdata` entries with `rmdir`:: It is recommended to not write user data values with newlines. +Task name auto population in userdata +------------------------------------- + +Inside the netconsole configfs hierarchy, there is a file called +`taskname_enabled` under the `userdata` directory. This file is used to enable +or disable the automatic task name population feature. This feature +automatically populates the current task name that is scheduled in the CPU +sneding the message. + +To enable task name auto-population:: + + echo 1 > /sys/kernel/config/netconsole/target1/userdata/taskname_enabled + +When this option is enabled, the netconsole messages will include an additional +line in the userdata field with the format `taskname=<task name>`. This allows +the receiver of the netconsole messages to easily find which application was +currently scheduled when that message was generated, providing extra context +for kernel messages and helping to categorize them. + +Example:: + + echo "This is a message" > /dev/kmsg + 12,607,22085407756,-;This is a message + taskname=echo + +In this example, the message was generated while "echo" was the current +scheduled process. + CPU number auto population in userdata -------------------------------------- |