| 1 | = babeltrace2-sink.utils.counter(7) |
| 2 | :manpagetype: component class |
| 3 | :revdate: 14 September 2019 |
| 4 | |
| 5 | |
| 6 | == NAME |
| 7 | |
| 8 | babeltrace2-sink.utils.counter - Babeltrace 2's message counter sink |
| 9 | component class |
| 10 | |
| 11 | |
| 12 | == DESCRIPTION |
| 13 | |
| 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 |
| 16 | type. |
| 17 | |
| 18 | ---- |
| 19 | +--------------------+ |
| 20 | | sink.utils.counter | |
| 21 | | +--> Statistics to the |
| 22 | Messages -->@ in | standard output |
| 23 | +--------------------+ |
| 24 | ---- |
| 25 | |
| 26 | include::common-see-babeltrace2-intro.txt[] |
| 27 | |
| 28 | The component's output looks like this: |
| 29 | |
| 30 | ---- |
| 31 | 3842964 Event messages |
| 32 | 4 Stream beginning messages |
| 33 | 1 Stream end 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) |
| 40 | ---- |
| 41 | |
| 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. |
| 45 | |
| 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 |
| 48 | block was different. |
| 49 | |
| 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. |
| 53 | |
| 54 | |
| 55 | == INITIALIZATION PARAMETERS |
| 56 | |
| 57 | param:hide-zero=`yes` vtype:[optional boolean]:: |
| 58 | Do not print the statistics lines where the count is zero. |
| 59 | |
| 60 | param:step='STEP' vtype:[optional unsigned integer]:: |
| 61 | Print a new block of statistics every 'STEP' consumed messages |
| 62 | instead of 1000. |
| 63 | + |
| 64 | If 'STEP' is 0, then the component only prints statistics when there's |
| 65 | no more messages to consume. |
| 66 | |
| 67 | |
| 68 | == PORTS |
| 69 | |
| 70 | ---- |
| 71 | +--------------------+ |
| 72 | | sink.utils.counter | |
| 73 | | | |
| 74 | @ in | |
| 75 | +--------------------+ |
| 76 | ---- |
| 77 | |
| 78 | |
| 79 | === Input |
| 80 | |
| 81 | `in`:: |
| 82 | Single input port. |
| 83 | |
| 84 | |
| 85 | include::common-footer.txt[] |
| 86 | |
| 87 | |
| 88 | == SEE ALSO |
| 89 | |
| 90 | man:babeltrace2-intro(7), |
| 91 | man:babeltrace2-plugin-utils(7) |