X-Git-Url: https://git.liburcu.org/?p=lttng-tools.git;a=blobdiff_plain;f=tests%2Futils%2Fbt2_plugins%2FREADME.md;fp=tests%2Futils%2Fbt2_plugins%2FREADME.md;h=5c0186f140c6f753cd49ad0f5027f4433b2db981;hp=0000000000000000000000000000000000000000;hb=9f2636716abf0d6cc188fed380ba77a621a370c1;hpb=7e547df6a875230134157556398e767574a3da69

diff --git a/tests/utils/bt2_plugins/README.md b/tests/utils/bt2_plugins/README.md
new file mode 100644
index 000000000..5c0186f14
--- /dev/null
+++ b/tests/utils/bt2_plugins/README.md
@@ -0,0 +1,23 @@
+The `filter.lttngtest.event_name` plugin only has a single input and output port.
+This means that it cannot be connected directly to a `source.ctf.fs` plugin, as
+those have multiple output ports for the different event streams.
+
+A `filter.utils.muxer` plugin must be placed between any multi-output port plugin
+and the `filter.lttngtest.event_name` plugin. This is done automatically with in
+the architecture created by `babeltrace2 convert`.
+
+Example with `babeltrace2 convert`:
+
+```
+SOURCE_PATH=/tmp/tmp.1J5DueCziG
+EVENT_NAME=tp:the_string
+babeltrace2 --plugin-path=.libs/ convert "${SOURCE_PATH}" -c filter.lttngtest.event_name -p "names=[\"$EVENT_NAME\"]" -c sink.lttngtest.field_stats
+```
+
+Example with `babeltrace2 run`:
+
+```
+SOURCE_PATH=/tmp/tmp.1J5DueCziG
+EVENT_NAME=tp:the_string
+babeltrace2 --plugin-path=.libs/ run -c A:source.ctf.fs -p "inputs=[\"$SOURCE_PATH\"]" -c muxer:filter.utils.muxer -c B:filter.lttngtest.event_name -p "names=[\"$EVENT_NAME\"]" -c C:sink.lttngtest.field_stats -x A:muxer -x muxer:B -x B:C
+```