نام (NAME)

logrotate - چرخش، فشرده‌سازی و ارسال لاگ‌های سیستم

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

logrotate [--force] [--debug] [--state file] [--skip-state-lock] [--wait-for-state-lock] [--verbose] [--log file] [--mail command] config_file [config_file2 ...]

توضیحات (DESCRIPTION)

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

به طور معمول، logrotate به عنوان یک وظیفه روزانه cron اجرا می‌شود. این برنامه یک فایل لاگ را بیش از یک بار در روز تغییر نمی‌دهد، مگر اینکه معیار آن لاگ بر اساس اندازه فایل باشد و logrotate بیش از یک بار در روز اجرا شود، یا اینکه از گزینه -f یا --force استفاده شده باشد.

می‌توان هر تعداد فایل پیکربندی را در خط فرمان مشخص کرد. فایل‌های پیکربندی بعدی می‌توانند گزینه‌های مشخص‌شده در فایل‌های پیشین را بازنویسی کنند؛ بنابراین ترتیبی که فایل‌های پیکربندی logrotate در آن فهرست می‌شوند اهمیت دارد. معمولاً باید از یک فایل پیکربندی واحد استفاده شود که سایر فایل‌های پیکربندی مورد نیاز را در بر گیرد (include کند). برای کسب اطلاعات بیشتر درباره نحوه استفاده از دستورالعمل include، به بخش‌های بعدی مراجعه کنید. اگر یک دایرکتوری در خط فرمان مشخص شود، هر فایلی در آن دایرکتوری به عنوان فایل پیکربندی به کار گرفته می‌شود.

اگر هیچ آرگومانی در خط فرمان داده نشود، logrotate اطلاعات نسخه و حق رونوشت (copyright) را به همراه خلاصه‌ای کوتاه از نحوه استفاده نمایش می‌دهد. اگر در حین چرخش لاگ‌ها خطایی رخ دهد، logrotate با وضعیتی غیر از صفر خارج می‌شود، هرچند فایل وضعیت به‌روزرسانی خواهد شد.

گزینه‌ها (OPTIONS)

-f, --force

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

-d, --debug

فعال‌سازی حالت اشکال‌زدایی؛ بدین معنا که هیچ تغییری در لاگ‌ها ایجاد نمی‌شود و فایل وضعیت logrotate به‌روزرسانی نمی‌گردد. فقط پیام‌های اشکال‌زدایی چاپ می‌شوند.

-s, --state statefile

به logrotate می‌گوید از یک فایل وضعیت جایگزین استفاده کند. این گزینه زمانی سودمند است که logrotate با کاربری دیگری برای مجموعه‌های متفاوتی از فایل‌های لاگ اجرا شود. به منظور جلوگیری از اجرای موازی، logrotate به طور پیش‌فرض یک قفل روی فایل وضعیت ایجاد می‌کند؛ اگر دریافت قفل ممکن نباشد، logrotate با مقدار ۳ خارج می‌شود. فایل وضعیت پیش‌فرض /var/lib/logrotate.status است. اگر /dev/null به عنوان فایل وضعیت داده شود، logrotate تلاشی برای قفل کردن یا نوشتن در فایل وضعیت نخواهد کرد.

--skip-state-lock

قفل نکردن فایل وضعیت؛ برای نمونه زمانی که قفل‌گذاری پشتیبانی نمی‌شود یا مجاز نیست.

--wait-for-state-lock

صبر کردن تا زمانی که قفل روی فایل وضعیت توسط یک فرآیند دیگر logrotate آزاد شود. این گزینه ممکن است باعث شود logrotate تا ابد در انتظار بماند. با احتیاط استفاده کنید.

-v, --verbose

فعال کردن حالت پرگو؛ مثلاً برای نمایش پیام‌ها در حین چرخش.

-l, --log file

به logrotate می‌گوید که خروجی پرگو را در file ثبت کند. خروجی پرگوی ثبت‌شده در آن فایل مانند خروجی هنگام اجرای logrotate با سوییچ -v است. این فایل لاگ با هر بار اجرای logrotate بازنویسی می‌شود.

-m, --mail command

به logrotate می‌گوید هنگام ارسال ایمیل لاگ‌ها از چه دستوری استفاده کند. این دستور باید آرگومان‌های زیر را بپذیرد:

۱) موضوع پیام که با '-s subject' داده می‌شود
۲) گیرنده پیام.

سپس دستور باید پیامی را از ورودی استاندارد بخواند و به گیرنده ایمیل کند. دستور پیش‌فرض ارسال ایمیل /usr/bin/mail است.

--usage

پیام کوتاهی درباره نحوه استفاده چاپ می‌کند.

-?, --help

پیام راهنما را نمایش می‌دهد.

--version

نمایش اطلاعات نسخه.

فایل‌های پیکربندی (CONFIGURATION FILE)

logrotate تمام اطلاعات مربوط به فایل‌های لاگی را که باید مدیریت شوند از مجموعه‌ای از فایل‌های پیکربندی ارائه‌شده در خط فرمان می‌خواند. هر فایل پیکربندی می‌تواند گزینه‌های سراسری را تنظیم کند (تعاریف محلی بر تعاریف سراسری اولویت دارند، و تعاریف بعدی تعاریف قبلی را بازنویسی می‌کنند) و فایل‌های لاگ را برای چرخش مشخص نماید. گزینه‌های سراسری بر دستورالعمل‌های include قبلی تأثیری ندارند. یک فایل پیکربندی ساده شبیه به این است:

# sample logrotate configuration file
compress
/var/log/messages {
    rotate 5
    weekly
    postrotate
        /usr/bin/killall -HUP syslogd
    endscript
}
"/var/log/httpd/access.log" /var/log/httpd/error.log {
    rotate 5
    mail recipient@example.org
    size 100k
    sharedscripts
    postrotate
        /usr/bin/killall -HUP httpd
    endscript
}
/var/log/news/* {
    monthly
    rotate 2
    olddir /var/log/news/old
    missingok
    sharedscripts
    postrotate
        kill -HUP $(cat /var/run/inn.pid)
    endscript
    nocompress
}
~/log/*.log {}

چند سطر اول گزینه‌های سراسری را تنظیم می‌کنند؛ در این مثال، لاگ‌ها پس از چرخش فشرده می‌شوند. توجه داشته باشید که توضیحات (کامنت‌ها) می‌توانند در هر کجای فایل پیکربندی قرار گیرند، تا زمانی که اولین نویسه غیرفاصله در سطر یک علامت # باشد.

مقادیر توسط فاصله و/یا یک علامت = اختیاری از دستورالعمل‌ها جدا می‌شوند. اعداد باید در قالبی مشخص شوند که برای strtoul(3) قابل فهم باشد.

بخش بعدی فایل پیکربندی نحوه مدیریت فایل لاگ /var/log/messages را تعریف می‌کند. لاگ قبل از حذف شدن، پنج بار چرخش هفتگی را طی می‌کند. پس از چرخش فایل لاگ (اما قبل از فشرده‌سازی نسخه قدیمی لاگ)، دستور /usr/bin/killall -HUP syslogd اجرا خواهد شد.

بخش بعدی پارامترها را برای هر دو فایل /var/log/httpd/access.log و /var/log/httpd/error.log تعریف می‌کند. هر کدام هر زمان که حجمشان از ۱۰۰ کیلوبایت بیشتر شود چرخانده می‌شوند و فایل‌های لاگ قدیمی پس از گذراندن ۵ چرخش به جای حذف شدن، به صورت فشرده‌نشده به آدرس recipient@example.org ایمیل می‌شوند. گزینه sharedscripts به این معنی است که اسکریپت postrotate تنها یک بار برای این بخش اجرا می‌شود، نه یک بار برای هر لاگی که چرخانده شده است. توجه داشته باشید که نام فایل‌های لاگ می‌تواند در میان علامت نقل‌قول قرار گیرد (و اگر نام شامل فاصله باشد، استفاده از نقل‌قول الزامی است). قوانین معمول نقل‌قول شل اعمال می‌شوند و نویسه‌های '، " و \ پشتیبانی می‌شوند.

بخش بعدی پارامترها را برای تمام فایل‌های موجود در /var/log/news مشخص می‌کند. هر فایل بر اساس یک دوره ماهانه چرخانده می‌شود.

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

لطفاً از نویسه‌های عام با احتیاط استفاده کنید. اگر * را مشخص کنید، logrotate همه فایل‌ها، از جمله فایل‌هایی را که قبلاً چرخانده شده‌اند می‌چرخاند. راهکار این موضوع استفاده از دستورالعمل olddir یا یک نویسه عام دقیق‌تر (مانند ‎*.log‎) است.

لطفاً توجه داشته باشید که به طور پیش‌فرض هنگام استفاده از systemd(1)، گزینه ProtectSystem=full در فایل logrotate.service تنظیم شده است. این امر مانع از دستکاری لاگ‌ها در /etc و /usr توسط logrotate می‌شود.

در اینجا اطلاعات بیشتری در مورد دستورالعمل‌هایی که ممکن است در یک فایل پیکربندی logrotate گنجانده شوند آمده است:

دستورالعمل‌های فایل پیکربندی (CONFIGURATION FILE DIRECTIVES)

این دستورالعمل‌ها ممکن است در یک فایل پیکربندی logrotate گنجانده شوند:

اسکریپت‌ها (SCRIPTS)

سطرهای بین کلیدواژه آغازین (مانند prerotate) و endscript (که هر دو باید به تنهایی در سطرهایی مجزا قرار گیرند) با استفاده از /bin/sh اجرا می‌شوند. اسکریپت برخی از ویژگی‌ها را از فرآیند logrotate به ارث می‌برد، از جمله stderr، stdout، دایرکتوری جاری، متغیرهای محیطی (environment) و ماسک دسترسی (umask). اسکریپت‌ها با کاربر و گروه فراخواننده اجرا می‌شوند، صرف‌نظر از هر دستورالعمل su که ممکن است تعیین شده باشد. اگر سوییچ --log مشخص شده باشد، توصیف‌گر فایل شماره ۳ همان فایل لاگ خواهد بود. دایرکتوری کاری جاری نامشخص است.

کاربر و گروه (USER AND GROUP)

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

فایل‌ها (FILES)

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

chmod(2), gunzip(1), gzip(1), mail(1), shred(1), strftime(3), strtoul(3), https://github.com/logrotate/logrotate

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

Erik Troan, Preston Brown, Jan Kaluza.
<https://github.com/logrotate/logrotate>