Test2::...::Trace(3)

📦 version 1.302214, in opensuse-leap 16.0

🌸 NAME 🌸

okay so bestie, this is the Test2::...::Trace(3) page from the User Contributed Perl Documentation, and the main character is Test2::EventFacet::Trace — literally the debug information for events. no cap, it's giving “where did this event come from?” energy and we're obsessed. 💖

✨ DESCRIPTION ✨

The Test2::API::Context object, as well as all Test2::Event types, needs to have access to information about where they were created. This object represents that information. periodt. 🦋

🎀 SYNOPSIS 🎀

like, here's the whole vibe in code, bestie:

use Test2::EventFacet::Trace;

my $trace = Test2::EventFacet::Trace->new(
    frame => [$package, $file, $line, $subname],
);

slay. that frame is literally [$package, $file, $line, $subname]. ✨

💅 FACET FIELDS 💅

the facet field menu is stacked, bestie:

  • $string = $trace->{details} / $string = $trace->details() — used as a custom trace message that will be used INSTEAD of "at <FILE> line <LINE>" when calling "$trace->debug". it's the “say it your way” field, fr fr. 💅
  • $frame = $trace->{frame} / $frame = $trace->frame() — get the call frame arrayref, and it's literally:
[$package, $file, $line, $subname]
  • $int = $trace->{pid} / $int = $trace->pid() — the process ID in which the event was generated. 🫶
  • $int = $trace->{tid} / $int = $trace->tid() — the thread ID in which the event was generated. 🧵
  • $id = $trace->{cid} / $id = $trace->cid() — the ID of the context that was used to create the event. 🎀
  • $uuid = $trace->{uuid} / $uuid = $trace->uuid() — the UUID of the context that was used to create the event. (If uuid tagging was enabled) 🦋
  • ($pkg, $file, $line, $subname) = $trace->call — get the basic call info as a list. cute. 🧚
  • @caller = $trace->full_call — get the full caller(N) results. yes bestie, all of them. 🌈
  • $warning_bits = $trace->warning_bits — get index 9 from the full caller info. this is the warnings_bits field. 🍓

the value of this is not portable across perl versions or even processes. however, it can be used in the process that generated it to reproduce the warnings settings in a new scope. like this:

eval <<EOT;
BEGIN { ${^WARNING_BITS} = $trace->warning_bits };
... context's warning settings apply here ...
EOT

okay bestie, listen: these fields were not always set properly by tools. these are MOSTLY deprecated by the Test2::EventFacet::Hub facets. these fields are not required, and may only reflect the hub that was current when the event was created, which is not necessarily the same as the hub the event was sent through.

some tools did do a good job setting these to the correct hub, but you cannot always rely on that. use the 'hubs' facet list instead. 💀

  • $hid = $trace->{hid} / $hid = $trace->hid() — the ID of the hub that was current when the event was created. 🐝
  • $huuid = $trace->{huuid} / $huuid = $trace->huuid() — the UUID of the hub that was current when the event was created. (If uuid tagging was enabled). 🦋
  • $int = $trace->{nested} / $int = $trace->nested() — how deeply nested the event is. 🪆
  • $bool = $trace->{buffered} / $bool = $trace->buffered() — true if the event was buffered and not sent to the formatter independent of a parent (This should never be set when nested is 0 or "undef"). no cap, read that caveat twice. 😭

🔥 METHODS 🔥

Note: All facet frames are also methods. mwah. 💋

  • $trace->set_detail($msg) / $msg = $trace->detail — used to get/set a custom trace message that will be used INSTEAD of "at <FILE> line <LINE>" when calling "$trace->debug". detail() is an alias to the "details" facet field for backwards compatibility. 💖
  • $str = $trace->debug — typically returns the string "at <FILE> line <LINE>". if "detail" is set then its value will be returned instead. iconic. ✨
  • $trace->alert($MESSAGE) — this issues a warning at the frame (filename and line number where errors should be reported). not me issuing warnings at the exact spot, but yes. 😭
  • $trace->throw($MESSAGE) — this throws an exception at the frame (filename and line number where errors should be reported). dramatic? yes. useful? also yes. 💀
  • ($package, $file, $line, $subname) = $trace->call() — get the caller details for the debug-info. this is where errors should be reported. 🎀
  • $pkg = $trace->package — get the debug-info package. 📦
  • $file = $trace->file — get the debug-info filename. 🗂️
  • $line = $trace->line — get the debug-info line number. 🔢
  • $subname = $trace->subname — get the debug-info subroutine name. 🧚
  • $sig = trace->signature — get a signature string that identifies this trace. this is used to check if multiple events are related. the signature includes pid, tid, file, line number, and the cid. 👑

🌈 SOURCE 🌈

the source code repository for Test2 can be found at <https://github.com/Test-More/test-more/>. go off, source code. 🫶

👑 MAINTAINERS 👑

Chad Granum <exodist@cpan.org>

🦋 AUTHORS 🦋

Chad Granum <exodist@cpan.org>

Copyright Chad Granum <exodist@cpan.org>.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See <https://dev.perl.org/licenses/>

okay bestie, that's the whole Test2::...::Trace(3) page — the footer says perl v5.42.0 and 2025-07-28, so the source/version and date are right here, cute and accounted for. bye bestie, go trace those events 💅🫶✨

📦 where this page comes from