Project

General

Profile

Actions

Bug #1387

closed

sink.ctf.fs is not quiet by default

Added by Thomas Applencourt 8 months ago. Updated 8 months ago.

Status:
Resolved
Priority:
Normal
Category:
Documentation
Start date:
08/31/2023
Due date:
% Done:

0%

Estimated time:

Description

```
  1. Quiet True
    applenco@polaris-login-01:~> babeltrace2 \

--component source.ctf.fs \
--params "inputs=[\"/home/applenco/lttng-traces/iprof-20230831-154527/0/ust/uid/32658/64-bit/\"]" \
--component sink.ctf.fs \
--params "path=\"/home/applenco/whatever/\",assume-single-trace=false,quiet=false"

Created CTF trace `/home/applenco/whatever//polaris-login-01/THAPI_0-20230831T154517+0000/ust/uid/32658/64-bit-0`.
  1. Quiet True
    applenco@polaris-login-01:~> babeltrace2 --component source.ctf.fs --params "inputs=[\"/home/applenco/lttng-traces/iprof-20230831-154527/0/ust/uid/32658/64-bit/\"]" --component sink.ctf.fs --params "path=\"/home/applenco/whatever/\",assume-single-trace=false,quiet=yes"
  2. Quiet default
    applenco@polaris-login-01:~> babeltrace2 --component source.ctf.fs --params "inputs=[\"/home/applenco/lttng-traces/iprof-20230831-154527/0/ust/uid/32658/64-bit/\"]" --component sink.ctf.fs --params "path=\"/home/applenco/whatever/\",assume-single-trace=false"
    Created CTF trace `/home/applenco/whatever//polaris-login-01/THAPI_0-20230831T154517+0000/ust/uid/32658/64-bit-2`.
    ```

The documentation (https://babeltrace.org/docs/v2.0/man7/babeltrace2-sink.ctf.fs.7/#doc-param-quiet) specify that the default should be `quiet=yes / true`

Actions #1

Updated by Thomas Applencourt 8 months ago

applenco@polaris-login-01:~> babeltrace2 --version
Babeltrace 2.0.4 "Amqui"

Amqui (/ɒmkwiː/) is a town in eastern Québec, Canada, at the base of the Gaspé peninsula in
Bas-Saint-Laurent. Located at the confluence of the Humqui and Matapédia Rivers, its proximity to
woodlands makes it a great destination for outdoor activities such as camping, hiking, and
mountain biking.

Actions #2

Updated by Kienan Stewart 8 months ago

Hi Thomas,

thanks for the report!

For sink.ctf.fs quiet is intended to be disabled by default. In the documentation, optional parameters show the useful invocation, .eg quiet=yes since the opposite quiet=no is implied by omitting the parameter altogether. This representation is confusing upon first reading the documentation, and we're going to leave the ticket open and address it by updating the documentation to make the default state more clear.

Something along the lines of

quiet=VAL [optional boolean]
Default: false

Similarly, in https://babeltrace.org/docs/v2.0/man7/babeltrace2-sink.ctf.fs.7/#doc-param-quiet the defaults for assume-single-trace, ignore-discarded-events, and ignore-discarded-packets are false.

Hope this helps and let us know if you have any other questions or feedback!

thanks,
kienan

Actions #3

Updated by Thomas Applencourt 8 months ago

Oh I see. The example show the `non-default-option`. I prefer the new approach that you showed indeed :)

Thanks for the reply!

Actions #4

Updated by Philippe Proulx 8 months ago

Thanks for the feedback and initial investigation.

Updated in master and stable-2.0.

See https://review.lttng.org/c/babeltrace/+/10709.

Will update the website once we make a v2.0.6 release.

Actions #5

Updated by Philippe Proulx 8 months ago

  • Category set to Documentation
  • Status changed from New to Resolved
  • Assignee set to Philippe Proulx
Actions

Also available in: Atom PDF