1 = babeltrace2-filter.utils.trimmer(7)
2 :manpagetype: component class
3 :revdate: 14 September 2019
8 babeltrace2-filter.utils.trimmer - Babeltrace 2's trimmer filter
14 A Babeltrace~2 compcls:filter.utils.trimmer message iterator
15 discards all the consumed messages with a time less than a given
16 beginning time and greater than a given end time. It effectively
17 ``cuts'', or trims trace streams.
23 Messages -->@ in out @--> Less messages
27 include::common-see-babeltrace2-intro.txt[]
29 A compcls:filter.utils.trimmer message iterator makes its upstream
30 message iterator seek the configured beginning time (see the param:begin
31 parameter) before it starts to consume messages. This seeking operation
32 can have an effect on the times of stream beginning, packet beginning,
33 discarded events, and discarded packets messages so that they fall
34 within the configured trimming time range.
36 As such, when a compcls:filter.utils.trimmer message iterator consumes a
37 message of which the time is greater than the configured end time (see
38 the param:end parameter), it can alter the time of stream end, packet
39 end, discarded events, and discarded packets messages so that they fall
40 within the configured trimming time range.
42 A compcls:filter.utils.trimmer message iterator requires that all the
43 upstream messages it consumes have times, except for stream beginning
44 and end messages, returning an error status otherwise.
47 == INITIALIZATION PARAMETERS
49 param:begin='TIME' vtype:[optional string or signed integer]::
50 Set the trimming time range's beginning time to 'TIME'.
52 If 'TIME' is a string, see below for its format. If 'TIME' is a signed
53 integer, the component converts it to a string and treats it as such.
55 If you don't specify this parameter, the component discards no events
56 until the end of the trimming time range.
58 The format of 'TIME' when it's a string is one of:
61 include::common-trimmer-time-format.txt[]
64 If 'TIME' has no date information, then the message iterator uses the
65 first upstream message's time to determine the date.
67 param:end='TIME' vtype:[optional string or signed integer]::
68 Set the trimming time range's end time to 'TIME'.
70 If 'TIME' is a string, see the param:begin parameter for its format. If
71 'TIME' is a signed integer, the component converts it to a string and
74 If you don't specify this parameter, the component discards no events
75 from the beginning of the trimming time range.
77 param:gmt=`yes` vtype:[optional boolean]::
78 Set the time zone of the param:begin and param:end parameters
79 to GMT instead of the local time zone.
105 include::common-footer.txt[]
110 man:babeltrace2-intro(7),
111 man:babeltrace2-plugin-utils(7)