PMLOGGER_JANITOR(1) General Commands Manual PMLOGGER_JANITOR(1)

pmlogger_janitor - ابزار کمکی مدیریت برای فایل‌های بایگانی Performance Co-Pilot

$PCP_BINADM_DIR/pmlogger_janitor [-NV?] [-c control] [-l logfile] [-X program] [-Y regex]

به‌طور معمول pmlogger_janitor مستقیماً استفاده نمی‌شود، بلکه از طریق pmlogger_check(1) فراخوانی می‌شود تا هرگونه فرآیند و فایل وضعیت باقی‌مانده و مربوط به نمونه‌های از کار افتاده یا در حال مرگ pmlogger(1) را پاکسازی کند.

اگر pmlogger_janitor به صورت مستقیم اجرا شود، باید به عنوان کاربر $PCP_USER اجرا گردد؛ تنها استثنا زمانی است که از گزینهٔ -N استفاده شود.

همانند pmlogger_check (1) و pmlogger_daily(1)، ابزار pmlogger_janitor توسط فایل(های) کنترلی ثبت‌کنندهٔ PCP که نمونه‌های pmlogger مورد نظر برای مدیریت را مشخص می‌کنند، کنترل می‌شود. فایل control پیش‌فرض $PCP_PMLOGGERCONTROL_PATH است، اما می‌توان با استفاده از گزینهٔ -c یک فایل جایگزین مشخص کرد. اگر دایرکتوری $PCP_PMLOGGERCONTROL_PATH.d (یا control.d از گزینهٔ -c) وجود داشته باشد، محتوای هر فایل control اضافی موجود در آن به انتهای فایل کنترلی اصلی (که وجود آن الزامی است) پیوست خواهد شد.
به منظور اطمینان از اینکه هنگام اجرای این اسکریپت از cron(8) یا systemd(1) پیامی ناخواسته از طریق ایمیل فرستاده نمی‌شود، پیام‌های عیب‌یابی همواره به فایل‌های لاگ ارسال می‌شوند. به صورت پیش‌فرض، این فایل $PCP_LOG_DIR/pmlogger/pmlogger_janitor.log است، اما این مسیر را می‌توان با استفاده از گزینهٔ -l تغییر داد. اگر این file لاگ هنگام شروع اسکریپت از قبل وجود داشته باشد، پیش از تولید پیام‌های عیب‌یابی جدید در آن، نامش با پسوند .prev تغییر داده می‌شود (و هر فایل لاگی که قبلاً ذخیره شده باشد رونویسی خواهد شد).
این گزینه حالت «به من نشان بده» (``show me'') را فعال می‌کند که در آن اقدامات به سبک ``make -n'' نمایش داده می‌شوند اما اجرا نمی‌گردند. استفاده از -N به همراه -V قابلیت‌های تشخیصی را برای اشکال‌زدایی به بیشترین حد ممکن می‌رساند.
گزینهٔ -V ردیابی با جزئیات کامل (verbose) را فعال می‌کند. به‌طور پیش‌فرض pmlogger_janitor هیچ خروجی تولید نمی‌کند مگر اینکه با وضعیت خطا یا هشداری مواجه شود. استفاده از -V دوم، میزان جزئیات خروجی را افزایش می‌دهد. استفاده از -N همراه با -V قابلیت‌های تشخیصی را برای اشکال‌زدایی به حداکثر می‌رساند.
این گزینه برنامه‌ای را که باید برای فشرده‌سازی استفاده شود تعیین می‌کند. برای جزئیات به pmlogger_daily(1) مراجعه کنید.
این گزینه امکان تعیین یک عبارت منظم را فراهم می‌کند تا فایل‌های منطبق از مجموعه فایل‌های انتخاب‌شده برای فشرده‌سازی حذف و نادیده گرفته شوند. برای جزئیات به pmlogger_daily(1) مراجعه کنید.
-?, --help
نمایش پیام راهنمای نحوه استفاده و خروج.

pmlogger_janitor در چندین گذر (pass) به دنبال مواردی برای پاکسازی عمل می‌کند.

گذر ۱ (Pass 1)
بررسی فایل‌های نگاشت درگاه (port map) متعلق به pmlogger در دایرکتوری $PCP_TMP_DIR/pmlogger. شناسه فرآیند (PID) برگرفته از نام فایل نگاشت درگاه و ps(1) برای بررسی این موضوع که آیا فرآیند وجود دارد و «شبیه به» یک pmlogger فعال به نظر می‌رسد یا خیر استفاده می‌شوند؛ اگر چنین باشد، PID و دایرکتوری محل نوشتن بایگانی (استخراج‌شده از فایل نگاشت درگاه) به فهرست موارد مورد نظر افزوده می‌شوند، در غیر این صورت فرض می‌شود که فایل نگاشت درگاه مربوط به یک pmlogger است که خارج شده و فایل نگاشت درگاه حذف می‌شود.
گذر ۲ (Pass 2)
استفاده از ps(1) برای پیمایش تمامی فرآیندها و شناسایی هر نمونهٔ pmlogger که توسط pmlogger_check(3) یا pmlogger_daily(3) شروع شده باشد؛ این نمونه‌ها دارای گزینهٔ متمایزکنندهٔ -m در آرگومان‌های خود هستند. شناسه‌های PID و دایرکتوری‌های محل نوشتن بایگانی (استخراج‌شده از آرگومان‌های خط فرمان) به فهرست موارد مورد نظر اضافه می‌شوند.
گذر ۳ (Pass 3)
تجزیه و بررسی تمامی فایل‌های pmlogger.control(5) چه از مکان‌های استاندارد و چه از control در صورت استفاده از گزینهٔ -c. هر نمونه از pmlogger باید در فهرست موارد مورد نظر باشد، و در صورت وجود از آن فهرست حذف می‌گردد.

اگر در انتهای این گذر فهرست موارد مورد نظر خالی باشد، عملیات پایان یافته است.

گذر ۴ (Pass 4)
هر فرآیندی که در فهرست موارد مورد نظر باقی مانده باشد، نمونه‌ای از pmlogger است که در حال اجراست اما نباید باشد؛ که احتمالاً در نتیجهٔ تغییری در فایل‌های pmlogger.control(5) رخ داده است. به هر فرآیند یک سیگنال SIGTERM ارسال می‌شود.
گذر ۵ (Pass 5)
برای هر فرآیندی که پس از گذر ۳ (Pass 3) در فهرست موارد مورد نظر باقی مانده است، تمام بایگانی‌های موجود در دایرکتوری‌ای که pmlogger در آن می‌نوشت، فشرده‌سازی می‌شوند. این تنها مرحله‌ای است که ممکن است گزینه‌های -X و -Y در آن استفاده شوند.
گذر ۶ (Pass 6)
برای هر pmlogger که در گذر ۴ (Pass 4) به آن سیگنال SIGTERM ارسال شده است، بررسی می‌شود که آیا خاتمه یافته است یا خیر، و در غیر این صورت به آن سیگنال SIGKILL ارسال می‌شود.

$PCP_LOG_DIR/pmlogger/pmlogger_janitor.log
اگر اجرای قبلی pmlogger_janitor خروجی‌ای تولید کرده باشد، در اینجا ذخیره می‌شود. حالت عادی بدون خروجی است که در این حالت فایل وجود نخواهد داشت.
$PCP_ARCHIVE_DIR/SaveLogs
اگر این دایرکتوری وجود داشته باشد، فایل لاگ حاصل از آرگومان -l برای pmlogger_janitor با قالبی به نام <date>-pmlogger_janitor.log.<pid> در این دایرکتوری ذخیره خواهد شد. این قابلیت اجازه می‌دهد که فایل لاگ در زمان دیگری بررسی شود، حتی اگر در این فاصله چندین بار pmlogger_janitor اجرا شده باشد. دایرکتوری $PCP_ARCHIVE_DIR/SaveLogs باید متعلق به کاربر $PCP_USER باشد.
$PCP_TMP_DIR/pmlogger
ابزار pmlogger فایل‌های این دایرکتوری را به عنوان نگاشت درگاه (port map) میان موارد زیر نگهداری می‌کند: PID نمونهٔ pmlogger، درگاه IPC که ممکن است برای کنترل هر نمونهٔ pmlogger استفاده شود (همان‌طور که توسط pmlc(1) به کار می‌رود)، نام میزبانی که در آن pmcd(1) معیارها را برای pmlogger ارائه می‌دهد، رشتهٔ اتصال از راه دور برای سرور HTTP راه دور که داده‌های ثبت‌شده را دریافت می‌کند یا مسیر کامل به نام پایهٔ بایگانی برای یک ثبت‌کنندهٔ محلی و هرگونه یادداشت از گزینه‌های -m یا -x؛ تمامی این اطلاعات همچنین از طریق معیارهای pmcd.pmlogger.* نیز در دسترس هستند، مانند: $ pminfo -f pmcd.pmlogger

متغیرهای محیطی با پیشوند PCP_ برای مقداردهی و پارامتریک کردن نام فایل‌ها و دایرکتوری‌های مورد استفادهٔ PCP به کار می‌روند. در هر نصب، فایل /etc/pcp.conf حاوی مقادیر محلی برای این متغیرها است. متغیر $PCP_CONF ممکن است برای تعیین یک فایل پیکربندی جایگزین استفاده شود، همان‌طور که در pcp.conf(5) شرح داده شده است.

PCPIntro(1)، pmcd(1)، pmlc(1)، pmlogctl(1)، pmlogger(1)، pmlogger_check(1)، pmlogger_daily(1)، ps(1)، systemd(1)، pmlogger.control(5) و cron(8).

PCP Performance Co-Pilot