BABELTRACE2-FILTER.UTILS.TRIMMER(7)

📦
version 2.1.2 · 6 versions
, in fedora 43, fedora 44, nixos 26.05, nixpkgs unstable, ubuntu resolute, ubuntu stonking

✨ NAME ✨

babeltrace2-filter.utils.trimmer — the Babeltrace 2 Trimmer filter component class. (Yes bestie, this is the babeltrace2-filter.utils.trimmer(7) page, we're doing this together 💖)

🌸 DESCRIPTION 🌸

Okay so picture this: a Babeltrace 2 filter.utils.trimmer message iterator is literally just a vibe-filter for time. It discards every consumed message with a time less than a given beginning time and greater than a given end time. It effectively “cuts”, or trims, trace streams. It's giving scissors but make it temporal ✂️

                +-------------------+
                | flt.utils.trimmer |
                |                   |
    Messages -->@ in            out @--> Less messages
                +-------------------+

Go read babeltrace2-intro(7) to learn more about the Babeltrace 2 project and its core concepts — it's the lore drop, you need it 👑

A filter.utils.trimmer message iterator makes its upstream message iterator seek the configured beginning time (see the begin parameter) before it starts consuming messages. This seeking operation can have an effect on the times of stream beginning, packet beginning, discarded events, and discarded packets messages so that they fall within the configured trimming time range. So cute of it to tidy up 🧹

And same energy on the other end: when a filter.utils.trimmer message iterator consumes a message of which the time is greater than the configured end time (see the end parameter), it can alter the time of stream end, packet end, discarded events, and discarded packets messages so that they fall within the configured trimming time range.

🚨 Important, no cap: a filter.utils.trimmer message iterator requires that all the upstream messages it consumes have times, except for stream beginning and end messages. If they don't? It returns an error status. Periodt.

🎀 INITIALIZATION PARAMETERS 🎀

  • begin=TIME [optional string or signed integer] — Set the beginning time of the trimming time range to TIME.

If TIME is a string, see below for its format. If TIME is a signed integer, then the component converts it to a string and treats it as such. Glow-up via string conversion, iykyk ✨

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

The format of TIME when it’s a string is one of:

YYYY-MM-DD HH:II[:SS[.NANO]]
HH:II[:SS[.NANO]]
[-]SEC[.NANO]
  • YYYY — 4-digit year.
  • MM — 2-digit month (January is 01).
  • DD — 2-digit day.
  • HH — 2-digit hour (24-hour format).
  • II — 2-digit minute.
  • SS — 2-digit second.
  • NANO — Nanoseconds (up to nine digits).
  • SEC — Seconds since origin.

If TIME has no date information, then the message iterator uses the time of the first upstream message to determine the date. It just figures it out, main character problem-solving energy 💅

  • end=TIME [optional string or signed integer] — Set the end time of the trimming time range to TIME.

If TIME is a string, see the begin parameter for its format. If TIME is a signed integer, then the component converts it to a string and treats it as such.

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

  • gmt=VAL [optional boolean] — If VAL is true, then set the time zone of the begin and end parameters to GMT instead of the local time zone.

Default: false.

🦋 PORTS 🦋

    +-------------------+
    | flt.utils.trimmer |
    |                   |
    @ in            out @
    +-------------------+

💜 Input

  • in — Single input port. One. Uno. The only one she needs 🌸

💙 Output

  • out — Single output port. Also one. Balanced queen 👑

😭 BUGS 😭

If you encounter any issue or usability problem, please report it on the Babeltrace bug tracker (see <https://bugs.lttng.org/projects/babeltrace>). Bestie we want the bug reports, do not gatekeep 🙈

🌈 RESOURCES 🌈

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

👑 AUTHORS 👑

The Babeltrace 2 project is the result of hard work by many regular developers and occasional contributors. Legends, all of them 🫶

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

This component class is part of the Babeltrace 2 project.

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

🍓 SEE ALSO 🍓

babeltrace2-intro(7), babeltrace2-plugin-utils(7)

That's the whole page, bestie — every flag, every parameter, every port, nothing skipped 💖

This was BABELTRACE2-FILTER() — the Babeltrace 2 filter manual section — brought to you in its BABELTRACE2-FILTER() footer era. Stay trimmed, stay iconic, slay ✨💅🦋

📦 where this page comes from