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

BABELTRACE-FILTER(7)          Babeltrace manual         BABELTRACE-FILTER(7)

NAME         top

       babeltrace-filter.utils.trimmer - Babeltrace's trimmer filter
       component class

DESCRIPTION         top

       The Babeltrace filter.utils.trimmer component class, provided by the
       babeltrace-plugin-utils(7) plugin, once instantiated, discards all
       the received events with a time less than a given beginning time and
       greater than a given end time. It effectively “cuts”, or trims
       traces.

       A filter.utils.trimmer component modifies the timestamp_begin and
       timestamp_end fields of the packet contexts it receives to match the
       beggining and end times of the trimming range when needed.

       The component used a notification’s clock value with the highest
       priority to decide whether to discard it or not.

   Time parameter format
       The format of the begin and end parameters is:

           [YYYY-MM-DD [hh:mm:]]ss[.nnnnnnnnn]

       YYYY
           4-digit year.

       MM
           2-digit month (January is 01).

       DD
           2-digit day.

       hh
           2-digit hour (24-hour format).

       mm
           2-digit minute.

       ss
           2-digit second.

       nnnnnnnnn
           9-digit nanosecond.

INITIALIZATION PARAMETERS         top

       You must specify at least one of the begin and end parameters.

       begin=BEGIN (string or integer)
           Set the trimmer’s beginning time to BEGIN.

           If BEGIN is a string, see Time parameter format for its format.
           If BEGIN is an integer, it is the number of nanoseconds since
           Epoch.

           If you don’t specify this parameter, the component discards no
           events until the end of the trimming range.

       clock-gmt=yes (boolean)
           Set the time zone of the begin and end parameters to GMT instead
           of the local time zone.

       end=END (string or integer)
           Set the trimmer’s end time to END.

           If END is a string, see Time parameter format for its format. If
           END is an integer, it is the number of nanoseconds since Epoch.

           If you don’t specify this parameter, the component discards no
           events from the beginning of the trimming range.

PORTS         top

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

   Output
       out
           Single output port to which the components sends the
           notifications of which the time is in the trimming range.

QUERY OBJECTS         top

       This component class has no objects to query.

ENVIRONMENT VARIABLES         top

       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_FLT_UTILS_TRIMMER_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-utils(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-FILTER(7)

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