Update manual pages for 2.0.0-rc1

[babeltrace.git] / doc / man / babeltrace2-plugin-utils.7.txt

= babeltrace2-plugin-utils(7)
:manpagetype: plugin
:revdate: 14 September 2019


== NAME

babeltrace2-plugin-utils - Babeltrace 2's common graph utilities plugin


== DESCRIPTION

The Babeltrace~2 `utils` plugin contains common, generic utility
component classes which you can use in any processing graph.

include::common-see-babeltrace2-intro.txt[]


== COMPONENT CLASSES

compcls:filter.utils.muxer::
    Muxes messages by time.
+
See man:babeltrace2-filter.utils.muxer(7).

compcls:filter.utils.trimmer::
    Discards all the consumed messages with a time outside a given
    time range, effectively ``cutting'' trace streams.
+
See man:babeltrace2-filter.utils.trimmer(7).

compcls:sink.utils.counter::
    Prints the number of consumed messages, either once at the end or
    periodically.
+
See man:babeltrace2-sink.utils.counter(7).

compcls:sink.utils.dummy::
    Consumes messages and discards them (does nothing with them).
+
This is useful for testing and benchmarking a trace processing graph
application, for example.
+
See man:babeltrace2-sink.utils.dummy(7).


include::common-footer.txt[]


== SEE ALSO

man:babeltrace2-intro(7),
man:babeltrace2-filter.utils.muxer(7),
man:babeltrace2-filter.utils.trimmer(7),
man:babeltrace2-sink.utils.counter(7),
man:babeltrace2-sink.utils.dummy(7)