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

BABELTRACE-SOURCE(7)          Babeltrace manual         BABELTRACE-SOURCE(7)

NAME         top

       babeltrace-source.ctf.lttng-live - Babeltrace's LTTng live source
       component class

DESCRIPTION         top

       The Babeltrace source.ctf.lttng-live source component class, provided
       by the babeltrace-plugin-ctf(7) plugin, once instantiated, connects
       to a local or remote LTTng (see <http://lttng.org/>) relay daemon and
       emits the received notifications on its output ports. More
       information about LTTng live is available in the LTTng Documentation
       (see <http://lttng.org/docs/#doc-lttng-live>).

       A source.ctf.lttng-live component handles the notifications of one,
       and only one LTTng tracing session. A single LTTng tracing session
       can contain one or more traces, depending on the active tracing
       domains and the configured user space buffering scheme.

       The component connects to an LTTng relay daemon using the url
       parameter.

       For each trace, the component creates one output port per effective
       data stream. The name of a data stream output port is stream-
       followed by its unique LTTng live ID within the tracing session.

       The component names each trace [HOSTNAME/]SESSION/PATH, with:

       HOSTNAME
           Value of the trace’s hostname environment constant. If this
           environment constant does not exist, or if its value is not a
           string, then this part is omitted.

       SESSION
           Tracing session name.

       PATH
           Other path elements up to the trace directory containing the
           metadata file from the LTTng relay daemon’s point of view. For
           example:

               kernel

               ust/uid/1000/64-bit

       For example:

           myhost/auto-20150909-223909/ust/uid/1000/64-bit

       A source.ctf.lttng-live never blocks: it asks the downstream
       component to try again later instead.

INITIALIZATION PARAMETERS         top

       url=URL (string, mandatory)
           The URL to use to connect to the LTTng relay daemon. The format
           of URL is:

               net[4]://RDHOST[:RDPORT]/host/TGTHOST/SESSION

           RDHOST
               LTTng relay daemon’s host name or IP address.

           RDPORT
               LTTng relay daemon’s listening port. If not specified, the
               default port, 5344, is used.

           TGTHOST
               Target’s host name or IP address.

           SESSION
               Name of the LTTng tracing session from which to receive data.

PORTS         top

   Output
       When you create the component, its only output port is no-stream.
       This port exists as long as there is no data stream output port. The
       port only asks the downstream component to try again later.

       For each received LTTng trace, the component creates one output port
       for each effective data stream. The name of a data stream output port
       is stream-ID, where ID is a unique LTTng live ID within the tracing
       session.

QUERY OBJECTS         top

   sessions
       You can query the sessions object to get a list of available LTTng
       live tracing sessions for a given LTTng relay daemon URL.

       Parameters:

       url (string, mandatory)
           The URL to use to connect to the LTTng relay daemon. The format
           of URL is:

               net[4]://RDHOST[:RDPORT]

           RDHOST
               LTTng relay daemon’s host name or IP address.

           RDPORT
               LTTng relay daemon’s listening port. If not specified, the
               default port, 5344, is used.

       Returned object (array of maps, one element for each tracing
       session):

       url (string)
           URL to use as the url parameter to connect to the same LTTng
           relay daemon and receive data from this tracing session.

       target-hostname (string)
           Hostname of the tracing session. This is not necessarily the
           relay daemon’s hostname.

       session-name (string)
           Tracing session’s name.

       timer-us (integer)
           Tracing session’s configured live timer (µs) (see
           lttng-create(1)).

       stream-count (integer)
           Current number of streams in this tracing sessions, including the
           metadata streams.

       client-count (integer)
           Current number of LTTng live clients connected to the relay
           daemon to receive data from this tracing session.

LIMITATIONS         top

       A source.ctf.lttng-live component only accepts a connection to one of
       its output port if all its output ports are connected to the input
       ports of the same downstream component.

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_SRC_CTF_LTTNG_LIVE_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), lttng-relayd(8),
       lttng-create(1)

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-SOURCE(7)

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