نام (NAME)

vinyllog - نمایش لاگ‌های Vinyl Cache

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

vinyllog [-a] [-A] [-b] [-c] [-C] [-d] [-D] [-E] [-g <session|request|vxid|raw>] [-h] [-i <taglist>] [-I <[taglist:]regex>] [-k <num>] [-L <limit>] [-n <workdir>] [-P <file>] [-Q <file>] [-q <query>] [-r <filename>] [-R <limit[/duration]>] [-t <seconds|off>] [-T <seconds>] [-u] [-v] [-V] [-w <filename>] [-x <taglist>] [-X <[taglist:]regex>]

گزینه‌ها (OPTIONS)

گزینه‌های زیر در دسترس هستند:

-a: هنگام نوشتن خروجی در یک فایل با گزینهٔ -w، به جای رونویسی روی آن، خروجی به انتهای فایل الحاق می‌شود. این گزینه بدون گزینهٔ -w هیچ تأثیری ندارد.
-A: هنگام نوشتن خروجی در یک فایل با گزینهٔ -w، داده‌ها در قالب ascii خارج می‌شوند. این گزینه بدون گزینهٔ -w هیچ تأثیری ندارد.
-b: تنها تراکنش‌ها و رکوردهای لاگ ناشی از ارتباط با backend را نمایش می‌دهد.
-c: تنها تراکنش‌ها و رکوردهای لاگ ناشی از ارتباط با کلاینت (client) را نمایش می‌دهد.
-C: تمام تطابق‌های عبارات باقاعده و رشته‌ها را بدون حساسیت به حروف بزرگ و کوچک (caseless) انجام می‌دهد.
-d: رکوردهای لاگ را در ابتدای لاگ پردازش کرده و خارج می‌شود.
-D: اجرا در پس‌زمینه به صورت دیمن (Daemonize).
-E: تراکنش‌های ESI و انواع دیگر زیردرخواست‌ها (sub-requests) را نمایش می‌دهد. این گزینه مستلزم گزینهٔ -c است و شامل سایر تراکنش‌های کلاینت نیز می‌شود.
-g <session|request|vxid|raw>: گروه‌بندی رکوردهای لاگ. حالت پیش‌فرض گروه‌بندی بر اساس vxid است.
-h: راهنمای استفاده از برنامه را چاپ کرده و خارج می‌شود
-i <taglist>: رکوردهای لاگ دارای این تگ‌ها را در خروجی لحاظ می‌کند. Taglist فهرستی از الگوهای انطباقی (globs) تگ‌ها است که با ویرگول از هم جدا شده‌اند. می‌توان چندین گزینهٔ -i را مشخص کرد.
اگر یک گزینهٔ شمول تگ، نخستین گزینه از میان تمام گزینه‌های انتخاب تگ باشد، تمام تگ‌ها ابتدا مستثنی در نظر گرفته می‌شوند.
-I <[taglist:]regex>: شمول بر اساس تطابق عبارت باقاعده. تنها رکوردهایی را که با taglist و عبارت باقاعده مطابقت دارند در خروجی نمایش می‌دهد. در صورت نبود taglist، بر روی هر تگی اعمال می‌شود. می‌توان چندین گزینهٔ -I را مشخص کرد.
اگر یک گزینهٔ شمول تگ، نخستین گزینه از میان تمام گزینه‌های انتخاب تگ باشد، تمام تگ‌ها ابتدا مستثنی در نظر گرفته می‌شوند.
-k <num>: پیش از خروج، این تعداد از تراکنش‌های لاگ منطبق را پردازش می‌کند.
-L <limit>: حد بالای تراکنش‌های ناقص نگه‌داری‌شده را پیش از آنکه قدیمی‌ترین تراکنش به اجبار تکمیل شود، تعیین می‌کند. هنگام رخ دادن این اتفاق، یک رکورد هشدار تولید می‌شود. این تنظیم سقفی را برای مصرف حافظهٔ پرس‌وجوهای در حال اجرا تعیین می‌کند. مقدار پیش‌فرض ۱۰۰۰ تراکنش است.
-n <workdir>: دایرکتوری کاری vinyl مربوط به نمونه‌ای که قرار است به آن متصل شود را مشخص می‌کند. برای اطلاعات بیشتر و مقادیر پیش‌فرض به مستندات گزینهٔ -n در vinyld(1) مراجعه کنید.
-P <file>: شناسهٔ فرایند (PID) را در فایل مشخص‌شده می‌نویسد.
-Q <file>: فایل حاوی پرس‌وجوی VSL مورد استفاده را مشخص می‌کند. هنگامی که چندین گزینهٔ -Q یا -q مشخص شود، تمام پرس‌وجوها طوری در نظر گرفته می‌شوند که گویی عملگر 'or' برای ترکیب آن‌ها به کار رفته است.
-q <query>: پرس‌وجوی VSL مورد استفاده را مشخص می‌کند. هنگامی که چندین گزینهٔ -q یا -Q مشخص شود، تمام پرس‌وجوها طوری در نظر گرفته می‌شوند که گویی عملگر 'or' برای ترکیب آن‌ها به کار رفته است.
-r <filename>: لاگ را در قالب فایل دودویی از این فایل می‌خواند. این فایل می‌تواند با vinyllog -w filename ایجاد شود. اگر نام فایل - باشد، لاگ‌ها از ورودی استاندارد خوانده می‌شوند و نمی‌تواند به صورت یک دیمن عمل کند.
-R <limit[/duration]>: خروجی را به محدودیت مشخص‌شده محدود می‌کند. تراکنش‌هایی که از این حد فراتر بروند نادیده گرفته خواهند شد. این حد به عنوان حداکثر تعداد تراکنش‌ها (با توجه به روش گروه‌بندی انتخاب‌شده) و یک دورهٔ زمانی اختیاری مشخص می‌شود. اگر هیچ بازهٔ زمانی مشخص نشود، پیش‌فرض s به کار می‌رود. فیلد بازهٔ زمانی می‌تواند مانند VCL قالب‌بندی شود (مثلاً -R 10/2m) یا به صورت یک دوره زمانی ساده بدون پیشوند (مثلاً -R 5/m). در حالت گروه‌بندی -g raw، این تنظیم نمی‌تواند همراه با -i، -I، -x یا -X استفاده شود و پیشنهاد می‌کنیم در عوض از -q استفاده کنید.
-t <seconds|off>: مهلت زمانی پیش از برگرداندن خطا هنگام اتصال اولیه به VSM. در صورت تنظیم شدن، تلاش مجدد برای اتصال VSM هر ۰.۵ ثانیه به مدت این تعداد ثانیه انجام می‌شود. اگر صفر باشد، اتصال تنها یک بار آزمایش می‌شود و در صورت ناموفق بودن، بلافاصله با شکست مواجه می‌شود. در صورتی که روی "off" تنظیم شود، اتصال با شکست مواجه نخواهد شد و به ابزار اجازه می‌دهد شروع به کار کرده و به مدت نامحدود منتظر نمایان شدن نمونهٔ vinyld بماند. مقدار پیش‌فرض ۵ ثانیه است.
-T <seconds>: مهلت زمانی تراکنش را بر حسب ثانیه تنظیم می‌کند. این مقدار حداکثر تعداد ثانیه‌های سپری‌شده بین تگ Begin و تگ End را مشخص می‌کند. در صورت اتمام مهلت زمانی، یک رکورد هشدار تولید شده و تراکنش به اجبار تکمیل می‌شود. مقدار پیش‌فرض ۱۲۰ ثانیه است.
-u: هنگام نوشتن خروجی در یک فایل با گزینهٔ -w، داده‌های خروجی بافر نمی‌شوند. این گزینه بدون گزینهٔ -w هیچ تأثیری ندارد.
-v: استفاده از خروجی پرگو در چاپ مجموعه رکوردها، که مقدار VXID را در هر خط از لاگ درج می‌کند. بدون این گزینه، مقدار VXID تنها در سرآیند آن تراکنش آورده خواهد شد.
-V: اطلاعات نسخه را چاپ کرده و خارج می‌شود.
-w <filename>: تغییر مسیر خروجی به فایل. فایل بازنویسی خواهد شد مگر اینکه گزینهٔ -a مشخص شده باشد. اگر برنامه در حالت دیمن سیگنال SIGHUP را دریافت کند، فایل دوباره باز خواهد شد و اجازه می‌دهد فایل قدیمی چرخش (rotate) یابد. در ادامه این فایل می‌تواند توسط vinyllog و ابزارهای دیگر با گزینهٔ -r خوانده شود، مگر اینکه گزینهٔ -A مشخص شده باشد. این گزینه هنگام اجرا در حالت دیمن الزامی است. اگر نام فایل - باشد، vinyllog در خروجی استاندارد می‌نویسد و نمی‌تواند به عنوان دیمن کار کند.
-x <taglist>: رکوردهای لاگ دارای این تگ‌ها را از خروجی مستثنی می‌کند. Taglist فهرستی از الگوهای انطباقی (globs) تگ‌ها است که با ویرگول از هم جدا شده‌اند. می‌توان چندین گزینهٔ -x را مشخص کرد.
-X <[taglist:]regex>: مستثنی کردن بر اساس تطابق عبارت باقاعده. رکوردهایی که با taglist و عبارت باقاعده مطابقت دارند را در خروجی نمایش نمی‌دهد. در صورت نبود taglist، بر روی هر تگی اعمال می‌شود. می‌توان چندین گزینهٔ -X را مشخص کرد.
--optstring: پارامتر optstring را برای getopt(3) چاپ می‌کند تا به نوشتن اسکریپت‌های پوششی کمک کند.

سیگنال‌ها (SIGNALS)

SIGHUP
فایل لاگ را در حالت دیمن می‌چرخاند (گزینهٔ -w را ببینید)، و هنگام اجرا در پیش‌زمینه، حلقه را لغو کرده و با متانت پایان می‌یابد.
SIGUSR1
تمام تراکنش‌های معلق را تخلیه (flush) می‌کند.

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

تاریخچه (HISTORY)

ابزار vinyllog توسط Poul-Henning Kamp <<phk@phk.freebsd.dk>> با همکاری Verdens Gang AS و Redpill-Linpro توسعه داده شد. این صفحهٔ راهنما ابتدا توسط Dag-Erling Smørgrav نوشته شد و سپس توسط Per Buer و Martin Blix Grydeland به‌روزرسانی گردید.

کپی‌رایت و تکثیر (COPYRIGHT)

این سند تحت همان مجوزی که خود Vinyl Cache دارد منتشر شده است. برای جزئیات به LICENCE مراجعه کنید.