SARG(1)

SARG

SARG(1)

نام (NAME)

sarg - تولید‌کننده گزارش‌های تحلیل و بررسی اسکوئید (Squid)

خلاصه دستور (SYNOPSIS)

sarg [options] [logfile...]

توضیحات (DESCRIPTION)

sarg یک تجزیه‌کننده و تحلیل‌گر فایل لاگ برای Squid Web Proxy Cache[1] است. این ابزار به شما امکان می‌دهد بررسی کنید که کاربران شما در اینترنت به «کجا» می‌روند.

sarg گزارش‌هایی در قالب HTML با فیلدهایی از جمله کاربران، نشانی‌های IP، بایت‌ها، سایت‌ها و زمان‌ها تولید می‌کند. این فایل‌های HTML می‌توانند در دایرکتوری وب‌سرور شما قرار گیرند تا توسط کاربران یا مدیران سیستم مرور شوند. همچنین می‌توانید تنظیم کنید که sarg گزارش‌ها را برای مدیر کش اسکوئید (Squid Cache) ایمیل کند.

sarg می‌تواند لاگ‌های دسترسی squid یا Microsoft ISA را بخواند. این ابزار همچنین می‌تواند گزارش‌ها را با لاگ فیلتر یا هدایت‌کننده‌های اسکوئید مانند squidGuard[2] تکمیل کند.

گزینه‌ها (OPTIONS)

خلاصه‌ای از گزینه‌ها در زیر آمده است.

-h --help

نمایش خلاصه گزینه‌ها.

-a hostname|ip address

محدود کردن گزارش به رکوردهایی که حاوی نام میزبان یا نشانی IP مشخص‌شده هستند.

-b filename

فعال‌سازی لاگ UserAgent و نوشتن آن در filename.

-c filename

خواندن filename برای دریافت فهرستی از میزبان‌های وب که باید از گزارش مستثنی شوند. بخش «فایل استثنای میزبان‌ها (HOST EXCLUSION FILE)» را ببینید.

--convert

تبدیل فیلد تاریخ/زمان فایل لاگ squid به قالبی قابل خواندن برای انسان. تمام فایل‌های لاگ خوانده شده و به صورت یک متن یکپارچه در خروجی استاندارد چاپ می‌شوند.

--css

چاپ CSS داخلی که sarg درون گزارش‌ها قرار می‌دهد در خروجی استاندارد. می‌توانید خروجی را به فایل دلخواه هدایت کرده و آن را ویرایش کنید. سپس می‌توانید با استفاده از external_css_file در sarg.conf CSS داخلی را بازنویسی کنید.

استفاده از CSS خارجی می‌تواند حجم فایل گزارش را کاهش دهد. اگر با کمبود فضای دیسک مواجه هستید، می‌توانید برون‌ریزی CSS را طبق توضیحات بالا مد نظر قرار دهید.

-d date

استفاده از date برای محدود کردن گزارش به بازه تاریخی مشخص در حین پردازش فایل لاگ. قالب date به صورت dd/mm/yyyy-dd/mm/yyyy یا یک تاریخ منفرد dd/mm/yyyy است. بازه‌های تاریخی را می‌توان به صورت day-n، week-n یا month-n نیز مشخص کرد که در آن n تعداد روزها، هفته‌ها یا ماه‌ها برای بازگشت به عقب است. توجه داشته باشید که در اطراف خط تیره فاصله‌ای وجود ندارد.

-e email

ارسال گزارش به email (stdout برای کنسول).

-f filename

خواندن پیکربندی از filename.

-g e|u

تنظیم قالب تاریخ در گزارش‌های تولیدشده.

e = Europe -> dd/mm/yy

u = USA -> mm/dd/yy

-i

تولید گزارش بر اساس کاربر و نشانی IP.

نکته
این گزینه نیازمند آن است که گزینه report_type در فایل پیکربندی حاوی "users_sites" باشد.

--keeplogs

عدم حذف گزارش‌های قدیمی. این گزینه معادل تنظیم --lastlog 0 است، اما برای راحتی بیشتر ارائه شده است.

-l filename

استفاده از filename به عنوان لاگ ورودی. این گزینه می‌تواند تا ۲۵۵ بار برای خواندن چندین فایل تکرار شود. اگر فایل‌ها با پسوند .gz، .bz2 یا .Z خاتمه یابند، از حالت فشرده خارج می‌شوند. اگر نام فایل فقط - باشد، فایل لاگ از ورودی استاندارد خوانده می‌شود. در این حالت، فایل نمی‌تواند فشرده باشد.

این گزینه برای سازگاری با نسخه‌های قدیمی‌تر sarg حفظ شده است؛ اما از نسخه sarg 2.3 به بعد، فایل‌های لاگ می‌توانند بدون گزینه -l در خط فرمان مشخص شوند. این ویژگی امکان استفاده از کاراکترهای عام (wildcards) را در خط فرمان فراهم می‌کند. اطمینان حاصل کنید که از محدودیت ۲۵۵ فایل فراتر نروید.

--lastlog n

محدود کردن تعداد لاگ‌های نگهداری‌شده در دایرکتوری خروجی به n. هر گزارش مازاد بر این تعداد، با شروع از قدیمی‌ترین گزارش حذف می‌شود. مقدار n باید مثبت یا صفر باشد. مقدار صفر یعنی هیچ گزارشی حذف نشود.

-L filename

خواندن فایل لاگ هدایت‌کننده پراکسی مانند فایل ایجادشده توسط squidGuard یا Rejik. اگر از این گزینه استفاده می‌کنید، ممکن است بخواهید redirector_log_format را در sarg.conf طوری تنظیم کنید که با قالب خروجی برنامه فیلتر محتوای وب شما مطابقت داشته باشد. این گزینه می‌تواند تا ۶۴ بار برای خواندن چندین فایل تکرار شود.

-n

فعال‌سازی تفکیک نشانی‌های IP (DNS resolution).

-o dir

نوشتن گزارش در dir.

-p

تولید گزارش با استفاده از نشانی IP به جای userid.

-P prefix --splitprefix prefix

این گزینه باید همراه با --split استفاده شود. در صورت ارائه، لاگ ورودی میان چندین فایل که هر کدام شامل یک روز است تقسیم می‌شود. نام فایل‌های خروجی از prefix و تاریخ با قالب -YYYY-MM-DD ساخته می‌شود.

فایل‌های خروجی در دایرکتوری خروجی مشخص‌شده با -o یا در دایرکتوری جاری نوشته می‌شوند.

-r

چاپ گزارش بی‌درنگ (realtime) در خروجی استاندارد و خروج.

-s string

محدود کردن گزارش به سایت مشخص‌شده توسط string [مثلاً www.debian.org].

--split

تقسیم فایل لاگ squid و چاپ متنی آن در خروجی استاندارد با حذف تاریخ‌های خارج از بازه مشخص‌شده توسط پارامتر -d. در صورت ترکیب با --convert تاریخ‌ها نیز به قالبی قابل خواندن برای انسان تبدیل می‌شوند.

در ترکیب با -P، لاگ در چندین فایل ذخیره می‌شود که هر کدام حاوی یک روز از لاگ اصلی است.

--statistics

نوشتن آمارهایی درباره زمان اجرا. این آمار شامل کل زمان اجرا، تعداد رکوردهای خوانده‌شده از فایل‌های لاگ ورودی و زمان صرف‌شده برای خواندن آن‌ها، تعداد رکوردها و کاربران پردازش‌شده و زمان صرف‌شده برای پردازش آن‌ها است.

-t string

محدود کردن رکوردهای موجود در گزارش بر اساس زمان روز. قالب string به صورت HH:MM یا HH:MM-HH:MM است. حالت اول فقط زمان خواسته‌شده را گزارش می‌کند. حالت دوم هر ورودی قرارگرفته در بازه درخواستی را گزارش می‌دهد. این محدودیت مکمل محدودیت اعمال‌شده توسط گزینه -d است.

-u user

محدود کردن گزارش‌ها به فعالیت‌های user.

-v

چاپ نسخه sarg و خروج.

-w dir

ذخیره فایل‌های موقت در dir. در واقع، sarg فایل‌های موقت خود را در زیردایرکتوری sarg از مسیر dir ذخیره می‌کند. حتماً دایرکتوری خروجی HTML را در مکانی خارج از دایرکتوری موقت تنظیم کنید؛ در غیر این صورت ممکن است sarg با خطا مواجه شود یا پس از تکمیل وظیفه خود، گزارش را حذف کند.

-x

نوشتن پیام‌های اشکال‌زدایی در stdout

-z

نوشتن پیام‌های فرآیند در stdout.

فایل استثنای میزبان‌ها (HOST EXCLUSION FILE)

می‌توان به Sarg اعلام کرد که میزبان‌های بازدیدشده را با ارائه فایلی که در هر خط شامل یک میزبان برای استثنا کردن است، از گزارش حذف کند. «میزبان» ممکن است یکی از موارد زیر باشد:

•یک نام میزبان کامل،

•یک نام میزبان که با کاراکتر عام (*) شروع می‌شود تا با هر پیشوندی مطابقت داشته باشد،

•یک نشانی IP منفرد،

•یک زیرشبکه با قالب a.b.c.d/e.

مثال 1. نمونه‌ای از یک فایل استثنای میزبان‌ها

*.google.com

10.0.0.0/8

Sarg در حال حاضر نمی‌تواند نشانی‌های IPv6 را مستثنی کند.

همچنین ببینید (SEE ALSO)

squid(8)

نویسندگان (AUTHORS)

این صفحه راهنما توسط Luigi Gangitano<gangitano@lugroma3.org>، برای سیستم Debian GNU/Linux نوشته شده است (اما ممکن است توسط دیگران نیز استفاده شود). بازبینی توسط Billy Newsom.

در حال حاضر توسط Frédéric Marchal<fmarchal@users.sourceforge.net> نگهداری می‌شود.