babeltrace2-sink.utils.counter(7)

1BABELTRACE2-SINK.(7)          Babeltrace 2 manual         BABELTRACE2-SINK.(7)
2
3
4

NAME

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

DESCRIPTION

10       A Babeltrace 2 sink.utils.counter component prints to the standard
11       output the number of messages it consumes with a count for each type.
12
13                       +--------------------+
14                       | sink.utils.counter |
15                       |                    +--> Statistics to the
16           Messages -->@ in                 |    standard output
17                       +--------------------+
18
19       See babeltrace2-intro(7) to learn more about the Babeltrace 2 project
20       and its core concepts.
21
22       The component’s output looks like this:
23
24                   3842964 Event messages
25                         4 Stream beginning messages
26                         1 Stream end messages
27                        18 Packet beginning messages
28                        14 Packet end messages
29                       189 Discarded event messages
30                         0 Discarded packet messages
31                         3 Message iterator inactivity messages
32                   3843000 messages (TOTAL)
33
34       By default, a sink.utils.counter component prints a new block of
35       statistics every 1000 consumed messages, whatever their types. You can
36       use the step parameter to override this default period.
37
38       The component always prints a block of statistics when there’s no more
39       messages to consume from its upstream message iterator and the last
40       block was different.
41
42       By default, a sink.utils.counter component prints the count of messages
43       for each type, even if this count is 0. You can make it hide the zero
44       counts with the hide-zero parameter.
45

INITIALIZATION PARAMETERS

47       hide-zero=yes [optional boolean]
48           Do not print the statistics lines where the count is zero.
49
50       step=STEP [optional unsigned integer]
51           Print a new block of statistics every STEP consumed messages
52           instead of 1000.
53
54           If STEP is 0, then the component only prints statistics when
55           there’s no more messages to consume.
56

PORTS

58           +--------------------+
59           | sink.utils.counter |
60           |                    |
61           @ in                 |
62           +--------------------+
63
64   Input
65       in
66           Single input port.
67

BUGS

69       If you encounter any issue or usability problem, please report it on
70       the Babeltrace bug tracker (see
71       <https://bugs.lttng.org/projects/babeltrace>).
72

RESOURCES

74       The Babeltrace project shares some communication channels with the
75       LTTng project (see <https://lttng.org/>).
76
77       •   Babeltrace website (see <https://babeltrace.org/>)
78
79       •   Mailing list (see <https://lists.lttng.org>) for support and
80           development: lttng-dev@lists.lttng.org
81
82       •   IRC channel (see <irc://irc.oftc.net/lttng>): #lttng on
83           irc.oftc.net
84
85       •   Bug tracker (see <https://bugs.lttng.org/projects/babeltrace>)
86
87       •   Git repository (see <https://git.efficios.com/?p=babeltrace.git>)
88
89       •   GitHub project (see <https://github.com/efficios/babeltrace>)
90
91       •   Continuous integration (see
92           <https://ci.lttng.org/view/Babeltrace/>)
93
94       •   Code review (see <https://review.lttng.org/q/project:babeltrace>)
95

AUTHORS

97       The Babeltrace 2 project is the result of hard work by many regular
98       developers and occasional contributors.
99
100       The current project maintainer is Jérémie Galarneau
101       <mailto:jeremie.galarneau@efficios.com>.
102

COPYRIGHT

104       This component class is part of the Babeltrace 2 project.
105
106       Babeltrace is distributed under the MIT license (see
107       <https://opensource.org/licenses/MIT>).
108