1 = babeltrace2-sink.utils.counter(7)
2 :manpagetype: component class
3 :revdate: 14 September 2019
8 babeltrace2-sink.utils.counter - Babeltrace 2's message counter sink
14 A Babeltrace~2 compcls:sink.utils.counter component prints to the
15 standard output the number of messages it consumes with a count for each
19 +--------------------+
20 | sink.utils.counter |
21 | +--> Statistics to the
22 Messages -->@ in | standard output
23 +--------------------+
26 include::common-see-babeltrace2-intro.txt[]
28 The component's output looks like this:
31 3842964 Event messages
32 4 Stream beginning messages
34 18 Packet beginning messages
35 14 Packet end messages
36 189 Discarded event messages
37 0 Discarded packet messages
38 3 Message iterator inactivity messages
39 3843000 messages (TOTAL)
42 By default, a compcls:sink.utils.counter component prints a new block of
43 statistics every 1000 consumed messages, whatever their types. You can
44 use the param:step parameter to override this default period.
46 The component always prints a block of statistics when there's no more
47 messages to consume from its upstream message iterator and the last
50 By default, a compcls:sink.utils.counter component prints the count of
51 messages for each type, even if this count is 0. You can make it hide
52 the zero counts with the param:hide-zero parameter.
55 == INITIALIZATION PARAMETERS
57 param:hide-zero=`yes` vtype:[optional boolean]::
58 Do not print the statistics lines where the count is zero.
60 param:step='STEP' vtype:[optional unsigned integer]::
61 Print a new block of statistics every 'STEP' consumed messages
64 If 'STEP' is 0, then the component only prints statistics when there's
65 no more messages to consume.
71 +--------------------+
72 | sink.utils.counter |
75 +--------------------+
85 include::common-footer.txt[]
90 man:babeltrace2-intro(7),
91 man:babeltrace2-plugin-utils(7)