Commit | Line | Data |
---|---|---|
0659f3af PP |
1 | babeltrace-filter.utils.trimmer(7) |
2 | ================================== | |
3 | :manpagetype: component class | |
4 | :revdate: 5 October 2017 | |
5 | ||
6 | ||
7 | NAME | |
8 | ---- | |
9 | babeltrace-filter.utils.trimmer - Babeltrace's trimmer filter | |
10 | component class | |
11 | ||
12 | ||
13 | DESCRIPTION | |
14 | ----------- | |
15 | The Babeltrace compcls:filter.utils.trimmer component class, provided by | |
16 | the man:babeltrace-plugin-utils(7) plugin, once instantiated, discards | |
17 | all the received events with a time less than a given beginning time and | |
18 | greater than a given end time. It effectively ``cuts'', or trims traces. | |
19 | ||
20 | A compcls:filter.utils.trimmer component modifies the `timestamp_begin` | |
21 | and `timestamp_end` fields of the packet contexts it receives to match | |
22 | the beggining and end times of the trimming range when needed. | |
23 | ||
24 | The component used a notification's clock value with the highest | |
25 | priority to decide whether to discard it or not. | |
26 | ||
27 | ||
28 | [[time-param-fmt]] | |
29 | Time parameter format | |
30 | ~~~~~~~~~~~~~~~~~~~~~ | |
31 | The format of the param:begin and param:end parameters is: | |
32 | ||
33 | [verse] | |
34 | $$[$$__YYYY__-__MM__-__DD__ [__hh__:__mm__:]]__ss__[.__nnnnnnnnn__] | |
35 | ||
36 | 'YYYY':: | |
37 | 4-digit year. | |
38 | ||
39 | 'MM':: | |
40 | 2-digit month (January is `01`). | |
41 | ||
42 | 'DD':: | |
43 | 2-digit day. | |
44 | ||
45 | 'hh':: | |
46 | 2-digit hour (24-hour format). | |
47 | ||
48 | 'mm':: | |
49 | 2-digit minute. | |
50 | ||
51 | 'ss':: | |
52 | 2-digit second. | |
53 | ||
54 | 'nnnnnnnnn':: | |
55 | 9-digit nanosecond. | |
56 | ||
57 | ||
58 | INITIALIZATION PARAMETERS | |
59 | ------------------------- | |
60 | You must specify at least one of the param:begin and param:end | |
61 | parameters. | |
62 | ||
63 | param:begin='BEGIN' (string or integer):: | |
64 | Set the trimmer's beginning time to 'BEGIN'. | |
65 | + | |
66 | If 'BEGIN' is a string, see <<time-param-fmt,Time parameter format>> for | |
67 | its format. If 'BEGIN' is an integer, it is the number of nanoseconds | |
68 | since Epoch. | |
69 | + | |
70 | If you don't specify this parameter, the component discards no events | |
71 | until the end of the trimming range. | |
72 | ||
73 | param:clock-gmt=`yes` (boolean):: | |
74 | Set the time zone of the param:begin and param:end parameters | |
75 | to GMT instead of the local time zone. | |
76 | ||
77 | param:end='END' (string or integer):: | |
78 | Set the trimmer's end time to 'END'. | |
79 | + | |
80 | If 'END' is a string, see <<time-param-fmt,Time parameter format>> for | |
81 | its format. If 'END' is an integer, it is the number of nanoseconds | |
82 | since Epoch. | |
83 | + | |
84 | If you don't specify this parameter, the component discards no events | |
85 | from the beginning of the trimming range. | |
86 | ||
87 | ||
88 | PORTS | |
89 | ----- | |
90 | Input | |
91 | ~~~~~ | |
92 | `in`:: | |
93 | Single input port from which the component receives the | |
94 | notifications. | |
95 | ||
96 | ||
97 | Output | |
98 | ~~~~~~ | |
99 | `out`:: | |
100 | Single output port to which the components sends the notifications | |
101 | of which the time is in the trimming range. | |
102 | ||
103 | ||
104 | QUERY OBJECTS | |
105 | ------------- | |
106 | This component class has no objects to query. | |
107 | ||
108 | ||
109 | ENVIRONMENT VARIABLES | |
110 | --------------------- | |
111 | include::common-common-compat-env.txt[] | |
112 | ||
113 | `BABELTRACE_FLT_UTILS_TRIMMER_LOG_LEVEL`:: | |
114 | Component class's log level. The available values are the | |
115 | same as for the manopt:babeltrace(1):--log-level option of | |
116 | man:babeltrace(1). | |
117 | ||
118 | ||
119 | include::common-footer.txt[] | |
120 | ||
121 | ||
122 | SEE ALSO | |
123 | -------- | |
124 | man:babeltrace-plugin-utils(7), | |
125 | man:babeltrace-intro(7) |