General
You can use those options before the command name.
See babeltrace2(1) for more details.
-d
, --debug
Legacy option: this is equivalent to --log-level
=TRACE
.
-l
LVL, --log-level
=LVL
Set the log level of all known Babeltrace 2 loggers to LVL.
--omit-home-plugin-path
Do not search for plugins in
$HOME/.local/lib/babeltrace2/plugins
.
--omit-system-plugin-path
Do not search for plugins in
/usr/local/lib/babeltrace2/plugins
.
--plugin-path
=PATH[:PATH]...
Add PATH to the list of paths in which plugins can be found.
-v
, --verbose
Legacy option: this is equivalent to --log-level
=INFO
.
Component creation
See 'Create components' for more details.
-b
PARAMS, --base-params
=PARAMS
Set the current base parameters to PARAMS.
You can reset the current base parameters with the --reset-
base-params
option.
See the --params
option for the format of PARAMS.
-c
NAME:COMP-CLS-TYPE.PLUGIN-NAME.COMP-CLS-NAME,
--component
=NAME:COMP-CLS-TYPE.PLUGIN-NAME.COMP-CLS-NAME
Create a component named NAME from the component class of
type COMP-CLS-TYPE named COMP-CLS-NAME found in the plugin
named PLUGIN-NAME, and set it as the current component.
The available values for TYPE are:
source
, src
Source component class.
filter
, flt
Filter component class.
sink
Sink component class.
The initial initialization parameters of this component are
copied from the current base initialization parameters (see
the --base-params
option).
-l
LVL, --log-level
=LVL
Set the log level of the current component to LVL.
The available values for LVL are:
NONE
, N
Logging is disabled.
FATAL
, F
Severe errors that lead the execution to abort
immediately.
This level should be enabled in production.
ERROR
, E
Errors that might still allow the execution to continue.
Usually, once one or more errors are reported at this
level, the application, plugin, or library won't perform
any more useful task, but it should still exit cleanly.
This level should be enabled in production.
WARN
, WARNING
, W
Unexpected situations which still allow the execution to
continue.
This level should be enabled in production.
INFO
, I
Informational messages that highlight progress or
important states of the application, plugins, or library.
This level can be enabled in production.
DEBUG
, D
Debugging information, with a higher level of details
than the TRACE
level.
This level should NOT be enabled in production.
TRACE
, T
Low-level debugging context information.
This level should NOT be enabled in production.
-p
PARAMS, --params
=PARAMS
Add PARAMS to the initialization parameters of the current
component.
If PARAMS contains a key which exists in the current
component's initialization parameters, replace the parameter.
The format of PARAMS is a comma-separated list of NAME=VALUE
assignments:
NAME=VALUE[,NAME=VALUE]...
NAME
Parameter name (C identifier plus the :
, .
, and -
characters).
VALUE
One of:
• null
, nul
, NULL
: null value.
• true
, TRUE
, yes
, YES
: true boolean value.
• false
, FALSE
, no
, NO
: false boolean value.
• Binary (0b
prefix), octal (0
prefix), decimal, or
hexadecimal (0x
prefix) unsigned (with +
prefix) or
signed 64-bit integer.
• Double precision floating point number (scientific
notation is accepted).
• Unquoted string with no special characters, and not
matching any of the null and boolean value symbols
above.
• Double-quoted string (accepts escape characters).
• Array, formatted as an opening [
, a comma-separated
list of VALUE, and a closing ]
.
• Map, formatted as an opening {
, a comma-separated
list of NAME=VALUE assignments, and a closing }
.
You may put whitespaces around the individual =
(assignment), ,
(separator), [
(array beginning), ]
(array end), {
(map beginning), and }
(map end)
characters.
Example:
--params='many=null, fresh=yes, condition=false, squirrel=-782329,
play=+23, observe=3.14, simple=beef,
needs-quotes="some string",
escape.chars-are:allowed="a \" quote",
things=[1, "hello", 2.71828],
frog={slow=2, bath=[bike, 23], blind=NO}'
Important
Like in the example above, make sure to single-quote the
whole argument when you run this command from a shell, as
it can contain many special characters.
-r
, --reset-base-params
Reset the current base parameters.
You can set the current base parameters with the --base-
params
option.
Component connection
-x
CONN-RULE, --connect
=CONN-RULE
Add the connection rule CONN-RULE.
The format of CONN-RULE is:
UP-COMP-PAT[.UP-PORT-PAT]:DOWN-COMP-PAT[.DOWN-PORT-PAT]
UP-COMP-PAT
Upstream component name pattern.
UP-PORT-PAT
Upstream (output) port name pattern.
DOWN-COMP-PAT
Downstream component name pattern.
DOWN-PORT-PAT
Downstream (input) port name pattern.
See 'Connect components' to learn more.
Graph configuration
--retry-duration
=TIME-US
Set the duration of a single retry to TIME-US µs when a sink
component reports "try again later" (busy network or file
system, for example).
Default: 100000 (100 ms).
Command information
-h
, --help
Show the command's help and quit.