Timegroup(3pm)

📦 version 2.1.1, in arch rolling

💅 Timegroup(3pm) — Lire::Timegroup, bestie edition

okay so this is Lire::Timegroup, and yes it lives in the Timegroup(3pm) manpage, welcome to the function, grab a snack 🍓

✨ SYNOPSIS ✨

use Lire::Timegroup;

that's literally it, that's the whole vibe check to get in 💖

🌸 DESCRIPTION 🌸

So Lire::Timegroup is the base class for implementations of the timegroup aggregator. and what does that aggregator do, you ask? bestie it splits the DLF records based on a time period, and that period is controlled through the period attribute. like, imagine you set the period value to 1d — then the aggregator groups every record that falls in the same day period together. one day, one bucket, no cap 🎀

👑 CONSTRUCTOR 👑

new( %params )

Makes you a brand new instance of a timegroup aggregator, slay. On top of the normal report operator parameters, the timegroup aggregator can also take these extra parameters:

  • field — this one's optional, and it holds the DLF field containing the time value that gets used to group the DLF records together. peek at the field() method for more info 👀
  • period — this one is mandatory (not optional, bestie, don't skip it) and it should contain the period's length used to group the records. go read the period() method for the details ✨

🦋 METHODS 🦋

field( [$new_field] )

Returns the DLF field's name that's used to group the DLF records 💅 It should be a valid timestamp DLF field in the current schema. If you don't pass anything, the default timestamp field of the DLF schema is used — iconic default behavior fr fr.

and if you do want something different, just pass a $new_field parameter and it changes the field. easy.

period( [$new_period] )

Returns the period's length — like, the window the records get grouped into 🌈 This can be either a duration value, or the name of a report specification's parameter that contains a duration value. both are valid, we love options.

Wanna change the period's length? pass in the $new_period parameter and you're set 🫶

💜 SEE ALSO 💜

go read those too, iykyk 😭

🌟 AUTHORS 🌟

  • Francis J. Lacoste <flacoste@logreport.org>
  • Wolfgang Sourdeau <Wolfgang.Sourdeau@Contre.COM>

absolute main characters, we stan 💖

⭐ VERSION ⭐

$Id: Timegroup.pm,v 1.33 2006/07/23 13:16:30 vanbaal Exp $

Copyright (C) 2001-2004 Stichting LogReport Foundation LogReport@LogReport.org

This file is part of Lire.

Lire is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program (see COPYING); if not, check with http://www.gnu.org/copyleft/gpl.html.

ok that's the whole page bestie, no notes 💀

and that's the wrap!! this little beauty is from Lire 2.1.1, dated 2025-09-28, and the page you just read is Timegroup(3pm) — mwah, go forth and group your timestamps 💅✨🎀

📦 where this page comes from