trace-cmd(1) — Linux manual page


TRACE-CMD(1)                libtracefs Manual               TRACE-CMD(1)

NAME         top

       trace-cmd - interacts with Ftrace Linux kernel internal tracer

SYNOPSIS         top

       trace-cmd COMMAND [OPTIONS]

DESCRIPTION         top

       The trace-cmd(1) command interacts with the Ftrace tracer that is
       built inside the Linux kernel. It interfaces with the Ftrace
       specific files found in the debugfs file system under the tracing
       directory. A COMMAND must be specified to tell trace-cmd what to

COMMANDS         top

           record  - record a live trace and write a trace.dat file to the
                     local disk or to the network.

           set     - set a ftrace configuration parameter.

           report  - reads a trace.dat file and converts the binary data to a
                     ASCII text readable format.

           stream  - Start tracing and read the output directly

           profile - Start profiling and read the output directly

           hist    - show a histogram of the events.

           stat    - show tracing (ftrace) status of the running system

           options - list the plugin options that are available to *report*

           start   - start the tracing without recording to a trace.dat file.

           stop    - stop tracing (only disables recording, overhead of tracer
                     is still in effect)

           restart - restart tracing from a previous stop (only effects recording)

           extract - extract the data from the kernel buffer and create a trace.dat

           show    - display the contents of one of the Ftrace Linux kernel tracing files

           reset   - disables all tracing and gives back the system performance.
                     (clears all data from the kernel buffers)

           clear   - clear the content of the Ftrace ring buffers.

           split   - splits a trace.dat file into smaller files.

           list    - list the available plugins or events that can be recorded.

           listen  - open up a port to listen for remote tracing connections.

           agent   - listen on a vsocket for trace clients

           setup-guest - create FIFOs for tracing guest VMs

           restore - restore the data files of a crashed run of trace-cmd record

           snapshot- take snapshot of running trace

           stack   - run and display the stack tracer

           check-events - parse format strings for all trace events and return
                          whether all formats are parseable

           convert   - convert trace files

           attach   - attach a host trace.dat file to a guest trace.dat file

           dump    - read out the meta data from a trace file

OPTIONS         top

       -h, --help
           Display the help text.

       Other options see the man page for the corresponding command.

SEE ALSO         top

       trace-cmd-record(1), trace-cmd-report(1), trace-cmd-hist(1),
       trace-cmd-start(1), trace-cmd-stop(1), trace-cmd-extract(1),
       trace-cmd-reset(1), trace-cmd-restore(1), trace-cmd-stack(1),
       trace-cmd-convert(1), trace-cmd-split(1), trace-cmd-list(1),
       trace-cmd-listen(1), trace-cmd.dat(5), trace-cmd-check-events(1),
       trace-cmd-stat(1), trace-cmd-attach(1)

AUTHOR         top

       Written by Steven Rostedt, <[1]>

RESOURCES         top 

COPYING         top

       Copyright (C) 2010 Red Hat, Inc. Free use of this software is
       granted under the terms of the GNU Public License (GPL).

NOTES         top


COLOPHON         top

       This page is part of the trace-cmd (a front-end for Ftrace)
       project.  Information about the project can be found at 
       ⟨⟩.  If you have a bug report for this
       manual page, see ⟨⟩.  This page was
       obtained from the project's upstream Git repository
       ⟨⟩ on
       2023-12-22.  (At that time, the date of the most recent commit
       that was found in the repository was 2023-11-28.)  If you
       discover any rendering problems in this HTML version of the page,
       or you believe there is a better or more up-to-date source for
       the page, or you have corrections or improvements to the
       information in this COLOPHON (which is not part of the original
       manual page), send a mail to

libtracefs                     09/24/2023                   TRACE-CMD(1)

Pages that refer to this page: sqlhist(1)strace(1)trace-cmd-agent(1)trace-cmd-attach(1)trace-cmd-check-events(1)trace-cmd-clear(1)trace-cmd-convert(1)trace-cmd-dump(1)trace-cmd-extract(1)trace-cmd-hist(1)trace-cmd-list(1)trace-cmd-listen(1)trace-cmd-mem(1)trace-cmd-options(1)trace-cmd-profile(1)trace-cmd-record(1)trace-cmd-report(1)trace-cmd-reset(1)trace-cmd-restore(1)trace-cmd-set(1)trace-cmd-show(1)trace-cmd-snapshot(1)trace-cmd-split(1)trace-cmd-stack(1)trace-cmd-start(1)trace-cmd-stat(1)trace-cmd-stop(1)trace-cmd-stream(1)kbuffer_alloc(3)kbuffer_read_event(3)kbuffer_timestamp(3)libtraceevent(3)libtracefs(3)tep_alloc(3)tep_data_type(3)tep_event_common_fields(3)tep_filter_alloc(3)tep_find_common_field(3)tep_find_event(3)tep_find_function(3)tep_get_any_field_val(3)tep_get_cpus(3)tep_get_event(3)tep_get_header_page_size(3)tep_get_long_size(3)tep_get_page_size(3)tep_is_bigendian(3)tep_is_file_bigendian(3)tep_list_events(3)tep_load_plugins(3)tep_parse_event(3)tep_parse_header_page(3)tep_parse_saved_cmdlines(3)tep_plugin_kvm_get_func(3)tep_print_event(3)tep_print_field_content(3)tep_print_printk(3)tep_read_number(3)tep_read_number_field(3)tep_register_comm(3)tep_register_event_handler(3)tep_register_print_function(3)tep_set_flag(3)tep_set_function_resolver(3)tep_set_loglevel(3)tep_strerror(3)tracefs_binary_init(3)tracefs_cpu_open(3)tracefs_cpu_read_size(3)tracefs_dynevent_create(3)tracefs_eprobe_alloc(3)tracefs_error_last(3)tracefs_event_get_file(3)tracefs_event_systems(3)tracefs_file_exists(3)tracefs_filter_string_append(3)tracefs_find_cid_pid(3)tracefs_function_filter(3)tracefs_get_tracing_file(3)tracefs_hist_add_sort_key(3)tracefs_hist_alloc(3)tracefs_hist_start(3)tracefs_instance_create(3)tracefs_instance_file_open(3)tracefs_instance_get_name(3)tracefs_instance_set_affinity(3)tracefs_instance_tracers(3)tracefs_iterate_raw_events(3)tracefs_kprobe_alloc(3)tracefs_local_events(3)tracefs_option_enable(3)tracefs_options(3)tracefs_options_get_supported(3)tracefs_print_init(3)tracefs_set_loglevel(3)tracefs_sql(3)tracefs_synth_alloc(3)tracefs_synth_create(3)tracefs_synth_echo_cmd(3)tracefs_trace_is_on(3)tracefs_trace_pipe_stream(3)tracefs_tracers(3)tracefs_uprobe_alloc(3)trace_seq_init(3)trace-cmd.dat.v6(5)trace-cmd.dat.v7(5)