Next: , Previous: , Up: TRAMP 2.8.2.31.1 User Manual [Contents][Index]


9 How to Customize Traces

TRAMP messages are raised with verbosity levels ranging from 0 to 10. TRAMP does not display all messages; only those with a verbosity level less than or equal to 3, when tramp-verbose permits.

The verbosity levels are

With tramp-verbose greater than or equal to 4, messages are also written to the TRAMP debug buffer *debug tramp/foo*. Such debug buffers are essential to bug and problem analyzes. For TRAMP bug reports, set the tramp-verbose level to 6 (see Reporting Bugs and Problems).

The debug buffer is in Outline Mode. In this buffer, messages can be filtered by their level. To see messages up to verbosity level 5, enter C-u 6 C-c C-q.

TRAMP handles errors internally. Hence, to get a Lisp backtrace, the following settings are required:

(setq debug-on-error t
 debug-on-signal t)

Sometimes, TRAMP shows the connection buffer for more information when an error has appeared. The buffer is shown for tramp-error-show-message-timeout seconds, or until an input event arrives. You can change this variable to another value. If it isn’t a natural number (for example, nil), the buffer isn’t shown.

TRAMP warnings are displayed in the *Warnings* buffer, which pops up. If you don’t want to see this buffer for every TRAMP warning, set warning-suppress-types:

(setq warning-suppress-types '((tramp)))

If tramp-verbose is greater than or equal to 10, Lisp backtraces are also added to the TRAMP debug buffer in case of errors.

In very rare cases it could happen, that TRAMP blocks Emacs. Killing Emacs does not allow inspecting the debug buffer. In that case, you can instruct TRAMP to mirror the debug buffer to a file:

(customize-set-variable 'tramp-debug-to-file t)

The debug buffer is written as a file in your Where temporary files are kept. Use this option with care, because it could decrease the performance of TRAMP actions.

If tramp-verbose is greater than or equal to 11, TRAMP function call traces are written to the buffer *trace tramp/foo*.

When tramp-debug-command-messages is non-nil, the debug buffer contains all messages with verbosity level 6 (sent and received strings), and the entry and exit messages for the function tramp-file-name-handler. This is intended for TRAMP maintainers, analyzing the remote commands for performance analysis.

The debug buffer can be very large, if tramp-verbose is high, and TRAMP runs for a long time. If the buffer size exceeds tramp-debug-buffer-limit (100MB by default), a warning will be raised. This user option can be adapted to your needs; a value of 0 means that there is no limit (no warning).


Next: GNU Free Documentation License, Previous: How file names, directories and localnames are mangled and managed, Up: TRAMP 2.8.2.31.1 User Manual [Contents][Index]

AltStyle によって変換されたページ (->オリジナル) /