doc/man/babeltrace2-sink.utils.counter.7.txt

   1 = babeltrace2-sink.utils.counter(7)
   2 :manpagetype: component class
   3 :revdate: 1 September 2023
   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='VAL' vtype:[optional boolean]::
  58     If 'VAL' is true, then do not print the statistics lines where the
  59     count is zero.
  60 +
  61 Default: false.
  62
  63 param:step='STEP' vtype:[optional unsigned integer]::
  64     Print a new block of statistics every 'STEP' consumed messages
  65     instead of 1000.
  66 +
  67 If 'STEP' is 0, then the component only prints statistics when there's
  68 no more messages to consume.
  69
  70
  71 == PORTS
  72
  73 ----
  74 +--------------------+
  75 | sink.utils.counter |
  76 |                    |
  77 @ in                 |
  78 +--------------------+
  79 ----
  80
  81
  82 === Input
  83
  84 `in`::
  85     Single input port.
  86
  87
  88 include::common-footer.txt[]
  89
  90
  91 == SEE ALSO
  92
  93 man:babeltrace2-intro(7),
  94 man:babeltrace2-plugin-utils(7)