babeltrace2-sink.text.details(7)

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

NAME

6       babeltrace2-sink.text.details - Babeltrace 2's detailed plain text sink
7       component class
8

DESCRIPTION

10       A Babeltrace 2 sink.text.details component deterministically prints the
11       messages it consumes, with all the possible details, to the standard
12       output.
13
14                       +-------------------+
15                       | sink.text.details |
16                       |                   +--> Detailed messages to the
17           Messages -->@ in                |    standard output
18                       +-------------------+
19
20       See babeltrace2-intro(7) to learn more about the Babeltrace 2 project
21       and its core concepts.
22
23       The purpose of a sink.text.details component is to always print the
24       same text for the same sequence of consumed messages, whatever the
25       build configuration of the Babeltrace 2 project. This can be helpful
26       for testing, debugging, and support.
27
28       The output format is optimized for human reading, with colors when the
29       terminal supports it. You can control how the component prints color
30       codes with the color parameter.
31
32       To achieve a reproducible output, a sink.text.details component sorts
33       the members of all unordered sets before it prints them. For example,
34       the component sorts enumeration field class mappings by label and, for
35       each mapping, sorts the contained ranges.
36
37       In normal mode, each message has at least three lines, the three first
38       being:
39
40        1. Timing information (cycles and nanoseconds since origin).
41
42           Example:
43
44               [102,423,274,041,829 cycles, 1,441,852,841,550,867,846 ns from origin]
45
46        2. Unique stream identifier.
47
48           To be able to follow a specific trace object (the name and UUID
49           properties of a trace object are optional), the component assigns a
50           unique numeric ID to the trace object when it first encounters it
51           in a stream beginning message.
52
53           Example:
54
55               {Trace 1, Stream class ID 0, Stream ID 2}
56
57        3. Message type and basic information.
58
59           Examples:
60
61               Packet beginning:
62
63               Event `lttng_ust_statedump:build_id` (Class ID 2):
64
65       What follows depend on the specific message type. The component prints
66       all the available properties and fields in a human-readable, structured
67       format.
68
69       When a sink.text.details component consumes a stream beginning or an
70       event message, it can print a metadata block for all the metadata
71       objects which it did not print yet. You can use the with-metadata
72       parameter to disable this.
73
74       You can hide specific properties with the with-stream-class-name, with-
75       stream-name, with-time, with-trace-name, and with-uuid parameters.
76
77       To make the component hide many message details and print a single
78       message per line, you can enable the compact mode with the compact
79       parameter.
80

INITIALIZATION PARAMETERS

82       color=(never | auto | always) [optional string]
83           Force the terminal color support, one of:
84
85           auto (default)
86               Only emit terminal color codes when the standard output and
87               error streams are connected to a color-capable terminal.
88
89           never
90               Never emit terminal color codes.
91
92           always
93               Always emit terminal color codes.
94
95           The BABELTRACE_TERM_COLOR environment variable overrides this
96           parameter.
97
98       compact=yes [optional boolean]
99           Enable compact mode.
100
101           In compact mode, the component prints one line per message,
102           omitting many details about messages. This is useful if you only
103           need the time, type, and very basic information of messages.
104
105           In compact mode, the component still prints the full metadata
106           blocks. You can remove such blocks with the with-metadata
107           parameter.
108
109       with-metadata=no [optional boolean]
110           Do not print metadata blocks.
111
112       with-stream-class-name=no [optional boolean]
113           Do not print stream class names.
114
115       with-stream-name=no [optional boolean]
116           Do not print stream names.
117
118       with-time=no [optional boolean]
119           Do not print timing information.
120
121       with-trace-name=no [optional boolean]
122           Do not print trace names.
123
124       with-uuid=no [optional boolean]
125           Do not print UUIDs.
126

PORTS

128           +-------------------+
129           | sink.text.details |
130           |                   |
131           @ in                |
132           +-------------------+
133
134   Input
135       in
136           Single input port.
137

ENVIRONMENT VARIABLES

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

BUGS

172       If you encounter any issue or usability problem, please report it on
173       the Babeltrace bug tracker (see
174       <https://bugs.lttng.org/projects/babeltrace>).
175

RESOURCES

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

AUTHORS

200       The Babeltrace 2 project is the result of hard work by many regular
201       developers and occasional contributors.
202
203       The current project maintainer is Jérémie Galarneau
204       <mailto:jeremie.galarneau@efficios.com>.
205

COPYRIGHT

207       This component class is part of the Babeltrace 2 project.
208
209       Babeltrace is distributed under the MIT license (see
210       <https://opensource.org/licenses/MIT>).
211