نام (NAME)

logrotate.conf - فایل پیکربندی ابزار مدیریت و چرخش لاگهای سیستم

توضیحات (DESCRIPTION)

فایل logrotate.conf شامل دستورالعملها و قواعدی است که نحوه بایگانی، فشردهسازی و پاکسازی خودکار فایلهای لاگ در سیستم لینوکس را تعیین میکند.

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

# نمونه فایل پیکربندی logrotate
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 را تعریف می‌کند. هر فایل به صورت ماهانه چرخانده می‌شود.

بخش پایانی از بسط تیلدا (tilde expansion) برای چرخش فایلهای لاگ در پوشه خانگی کاربر جاری استفاده می‌کند. این ویژگی تنها در صورتی فعال است که کتابخانه glob سیستم از بسط تیلدا پشتیبانی کند (مانند GNU glob).

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

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

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

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

بخش اسکریپتها (SCRIPTS)

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

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

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

فایلها (FILES)

/var/lib/logrotate/status

فایل وضعیت پیش‌فرض برای نگهداری زمان آخرین چرخش لاگ‌ها.

/etc/logrotate.conf

فایل اصلی پیکربندی و گزینه‌های سراسری.

/etc/logrotate.d/

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

همچنین ببینید (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>