NAME | DESCRIPTION | INITIALIZATION PARAMETERS | PORTS | QUERY OBJECTS | ENVIRONMENT VARIABLES | BUGS | RESOURCES | AUTHORS | COPYRIGHT | SEE ALSO | COLOPHON |
|
BABELTRACE-SINK.T(7) Babeltrace manual BABELTRACE-SINK.T(7)
babeltrace-sink.text.pretty - Babeltrace's pretty-printing sink component class
The Babeltrace sink.text.pretty component class, provided by the babeltrace-plugin-text(7) plugin, once instantiated, pretty-prints the events it receives from its input port to the console or to a file. By default, a sink.text.pretty component pretty-prints to the standard output. You can use the path parameter for the component to write to a file instead. The component also prints warnings on the standard error stream when it receives a discarded packets or discarded events notification. If you don’t use the path parameter and the application’s standard output is connected to a color-capable terminal, the component emits terminal color codes to enhance the text output for human consumption. You can use the color parameter to force the color support or to disable it.
The following parameters are optional. clock-cycles=yes (boolean) Print event times in clock cycles instead of hours, minutes, seconds, and nanoseconds. clock-date=yes (boolean) Print event times and dates. clock-gmt=yes (boolean) Print event times in the GMT time zone instead of the local time zone. clock-seconds=yes (boolean) Print event times in seconds instead of hours, minutes, seconds, and nanoseconds. color=(never | auto | always) (string) Force the terminal color support, one of: auto (default) Only emit terminal color codes when the standard output and error streams are connected to a color-capable terminal. never Never emit terminal color codes. always Always emit terminal color codes. The BABELTRACE_TERM_COLOR environment variable overrides this parameter. field-default=(show | hide) (string) By default, show or hide all the fields. This sets the default value of all the parameters which start with field-. field-emf=(yes | no) (boolean) Show or hide the event’s Eclipse Modeling Framework URI field. field-loglevel=(yes | no) (boolean) Show or hide the event’s logging level field. field-trace=(yes | no) (boolean) Show or hide the trace name field. field-trace:domain=(yes | no) (boolean) Show or hide the tracing domain field. field-trace:hostname=(yes | no) (boolean) Show or hide the hostname field. field-trace:procname=(yes | no) (boolean) Show or hide the process name field. field-trace:vpid=(yes | no) (boolean) Show or hide the virtual process ID field. name-context=(yes | no) (boolean) Show or hide the field names in the context scopes. name-default=(show | hide) (string) By default, show or hide all the names. This sets the default value of all the parameters which start with name-. name-header=(yes | no) (boolean) Show or hide the field names in the header scopes. name-payload=(yes | no) (boolean) Show or hide the field names in the event payload scopes. name-scope=(yes | no) (boolean) Show or hide the scope names. no-delta=yes (boolean) Do not print the time delta between consecutive lines. path=PATH (string) Print the text output to the file PATH instead of the standard output. verbose=yes (boolean) Turn the verbose mode on.
Input in Single input port from which the component receives the event notifications to pretty-print.
This component class has no objects to query.
BABELTRACE_COMMON_LOG_LEVEL Common functions’s log level. The available values are the same as for the --log-level option of babeltrace(1). BABELTRACE_COMPAT_LOG_LEVEL Compatibility functions’s log level. The available values are the same as for the --log-level option of babeltrace(1). BABELTRACE_TERM_COLOR Force the terminal color support. The available values are: AUTO Only emit terminal color codes when the standard output and error streams are connected to a color-capable terminal. NEVER Never emit terminal color codes. ALWAYS Always emit terminal color codes.
If you encounter any issue or usability problem, please report it on the Babeltrace bug tracker (see <https://bugs.linuxfoundation.org/buglist.cgi?product=Diamon&component=Babeltrace>).
The Babeltrace project shares some communication channels with the LTTng project (see <http://lttng.org/>). · Babeltrace website (see <http://diamon.org/babeltrace>) · Git repository (see <http://git.linuxfoundation.org/?p=diamon/babeltrace.git>) · EfficiOS GitHub organization (see <http://github.com/efficios/>) · Continuous integration (see <https://ci.lttng.org/job/babeltrace_master_build/>) · Mailing list (see <http://lists.lttng.org>) for support and development: lttng-dev@lists.lttng.org · IRC channel (see <irc://irc.oftc.net/lttng>): #lttng on irc.oftc.net
The Babeltrace project is the result of efforts by many regular developers and occasional contributors. The current project maintainer is Jérémie Galarneau <mailto:jeremie.galarneau@efficios.com>.
This component class is part of the Babeltrace project. Babeltrace is distributed under the MIT license (see <https://opensource.org/licenses/MIT>).
babeltrace-plugin-text(7), babeltrace-intro(7)
This page is part of the babeltrace (trace read and write libraries
and a trace converter) project. Information about the project can be
found at ⟨http://www.efficios.com/babeltrace⟩. If you have a bug
report for this manual page, send it to lttng-dev@lists.lttng.org.
This page was obtained from the project's upstream Git repository
⟨git://git.efficios.com/babeltrace.git⟩ on 2018-02-02. (At that
time, the date of the most recent commit that was found in the repos‐
itory was 2018-01-30.) 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 man-pages@man7.org
Babeltrace 2.0.0-pre4 5 October 2017 BABELTRACE-SINK.T(7)
Pages that refer to this page: babeltrace(1), babeltrace-convert(1), babeltrace-plugin-text(7)