babeltrace2-filter.utils.trimmer(7)

1BABELTRACE2-FILTER()                                      BABELTRACE2-FILTER()
2
3
4

NAME

6       babeltrace2-filter.utils.trimmer - Babeltrace 2's trimmer filter
7       component class
8

DESCRIPTION

10       A Babeltrace 2 filter.utils.trimmer message iterator discards all the
11       consumed messages with a time less than a given beginning time and
12       greater than a given end time. It effectively “cuts”, or trims trace
13       streams.
14
15                       +-------------------+
16                       | flt.utils.trimmer |
17                       |                   |
18           Messages -->@ in            out @--> Less messages
19                       +-------------------+
20
21       See babeltrace2-intro(7) to learn more about the Babeltrace 2 project
22       and its core concepts.
23
24       A filter.utils.trimmer message iterator makes its upstream message
25       iterator seek the configured beginning time (see the begin parameter)
26       before it starts to consume messages. This seeking operation can have
27       an effect on the times of stream beginning, packet beginning, discarded
28       events, and discarded packets messages so that they fall within the
29       configured trimming time range.
30
31       As such, when a filter.utils.trimmer message iterator consumes a
32       message of which the time is greater than the configured end time (see
33       the end parameter), it can alter the time of stream end, packet end,
34       discarded events, and discarded packets messages so that they fall
35       within the configured trimming time range.
36
37       A filter.utils.trimmer message iterator requires that all the upstream
38       messages it consumes have times, except for stream beginning and end
39       messages, returning an error status otherwise.
40

INITIALIZATION PARAMETERS

42       begin=TIME [optional string or signed integer]
43           Set the trimming time range’s beginning time to TIME.
44
45           If TIME is a string, see below for its format. If TIME is a signed
46           integer, the component converts it to a string and treats it as
47           such.
48
49           If you don’t specify this parameter, the component discards no
50           events until the end of the trimming time range.
51
52           The format of TIME when it’s a string is one of:
53
54               YYYY-MM-DD HH:II[:SS[.NANO]]
55               HH:II[:SS[.NANO]]
56               [-]SEC[.NANO]
57
58           YYYY
59               4-digit year.
60
61           MM
62               2-digit month (January is 01).
63
64           DD
65               2-digit day.
66
67           HH
68               2-digit hour (24-hour format).
69
70           II
71               2-digit minute.
72
73           SS
74               2-digit second.
75
76           NANO
77               Nanoseconds (up to nine digits).
78
79           SEC
80               Seconds since origin.
81
82           If TIME has no date information, then the message iterator uses the
83           first upstream message’s time to determine the date.
84
85       end=TIME [optional string or signed integer]
86           Set the trimming time range’s end time to TIME.
87
88           If TIME is a string, see the begin parameter for its format. If
89           TIME is a signed integer, the component converts it to a string and
90           treats it as such.
91
92           If you don’t specify this parameter, the component discards no
93           events from the beginning of the trimming time range.
94
95       gmt=yes [optional boolean]
96           Set the time zone of the begin and end parameters to GMT instead of
97           the local time zone.
98

PORTS

100           +-------------------+
101           | flt.utils.trimmer |
102           |                   |
103           @ in            out @
104           +-------------------+
105
106   Input
107       in
108           Single input port.
109
110   Output
111       out
112           Single output port.
113

BUGS

115       If you encounter any issue or usability problem, please report it on
116       the Babeltrace bug tracker (see
117       <https://bugs.lttng.org/projects/babeltrace>).
118

RESOURCES

120       The Babeltrace project shares some communication channels with the
121       LTTng project (see <https://lttng.org/>).
122
123       •   Babeltrace website (see <https://babeltrace.org/>)
124
125       •   Mailing list (see <https://lists.lttng.org>) for support and
126           development: lttng-dev@lists.lttng.org
127
128       •   IRC channel (see <irc://irc.oftc.net/lttng>): #lttng on
129           irc.oftc.net
130
131       •   Bug tracker (see <https://bugs.lttng.org/projects/babeltrace>)
132
133       •   Git repository (see <https://git.efficios.com/?p=babeltrace.git>)
134
135       •   GitHub project (see <https://github.com/efficios/babeltrace>)
136
137       •   Continuous integration (see
138           <https://ci.lttng.org/view/Babeltrace/>)
139
140       •   Code review (see <https://review.lttng.org/q/project:babeltrace>)
141

AUTHORS

143       The Babeltrace 2 project is the result of hard work by many regular
144       developers and occasional contributors.
145
146       The current project maintainer is Jérémie Galarneau
147       <mailto:jeremie.galarneau@efficios.com>.
148

COPYRIGHT

150       This component class is part of the Babeltrace 2 project.
151
152       Babeltrace is distributed under the MIT license (see
153       <https://opensource.org/licenses/MIT>).
154