NAME
babeltrace2-source.ctf.fs - Babeltrace 2's file system CTF source component classDESCRIPTION
A Babeltrace 2 source.ctf.fs message iterator reads one or more CTF (see <https://diamon.org/ctf/>) 1.8 streams on the file system and emits corresponding messages.CTF streams on the file system | | +---------------------+ | | src.ctf.fs | | | | '-->| ...5c847 | 0 | 0 @--> Stream 0 messages | ...5c847 | 0 | 1 @--> Stream 1 messages | ...5c847 | 0 | 2 @--> Stream 2 messages +---------------------+
Input
A source.ctf.fs component opens a single logical CTF trace. A logical CTF trace contains one or more physical CTF traces. A physical CTF trace on the file system is a directory which contains:•One metadata stream file named
metadata.
•One or more data stream files, that
is, any file with a name that does not start with . and which is not
metadata.
•Optional: One LTTng (see
<https://lttng.org/>) index directory named index.
Trace quirks
Many tracers produce CTF traces. A source.ctf.fs component makes some effort to support as many CTF traces as possible, even those with malformed streams.•If the timestamp_begin or
timestamp_end packet context field class exists, but it is not mapped
to a clock class, and there’s only one clock class at this point in the
metadata stream, the component maps the field class to this unique clock
class.
•The component sets the
monotonic clock class’s origin to the Unix epoch so that
different LTTng traces are always correlatable.
This is the equivalent of setting the force-clock-class-origin-unix-epoch
parameter to true.
•For a given data stream, for all the
contiguous last packets of which the timestamp_end context field is 0,
the message iterator uses the packet’s last event record’s time
as the packet end message’s time.
This is useful for the traces which lttng-crash(1) generates.
•For a given packet, the message
iterator uses the packet’s last event record’s time as the
packet end message’s time, ignoring the packet context’s
timestamp_end field.
•For a given packet, the message
iterator uses the packet’s first event record’s time as the
packet beginning message’s time, ignoring the packet context’s
timestamp_begin field.
INITIALIZATION PARAMETERS
clock-class-offset-ns=NS [optional signed integer]Add NS nanoseconds to the offset of all
the clock classes that the component creates.
You can combine this parameter with the clock-class-offset-s
parameter.
clock-class-offset-s=SEC [optional signed integer]
Add SEC seconds to the offset of all
the clock classes that the component creates.
You can combine this parameter with the clock-class-offset-ns
parameter.
force-clock-class-origin-unix-epoch=yes [optional boolean]
Force the origin of all clock classes that the
component creates to have a Unix epoch origin, whatever the detected
tracer.
inputs=DIRS [array of strings]
Open and read the physical CTF traces located
in DIRS.
Each element of DIRS is the path to a physical CTF trace directory
containing the trace’s stream files.
All the specified physical CTF traces must belong to the same logical CTF trace.
See “Input” to learn more about logical and physical CTF
traces.
trace-name=NAME [optional string]
Set the name of the trace object that the
component creates to NAME.
PORTS
+--------------------+ | src.ctf.fs | | | | ...5c847 | 0 | 1 @ | ... @ +--------------------+
Output
A source.ctf.fs component creates one output port for each logical CTF data stream. See “Input” to learn more about logical and physical CTF data streams.TRACE-ID | STREAM-CLASS-ID | STREAM-ID TRACE-ID | STREAM-ID
Trace’s UUID if available, otherwise
trace’s absolute directory path.
STREAM-CLASS-ID
Stream class ID.
STREAM-ID
Stream ID if available, otherwise
stream’s absolute file path.
QUERY OBJECTS
babeltrace.support-info
See babeltrace2-query-babeltrace.support-info(7) to learn more about this query object.0.75
group
Trace’s UUID if available, otherwise
the entry does not exist.
babeltrace.trace-infos
See babeltrace2-query-babeltrace.trace-infos(7) to learn more about this query object.metadata-info
You can query the metadata-info object for a specific CTF trace to get its plain text metadata stream as well as whether or not it is packetized.Path to the physical CTF trace directory which
contains the metadata file.
True if the metadata stream file is
packetized.
text [string]
Plain text metadata stream.
BUGS
If you encounter any issue or usability problem, please report it on the Babeltrace bug tracker (see <https://bugs.lttng.org/projects/babeltrace>).RESOURCES
The Babeltrace project shares some communication channels with the LTTng project (see <https://lttng.org/>).•Babeltrace website (see
<https://babeltrace.org/>)
•Mailing list (see
<https://lists.lttng.org>) for support and development:
[email protected]
•IRC channel (see
<irc://irc.oftc.net/lttng>): #lttng on irc.oftc.net
•Bug tracker (see
<https://bugs.lttng.org/projects/babeltrace>)
•Git repository (see
<https://git.efficios.com/?p=babeltrace.git>)
•GitHub project (see
<https://github.com/efficios/babeltrace>)
•Continuous integration (see
<https://ci.lttng.org/view/Babeltrace/>)
•Code review (see
<https://review.lttng.org/q/project:babeltrace>)