trace-cmd - Man Page

• Display the status of tracing system: trace-cmd stat
• List available tracers: trace-cmd list -t
• Start tracing with a specific plugin: trace-cmd start -p timerlat|osnoise|hwlat|blk|mmiotrace|function_graph|wakeup_dl|wakeup_rt|wakeup|function|nop
• View the trace output: trace-cmd show
• Stop the tracing but retain the buffers: trace-cmd stop
• Clear the trace buffers: trace-cmd clear
• Clear the trace buffers and stop tracing: trace-cmd reset

tldr.sh

trace-cmd COMMAND [Options]

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 do.

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
          file.

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

-h,  --help

Display the help text.

Other options see the man page for the corresponding command.

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)

Written by Steven Rostedt, <rostedt@goodmis.org^[1]>

https://git.kernel.org/pub/scm/utils/trace-cmd/trace-cmd.git/

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

1.

rostedt@goodmis.org
mailto:rostedt@goodmis.org

batctl(8), kbuffer_alloc(3), kbuffer_read_event(3), kbuffer_timestamp(3), kvm_stat(1), libtracecmd(3), libtraceevent(3), libtracefs(3), sqlhist(1), strace(1), 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), trace-cmd-agent(1), trace-cmd-attach(1), tracecmd_buffer_instances(3), trace-cmd-check-events(1), trace-cmd-clear(1), trace-cmd-convert(1), trace-cmd.dat.v6(5), trace-cmd.dat.v7(5), trace-cmd-dump(1), trace-cmd-extract(1), tracecmd_get_first_ts(3), tracecmd_get_traceid(3), trace-cmd-hist(1), tracecmd_iterate_events(3), trace-cmd-list(1), trace-cmd-listen(1), tracecmd_map_vcpus(3), trace-cmd-mem(1), tracecmd_open(3), trace-cmd-options(1), trace-cmd-profile(1), tracecmd_read_cpu_first(3), trace-cmd-record(1), trace-cmd-report(1), trace-cmd-reset(1), trace-cmd-restore(1), trace-cmd-set(1), tracecmd_set_loglevel(3), trace-cmd-show(1), trace-cmd-snapshot(1), trace-cmd-split(1), trace-cmd-sqlhist(1), trace-cmd-stack(1), trace-cmd-start(1), trace-cmd-stat(1), trace-cmd-stop(1), trace-cmd-stream(1), tracefs_binary_init(3), tracefs_cpu_open(3), tracefs_cpu_open_mapped(3), tracefs_cpu_read_buf(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_pid_function(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_get_stat(3), tracefs_instance_get_subbuf_size(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_snapshot_snap(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).