NAME | DESCRIPTION | INITIALIZATION PARAMETERS | PORTS | QUERY OBJECTS | ENVIRONMENT VARIABLES | BUGS | RESOURCES | AUTHORS | COPYRIGHT | SEE ALSO | COLOPHON

BABELTRACE-SINK.C(7)          Babeltrace manual         BABELTRACE-SINK.C(7)

NAME         top

       babeltrace-sink.ctf.fs - Babeltrace's file system CTF sink component
       class

DESCRIPTION         top

       The Babeltrace sink.ctf.fs component class, provided by the
       babeltrace-plugin-ctf(7) plugin, once instantiated, writes the events
       it receives to one or more CTF (see <http://diamon.org/ctf/>) traces
       on the file system.

       A sink.ctf.fs component does not merge traces, in that it writes the
       notifications of different input traces to different output traces.

       This component guarantees that the output traces are semantically
       equivalent to the input traces. This means that a given output CTF
       trace contains:

       ·   The original trace environment.

       ·   The original clock classes.

       ·   The original event class names, log levels, and other static
           attributes, except for the numeric IDs.

       ·   The original field values, except for:

           ·   Timestamp fields, but the equivalent clock value remains the
               same.

           ·   Numeric ID fields.

       The component does not guarantee to keep:

       ·   The original field type attributes (for example, the sizes of the
           integer field types).

       ·   The original stream class and event class numeric IDs.

   Output path
       The path of a CTF trace is the directory which directly contains the
       metadata and data stream files as children.

       The rules to determine the path of a generated CTF trace are:

       ·   If the single-trace parameter is true, use the value of the path
           parameter.

           Otherwise:

           ·   If the input trace has a name, use
               OUTPUTPATH/TRACENAME[SUFFIX], where OUTPUTPATH is the value
               of the path parameter, TRACENAME is the input trace’s name,
               and SUFFIX is an optional numeric suffix if
               OUTPUTPATH/TRACENAME already exists.

               Note that the name of a trace that a source.ctf.fs component
               creates includes its hostname and its relative path while
               making sure to avoid conflicts.

               Otherwise, use OUTPUTPATH/trace[SUFFIX], where OUTPUTPATH and
               SUFFIX are defined above.

INITIALIZATION PARAMETERS         top

       path=PATH (string, mandatory)
           Depending on the value of the single-trace parameter, prefix of
           output trace paths or full output trace path.

       single-trace=yes (boolean, optional)
           Assume that the component only receives notifications related to
           a single source trace.

PORTS         top

   Input
       in
           Single input port from which the component receives the
           notifications.

QUERY OBJECTS         top

       This component class has no objects to query.

ENVIRONMENT VARIABLES         top

   ctf plugin
       BABELTRACE_PLUGIN_CTF_BTR_LOG_LEVEL
           Binary type reader’s log level. The available values are the same
           as for the --log-level option of babeltrace(1).

       BABELTRACE_PLUGIN_CTF_METADATA_LOG_LEVEL
           Metadata decoder’s log level. The available values are the same
           as for the --log-level option of babeltrace(1).

       BABELTRACE_PLUGIN_CTF_NOTIF_ITER_LOG_LEVEL
           Notification iterator’s log level. The available values are the
           same as for the --log-level option of babeltrace(1).

   Component class
       BABELTRACE_COMMON_LOG_LEVEL
           Common functions’s log level. The available values are the same
           as for the --log-level option of babeltrace(1).

       BABELTRACE_COMPAT_LOG_LEVEL
           Compatibility functions’s log level. The available values are the
           same as for the --log-level option of babeltrace(1).

       BABELTRACE_TERM_COLOR
           Force the terminal color support. The available values are:

           AUTO
               Only emit terminal color codes when the standard output and
               error streams are connected to a color-capable terminal.

           NEVER
               Never emit terminal color codes.

           ALWAYS
               Always emit terminal color codes.

       BABELTRACE_SINK_CTF_FS_LOG_LEVEL
           Component class’s log level. The available values are the same as
           for the --log-level option of babeltrace(1).

BUGS         top

       If you encounter any issue or usability problem, please report it on
       the Babeltrace bug tracker (see
       <https://bugs.linuxfoundation.org/buglist.cgi?product=Diamon&component=Babeltrace>).

RESOURCES         top

       The Babeltrace project shares some communication channels with the
       LTTng project (see <http://lttng.org/>).

       ·   Babeltrace website (see <http://diamon.org/babeltrace>)

       ·   Git repository (see
           <http://git.linuxfoundation.org/?p=diamon/babeltrace.git>)

       ·   EfficiOS GitHub organization (see <http://github.com/efficios/>)

       ·   Continuous integration (see
           <https://ci.lttng.org/job/babeltrace_master_build/>)

       ·   Mailing list (see <http://lists.lttng.org>) for support and
           development: lttng-dev@lists.lttng.org

       ·   IRC channel (see <irc://irc.oftc.net/lttng>): #lttng on
           irc.oftc.net

AUTHORS         top

       The Babeltrace project is the result of efforts by many regular
       developers and occasional contributors.

       The current project maintainer is Jérémie Galarneau
       <mailto:jeremie.galarneau@efficios.com>.

COPYRIGHT         top

       This component class is part of the Babeltrace project.

       Babeltrace is distributed under the MIT license (see
       <https://opensource.org/licenses/MIT>).

SEE ALSO         top

       babeltrace-plugin-ctf(7), babeltrace-intro(7)

COLOPHON         top

       This page is part of the babeltrace (trace read and write libraries
       and a trace converter) project.  Information about the project can be
       found at ⟨http://www.efficios.com/babeltrace⟩.  If you have a bug
       report for this manual page, send it to lttng-dev@lists.lttng.org.
       This page was obtained from the project's upstream Git repository
       ⟨git://git.efficios.com/babeltrace.git⟩ on 2018-10-29.  (At that
       time, the date of the most recent commit that was found in the repos‐
       itory was 2018-09-12.)  If you discover any rendering problems in
       this HTML version of the page, or you believe there is a better or
       more up-to-date source for the page, or you have corrections or
       improvements to the information in this COLOPHON (which is not part
       of the original manual page), send a mail to man-pages@man7.org

Babeltrace 2.0.0-pre4          5 October 2017           BABELTRACE-SINK.C(7)

Pages that refer to this page: babeltrace(1)babeltrace-convert(1)babeltrace-log(1)babeltrace-plugin-ctf(7)