BABELTRACE2-SINK.(7)

📦

version 2.1.2 · 6 versions

2.1.2 · fedora 43, fedora 44, nixos 26.05, nixpkgs unstable, ubuntu resolute, ubuntu stonking (latest)
2.1.0 · opensuse-leap 16.0
2.0.6 · alpine 3.24
2.0.4 · debian bookworm, ubuntu jammy
2.0.5 · ubuntu noble
2.1.1 · debian trixie, ubuntu questing

, in fedora 43, fedora 44, nixos 26.05, nixpkgs unstable, ubuntu resolute, ubuntu stonking

💅 NAME 💅

okay bestie, welcome to babeltrace2-sink.text.pretty — it's the Babeltrace 2 pretty-printing sink component class. yes that's a whole mouthful, we're gonna get through it together 🫶 (it lives in the Babeltrace 2 manual, section 7, iykyk)

✨ DESCRIPTION ✨

A sink.text.pretty Babeltrace 2 component pretty-prints the events, discarded events, and discarded packets messages it consumes, and it sends them to the standard output or to a file. that's literally its whole job and it does it gorgeously 💖

                       +------------------+
                       | sink.text.pretty |
                       |                  +--> Pretty-printed messages to
           Messages -->@ in               |    the standard output or a file and
                       +------------------+    to the standard error

if you wanna know more about the Babeltrace 2 project and its core concepts, go read babeltrace2-intro(7) — it's giving lore, go read it 📖

by default, a sink.text.pretty component pretty-prints to the standard output. but you can use the path parameter to make the component write to a file instead. your choice, main character 🌸

the component prints warnings on the standard error stream when it consumes a discarded events or discarded packets message. just a lil heads up, not a big deal 🫶

if you don't use the path parameter and the standard output of the application is connected to a color-capable terminal, the component emits terminal color codes to enhance the text output. you can use the color parameter to force the color support or to disable it. slay ✨

this component class is equivalent to the text output format of babeltrace(1) (the Babeltrace 1 command-line tool). so like, the og vibes, but modernized 💅

🎀 INITIALIZATION PARAMETERS 🎀

clock-cycles=VAL [optional boolean] — if VAL is true, then print event times in clock cycles instead of hours, minutes, seconds, and nanoseconds.

Default: false.

clock-date=VAL [optional boolean] — if VAL is true, then print event times and dates.

Default: false.

clock-gmt=VAL [optional boolean] — if VAL is true, then print event times in the GMT time zone instead of the local time zone.

Default: false.

clock-seconds=VAL [optional boolean] — if VAL is true, then print event times in seconds instead of hours, minutes, seconds, and nanoseconds.

Default: false.

color=(never | auto | always) [optional string] — force the terminal color support. pick one bestie:
- auto (default) — 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. no color for you 🚫
- always — always emit terminal color codes. rainbow mode permanently 🌈

the BABELTRACE_TERM_COLOR environment variable overrides this parameter. env var wins, periodt.

field-default=(show | hide) [optional string] — by default, show or hide all the fields. this sets the default value of all the parameters which start with field-.
field-emf=VAL [optional boolean] — show or hide the Eclipse Modeling Framework URI field of the event.