Commit | Line | Data |
---|---|---|
838dd456 PP |
1 | babeltrace-sink.utils.counter(7) |
2 | ================================ | |
3 | :manpagetype: component class | |
4 | :revdate: 5 October 2017 | |
5 | ||
6 | ||
7 | NAME | |
8 | ---- | |
9 | babeltrace-sink.utils.counter - Babeltrace's notification counter sink | |
10 | component class | |
11 | ||
12 | ||
13 | DESCRIPTION | |
14 | ----------- | |
15 | The Babeltrace compcls:sink.utils.counter component class, provided by | |
16 | the man:babeltrace-plugin-utils(7) plugin, once instantiated, prints to | |
17 | the standard output the number of notifications it receives on its input | |
18 | port, with a count for each type. | |
19 | ||
20 | The component's output looks like this: | |
21 | ||
22 | ---- | |
23 | 664891 events | |
24 | 12 stream beginnings | |
25 | 0 stream ends | |
26 | 93 packet beginnings | |
27 | 81 packet ends | |
28 | 0 inactivities | |
29 | 6 discarded events notifications | |
30 | 375378 known discarded events | |
31 | 2 discarded packets notifications | |
32 | 5 known discarded packets | |
33 | 1040455 notifications (TOTAL) | |
34 | ---- | |
35 | ||
36 | By default, a compcls:sink.utils.counter component prints a new block of | |
37 | statistics every 1000 received notifications, whatever their types. You | |
38 | can use the param:step parameter to override this default period. | |
39 | ||
40 | The component always prints a block of statistics when there's no more | |
41 | notifications to receive from its input port and the last block was | |
42 | different. | |
43 | ||
44 | By default, a compcls:sink.utils.counter component prints the count of | |
45 | notifications for each type, even if this count is 0. You can make it | |
46 | hide the zero counts with the param:hide-zero parameter. | |
47 | ||
48 | ||
49 | INITIALIZATION PARAMETERS | |
50 | ------------------------- | |
51 | The following parameters are optional. | |
52 | ||
53 | param:hide-zero=`yes` (boolean):: | |
54 | Do not print the statistics lines where the count is zero. | |
55 | ||
56 | param:step='STEP' (integer):: | |
57 | Print a new block of statistics every 'STEP' received notifications | |
58 | instead of 1000. If 'STEP' is 0, then the component only prints | |
59 | statistics when there's no more notifications to receive. | |
60 | ||
61 | ||
62 | PORTS | |
63 | ----- | |
64 | Input | |
65 | ~~~~~ | |
66 | `in`:: | |
67 | Single input port from which the component receives the | |
68 | notifications to count. | |
69 | ||
70 | ||
71 | QUERY OBJECTS | |
72 | ------------- | |
73 | This component class has no objects to query. | |
74 | ||
75 | ||
76 | ENVIRONMENT VARIABLES | |
77 | --------------------- | |
78 | include::common-common-compat-env.txt[] | |
79 | ||
80 | ||
81 | include::common-footer.txt[] | |
82 | ||
83 | ||
84 | SEE ALSO | |
85 | -------- | |
86 | man:babeltrace-plugin-utils(7), | |
87 | man:babeltrace-intro(7) |