babeltrace2-sink.text.pretty(7)

1BABELTRACE2-SINK.(7)          Babeltrace 2 manual         BABELTRACE2-SINK.(7)
2
3
4

NAME

6       babeltrace2-sink.text.pretty - Babeltrace 2's pretty-printing sink
7       component class
8

DESCRIPTION

10       A Babeltrace 2 sink.text.pretty component pretty-prints the events,
11       discarded events, and discarded packets messages it consumes to the
12       standard output or to a file.
13
14                       +------------------+
15                       | sink.text.pretty |
16                       |                  +--> Pretty-printed messages to
17           Messages -->@ in               |    the standard output or a file and
18                       +------------------+    to the standard error
19
20       See babeltrace2-intro(7) to learn more about the Babeltrace 2 project
21       and its core concepts.
22
23       By default, a sink.text.pretty component pretty-prints to the standard
24       output. You can use the path parameter to make the component write to a
25       file instead.
26
27       The component prints warnings on the standard error stream when it
28       consumes a discarded events or discarded packets message.
29
30       If you don’t use the path parameter and the application’s standard
31       output is connected to a color-capable terminal, the component emits
32       terminal color codes to enhance the text output. You can use the color
33       parameter to force the color support or to disable it.
34
35       This component class is equivalent to the text output format of
36       babeltrace(1) (Babeltrace 1 command-line tool).
37

INITIALIZATION PARAMETERS

39       clock-cycles=yes [optional boolean]
40           Print event times in clock cycles instead of hours, minutes,
41           seconds, and nanoseconds.
42
43       clock-date=yes [optional boolean]
44           Print event times and dates.
45
46       clock-gmt=yes [optional boolean]
47           Print event times in the GMT time zone instead of the local time
48           zone.
49
50       clock-seconds=yes [optional boolean]
51           Print event times in seconds instead of hours, minutes, seconds,
52           and nanoseconds.
53
54       color=(never | auto | always) [optional string]
55           Force the terminal color support, one of:
56
57           auto (default)
58               Only emit terminal color codes when the standard output and
59               error streams are connected to a color-capable terminal.
60
61           never
62               Never emit terminal color codes.
63
64           always
65               Always emit terminal color codes.
66
67           The BABELTRACE_TERM_COLOR environment variable overrides this
68           parameter.
69
70       field-default=(show | hide) [optional string]
71           By default, show or hide all the fields. This sets the default
72           value of all the parameters which start with field-.
73
74       field-emf=(yes | no) [optional boolean]
75           Show or hide the event’s Eclipse Modeling Framework URI field.
76
77       field-loglevel=(yes | no) [optional boolean]
78           Show or hide the event’s logging level field.
79
80       field-trace=(yes | no) [optional boolean]
81           Show or hide the trace name field.
82
83       field-trace:domain=(yes | no) [optional boolean]
84           Show or hide the tracing domain field.
85
86       field-trace:hostname=(yes | no) [optional boolean]
87           Show or hide the hostname field.
88
89       field-trace:procname=(yes | no) [optional boolean]
90           Show or hide the process name field.
91
92       field-trace:vpid=(yes | no) [optional boolean]
93           Show or hide the virtual process ID field.
94
95       name-context=(yes | no) [optional boolean]
96           Show or hide the field names in the context scopes.
97
98       name-default=(show | hide) [optional string]
99           By default, show or hide all the names. This sets the default value
100           of all the parameters which start with name-.
101
102       name-header=(yes | no) [optional boolean]
103           Show or hide the field names in the header scopes.
104
105       name-payload=(yes | no) [optional boolean]
106           Show or hide the field names in the event payload scopes.
107
108       name-scope=(yes | no) [optional boolean]
109           Show or hide the scope names.
110
111       no-delta=yes [optional boolean]
112           Do not print the time delta between consecutive lines.
113
114       path=PATH [optional string]
115           Print the text output to the file PATH instead of the standard
116           output.
117
118       verbose=yes [optional boolean]
119           Turn the verbose mode on.
120

PORTS

122           +------------------+
123           | sink.text.pretty |
124           |                  |
125           @ in               |
126           +------------------+
127
128   Input
129       in
130           Single input port.
131

ENVIRONMENT VARIABLES

133       BABELTRACE_EXEC_ON_ABORT=CMDLINE
134           Execute the command line CMDLINE, as parsed like a UNIX 98 shell,
135           when any part of the Babeltrace 2 project unexpectedly aborts.
136
137           The application only aborts when the executed command returns,
138           ignoring its exit status.
139
140           This environment variable is ignored when the application has the
141           setuid or the setgid access right flag set.
142
143       BABELTRACE_TERM_COLOR=(AUTO | NEVER | ALWAYS)
144           Force the terminal color support for the babeltrace2(1) program and
145           the project’s plugins.
146
147           The available values are:
148
149           AUTO
150               Only emit terminal color codes when the standard output and
151               error streams are connected to a color-capable terminal.
152
153           NEVER
154               Never emit terminal color codes.
155
156           ALWAYS
157               Always emit terminal color codes.
158
159       BABELTRACE_TERM_COLOR_BRIGHT_MEANS_BOLD=0
160           Set to 0 to emit SGR (see
161           <https://en.wikipedia.org/wiki/ANSI_escape_code>) codes 90 to 97
162           for bright colors instead of bold (SGR code 1) and standard color
163           codes (SGR codes 30 to 37).
164

BUGS

166       If you encounter any issue or usability problem, please report it on
167       the Babeltrace bug tracker (see
168       <https://bugs.lttng.org/projects/babeltrace>).
169

RESOURCES

171       The Babeltrace project shares some communication channels with the
172       LTTng project (see <https://lttng.org/>).
173
174       •   Babeltrace website (see <https://babeltrace.org/>)
175
176       •   Mailing list (see <https://lists.lttng.org>) for support and
177           development: lttng-dev@lists.lttng.org
178
179       •   IRC channel (see <irc://irc.oftc.net/lttng>): #lttng on
180           irc.oftc.net
181
182       •   Bug tracker (see <https://bugs.lttng.org/projects/babeltrace>)
183
184       •   Git repository (see <https://git.efficios.com/?p=babeltrace.git>)
185
186       •   GitHub project (see <https://github.com/efficios/babeltrace>)
187
188       •   Continuous integration (see
189           <https://ci.lttng.org/view/Babeltrace/>)
190
191       •   Code review (see <https://review.lttng.org/q/project:babeltrace>)
192

AUTHORS

194       The Babeltrace 2 project is the result of hard work by many regular
195       developers and occasional contributors.
196
197       The current project maintainer is Jérémie Galarneau
198       <mailto:jeremie.galarneau@efficios.com>.
199

COPYRIGHT

201       This component class is part of the Babeltrace 2 project.
202
203       Babeltrace is distributed under the MIT license (see
204       <https://opensource.org/licenses/MIT>).
205