SARG-REPORTS(1)

✨ sarg-reports — the manual page, but make it cute ✨

okay bestie, so this is sarg-reports(1) from the General Commands Manual section, and it's genuinely one of those little scripts that carries your whole squid-reporting life. let's get into it 💅

---

🌸 NAME 🌸

sarg-reports — the Daily/Weekly/Monthly squid usage reports creation tool. yes, that's the whole name. it does what it says on the tin, no cap.

---

🎀 SYNOPSIS 🎀

sarg-reports [OPTIONS]

that's it. that's the whole vibe. one command, some options, reports happen ✨

---

🦋 DESCRIPTION 🦋

so this manual page gives you the lowdown on the sarg-reports command. briefly. but thoroughly. both.

sarg-reports is a script written to automate the SARG reports and log management — and if you don't know, SARG is a powerful squid log analyzer. iconic behavior honestly.

Sarg itself gives the end user a generic interface to create reports based on the squid access log, running from the beginning of the log all the way to the current date. but sarg-reports?? it's useful because it lets you easily create and manage Daily, Weekly and Monthly reports. it's giving personal assistant energy. it's giving main character. 🫶

---

💖 OPTIONS 💖

a summary of options is included below. she's short, she's sweet, she's got five of them:

• manual — create a Manual report 📝
• today — create a Today report ☀️
• daily — create a Daily report 🌈
• weekly — create a Weely report 🌸 (yes bestie, the original manpage spells it "Weely", we keep the facts exactly as they are, no edits, that's the rule 💀)
• monthly — create a Monthly report 👑

---

⏰ CRONTAB ⏰

if you want the reports to be generated automatically, drop the following lines in (and listen: the today report creation time depends mostly on your sarg server load average, so tune it, okay? don't just copy-paste and walk away 🙈):

PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
00 08-18/1 * * * sarg-reports today
00 00      * * * sarg-reports daily
00 01      * * 1 sarg-reports weekly
30 02      1 * * sarg-reports monthly

REMEMBER: if you use logrotate, configure it to retain enough logs to ensure availability of data for the longest period for which you need a report. Log rotation frequency is unimportant. See https://sourceforge.net/p/sarg/wiki/Keeping%20enough%20log%20to%20process/

This version of sarg-reports will use the log file defined in sarg.conf and also prior log files which have been rotated out of that location. so it's got range. it's got history. literally 🗂️

---

🧚 VARIABLES 🧚

check before using the sarg-reports that the following variables are set to file /etc/sarg/sarg-reports.conf — like, do the vibe check first, bestie, don't skip it:

• SARG — the sarg executable location 📍
• CONFIG — the sarg main configuration file location 📍
• HTMLOUT — location where will be saved the reports 💾
• LASTLOGDAILY — set the number of previous daily/today/manual reports to keep 🗓️
• LASTLOGWEEKLY — set the number of previous weekly reports to keep 🗓️
• LASTLOGMONTHLY — set the number of previous monthly reports to keep 🗓️
• PAGETITLE — the title of main index page 🏷️
• LOGOIMG — image logo to view in main index page 🖼️
• LOGOLINK — HTTP web page link of logo 🔗
• DAILY — word 'daily' translation, translate it to your language 🗣️
• WEEKLY — word 'weekly' translation, translate it to your language 🗣️
• MONTHLY — word 'monthly' translation, translate it to your language 🗣️
• EXCLUDELOG1 — exclude text from cron emails (normally, sarg, during cron activity, if it don't find any valid records, 📭
• EXCLUDELOG2 — it will output an error message (usually on 'today' reports). I don't want to be warned by email about this, so, i wrote the 'text' that will be never logged. This is useful to receive email of real problems only. 📪
• EXCLUDELOG3 — this is debian-specific and used to filter the covered period message 🐧

ngl, EXCLUDELOG1 and EXCLUDELOG2 are kind of one sentence split across two variables in the original — and we're keeping it exactly that way, because the facts do not move. periodt. 💅

---

👑 AUTHOR 👑

sarg-reports was written by Ugo Viti <ugo.viti@initzero.it> 💜

This manual page was written by Juan Angulo Moreno <juan@apuntale.com>, for the Debian project (but may be used by others). slay 🫶

---

and that's the whole page, bestie!! this one's dated may 17, 2008 and it's the SARG-REPORTS(1) page — go forth and generate those daily/weekly/monthly reports, you absolute icon 🌟💖✨