babeltrace2-sink.utils.counter(7) — Linux manual page


BABELTRACE2-SINK.(7)       Babeltrace 2 manual      BABELTRACE2-SINK.(7)

NAME         top

       babeltrace2-sink.utils.counter - Babeltrace 2's message counter
       sink component class

DESCRIPTION         top

       A Babeltrace 2 sink.utils.counter component prints to the
       standard output the number of messages it consumes with a count
       for each type.

                       | sink.utils.counter |
                       |                    +--> Statistics to the
           Messages -->@ in                 |    standard output

       See babeltrace2-intro(7) to learn more about the Babeltrace 2
       project and its core concepts.

       The component’s output looks like this:

                   3842964 Event messages
                         4 Stream beginning messages
                         1 Stream end messages
                        18 Packet beginning messages
                        14 Packet end messages
                       189 Discarded event messages
                         0 Discarded packet messages
                         3 Message iterator inactivity messages
                   3843000 messages (TOTAL)

       By default, a sink.utils.counter component prints a new block of
       statistics every 1000 consumed messages, whatever their types.
       You can use the step parameter to override this default period.

       The component always prints a block of statistics when there’s no
       more messages to consume from its upstream message iterator and
       the last block was different.

       By default, a sink.utils.counter component prints the count of
       messages for each type, even if this count is 0. You can make it
       hide the zero counts with the hide-zero parameter.


       hide-zero=VAL [optional boolean]
           If VAL is true, then do not print the statistics lines where
           the count is zero.

           Default: false.

       step=STEP [optional unsigned integer]
           Print a new block of statistics every STEP consumed messages
           instead of 1000.

           If STEP is 0, then the component only prints statistics when
           there’s no more messages to consume.

PORTS         top

           | sink.utils.counter |
           |                    |
           @ in                 |

           Single input port.

BUGS         top

       If you encounter any issue or usability problem, please report it
       on the Babeltrace bug tracker (see

RESOURCES         top

       The Babeltrace project shares some communication channels with
       the LTTng project (see <>).

       •   Babeltrace website (see <>)

       •   Mailing list (see <>) for support and

       •   IRC channel (see <irc://>): #lttng on

       •   Bug tracker (see

       •   Git repository (see

       •   GitHub project (see <>)

       •   Continuous integration (see

       •   Code review (see

AUTHORS         top

       The Babeltrace 2 project is the result of hard work by many
       regular developers and occasional contributors.

       The current project maintainer is Jérémie Galarneau

COPYRIGHT         top

       This component class is part of the Babeltrace 2 project.

       Babeltrace is distributed under the MIT license (see

SEE ALSO         top

       babeltrace2-intro(7), babeltrace2-plugin-utils(7)

COLOPHON         top

       This page is part of the babeltrace (trace read and write
       libraries and a trace converter) project.  Information about the
       project can be found at ⟨⟩.  If
       you have a bug report for this manual page, send it to  This page was obtained from the
       project's upstream Git repository
       ⟨git://⟩ on 2024-06-14.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2024-05-31.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to

Babeltrace 2.1.0-rc1        1 September 2023        BABELTRACE2-SINK.(7)

Pages that refer to this page: babeltrace2(1)babeltrace2-plugin-utils(7)