linux/Documentation/tools/rtla
Linus Torvalds 5172a77724 tracing tools changes for 6.17:
- Introduce enum timerlat_tracing_mode
 
   Now that BPF based sampling has been added to timerlat, add an enum to
   represent which mode timerlat is running in.
 
 - Add action on timelat threshold feature
 
   A new option, --on-threshold, is added, taking an argument
   that further specifies the action. Actions added in this patch are:
 
   - trace[,file=<filename>]: Saves tracefs buffer, optionally taking a
           filename.
   - signal,num=<sig>,pid=<pid>: Sends signal to process. "parent" might
           be specified instead of number to send signal to parent process.
   - shell,command=<command>: Execute shell command.
 
 - Allow resuming tracing in timerlat bpf
 
   rtla-timerlat BPF program uses a global variable stored in a .bss section to
   store whether tracing has been stopped. Map it to allow it to resume tracing
   after it has been stopped.
 
 - Add continue action to timerlat
 
   Introduce option to resume tracing after a latency threshold overflow.  The
   option is implemented as an action named "continue".
 
 - Add action on end feature to timerlat
 
   Implement actions on end next to actions on threshold. A new option,
   --on-end is added, parallel to --on-threshold. Instead of being executed
   whenever a latency threshold is reached, it is executed at the end of the
   measurement.
 
 - Have rtla tests check output with grep
 
   Add argument to the check command in the test suite that takes a regular
   expression that the output of rtla command is checked against. This allows
   testing for specific information in rtla output in addition to checking the
   return value.
 
 - Add tests for timerlat actions
 
 - Update the documentation for the new features
 -----BEGIN PGP SIGNATURE-----
 
 iIoEABYKADIWIQRRSw7ePDh/lE+zeZMp5XQQmuv6qgUCaIuAtBQccm9zdGVkdEBn
 b29kbWlzLm9yZwAKCRAp5XQQmuv6qk1uAQCzkGc7IUqp8038HU0aZoOwSxS04ma3
 NvrF0Vuw8wvVqgD+Pogi1M7fr3LyXHzW4k3Vx7Ot3YSy52T6aCohjcKQ0wo=
 =P46B
 -----END PGP SIGNATURE-----

Merge tag 'trace-tools-v6.17' of git://git.kernel.org/pub/scm/linux/kernel/git/trace/linux-trace

Pull tracing tools updates from Steven Rostedt:

 - Introduce enum timerlat_tracing_mode

   Now that BPF based sampling has been added to timerlat, add an enum
   to represent which mode timerlat is running in

 - Add action on timelat threshold feature

   A new option, --on-threshold, is added, taking an argument that
   further specifies the action. Actions added in this patch are:

     - trace[,file=<filename>]: Saves tracefs buffer, optionally taking a
             filename
     - signal,num=<sig>,pid=<pid>: Sends signal to process. "parent" might
             be specified instead of number to send signal to parent process
     - shell,command=<command>: Execute shell command

 - Allow resuming tracing in timerlat bpf

   rtla-timerlat BPF program uses a global variable stored in a .bss
   section to store whether tracing has been stopped. Map it to allow it
   to resume tracing after it has been stopped

 - Add continue action to timerlat

   Introduce option to resume tracing after a latency threshold
   overflow. The option is implemented as an action named "continue"

 - Add action on end feature to timerlat

   Implement actions on end next to actions on threshold. A new option,
   --on-end is added, parallel to --on-threshold. Instead of being
   executed whenever a latency threshold is reached, it is executed at
   the end of the measurement

 - Have rtla tests check output with grep

   Add argument to the check command in the test suite that takes a
   regular expression that the output of rtla command is checked
   against. This allows testing for specific information in rtla output
   in addition to checking the return value

 - Add tests for timerlat actions

 - Update the documentation for the new features

* tag 'trace-tools-v6.17' of git://git.kernel.org/pub/scm/linux/kernel/git/trace/linux-trace:
  rtla/tests: Test timerlat -P option using actions
  rtla/tests: Add grep checks for base test cases
  Documentation/rtla: Add actions feature
  rtla/tests: Limit duration to maximum of 10s
  rtla/tests: Add tests for actions
  rtla/tests: Check rtla output with grep
  rtla/timerlat: Add action on end feature
  rtla/timerlat: Add continue action
  rtla/timerlat_bpf: Allow resuming tracing
  rtla/timerlat: Add action on threshold feature
  rtla/timerlat: Introduce enum timerlat_tracing_mode
2025-08-01 10:23:13 -07:00
..
common_appendix.rst Documentation/rtla: Describe exit status 2025-07-17 15:29:53 -06:00
common_hist_options.rst rtla/hist: Make -E the short version of --entries 2022-02-25 21:05:30 -05:00
common_options.rst rtla: Documentation: Fix -t, --trace 2024-05-16 16:52:16 +02:00
common_osnoise_description.rst rtla: Fix systme -> system typo on man page 2022-02-23 21:52:18 -05:00
common_osnoise_options.rst rtla: Documentation: Fix -t, --trace 2024-05-16 16:52:16 +02:00
common_timerlat_aa.rst rtla/timerlat_hist: Add auto-analysis support 2023-06-13 16:35:46 -04:00
common_timerlat_description.rst Documentation/rtla: Include BPF sample collection 2025-04-14 10:42:55 -06:00
common_timerlat_options.rst Documentation/rtla: Add actions feature 2025-07-25 16:43:57 -04:00
common_top_options.rst rtla: Add rtla osnoise top documentation 2022-01-13 17:02:43 -05:00
index.rst Documentation/rtla: Add hwnoise man page 2023-02-13 23:56:46 -05:00
Makefile rtla/Makefile: Properly handle dependencies 2022-05-26 15:17:48 -04:00
rtla-hwnoise.rst Documentation/rtla: Add hwnoise man page 2023-02-13 23:56:46 -05:00
rtla-osnoise-hist.rst rtla/hist: Make -E the short version of --entries 2022-02-25 21:05:30 -05:00
rtla-osnoise-top.rst rtla: Add rtla osnoise top documentation 2022-01-13 17:02:43 -05:00
rtla-osnoise.rst
rtla-timerlat-hist.rst Documentation/rtla: Add include common_appendix.rst 2025-07-17 15:29:53 -06:00
rtla-timerlat-top.rst Documentation: Fix typos 2023-08-18 11:29:03 -06:00
rtla-timerlat.rst Documentation/rtla: Fix typo in rtla-timerlat.rst 2025-04-14 10:42:55 -06:00
rtla.rst