'\"macro stdmacro
.\"
.\" Copyright (c) 2013-2019 Red Hat.
.\" Copyright (c) 2000 Silicon Graphics, Inc.  All Rights Reserved.
.\"
.\" This program is free software; you can redistribute it and/or modify it
.\" under the terms of the GNU General Public License as published by the
.\" Free Software Foundation; either version 2 of the License, or (at your
.\" option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful, but
.\" WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
.\" or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
.\" for more details.
.\"
.TH PMLOGGER_CHECK 1 "PCP" "Performance Co-Pilot"
.SH "نام (NAME)"
pmlogger_check \- مدیریت و سرپرستی پرونده‌های بایگانی Performance Co-Pilot
.SH "خلاصه دستور (SYNOPSIS)"
.B $PCP_BINADM_DIR/pmlogger_check
[\f3\-CNnPpqsTV?\f1]
[\f3\-c\f1 \f2control\f1]
[\f3\-l\f1 \f2logfile\f1]
.SH "توضیحات (DESCRIPTION)"
ابزار
.B pmlogger_check
و ابزار مرتبط
.BR pmlogger_daily (1)
به همراه فایل‌های کنترل مربوطه (ببینید
.BR pmlogger.control (5))
می‌توانند برای ایجاد یک سازوکار سفارشی از اداره و مدیریت بایگانی‌های تاریخی داده‌های کارایی در زیرساخت
Performance Co-Pilot
(ببینید
.BR PCPIntro (1))
مورد استفاده قرار گیرند.
.PP
دستور
.B pmlogger_check
می‌تواند در هر زمانی از روز اجرا شود و هدف آن بررسی این است که آیا مجموعه مشخصی از فرآیندهای
.BR pmlogger (1)
در حال اجرا هستند یا خیر.
در صورت اجرا نبودن، فرآیندهای ثبت وقایع گمشده را (مجدداً) راه‌اندازی می‌کند.
به طور پیش‌فرض،
.B pmlogger_check
همچنین
.BR pmlogger_daily (1)
را با گزینه
.B \-K
فراخوانی می‌کند تا وظایف فشرده‌سازی بایگانی مورد نیاز را اجرا نماید.
.SH "گزینه‌ها (OPTIONS)"
.TP 5
\fB\-C\fR
این گزینه باعث می‌شود
.B pmlogger_check
اطلاعات سطح اجرای (runlevel) سرویس سیستم را برای
.BR pmlogger
پرس‌وجو کند و از آن برای تعیین اینکه فرآیندها باید شروع شوند یا خیر، استفاده نماید.
.TP 5
\fB\-c\fR \fIcontrol\fR, \fB\-\-control\fR=\fIcontrol\fR
هر دو ابزار
.B pmlogger_check
و
.BR pmlogger_daily (1)
توسط فایل(های) کنترل لاگر PCP کنترل می‌شوند که نمونه‌های
.B pmlogger
تحت مدیریت را مشخص می‌کند.
فایل کنترل پیش‌فرض
.I $PCP_PMLOGGERCONTROL_PATH
است، اما می‌توان با استفاده از گزینه
.B \-c
فایل دیگری را تعیین کرد.
اگر دایرکتوری
.IR $PCP_PMLOGGERCONTROL_PATH .d
(یا
.IR control .d
از گزینه
.BR \-c )
وجود داشته باشد، محتویات هر فایل کنترل اضافی موجود در آن به انتهای فایل کنترل اصلی (که باید موجود باشد) اضافه خواهد شد.
.TP 5
\fB\-l\fR \fIfile\fR, \fB\-\-logfile\fR=\fIfile\fR
برای اطمینان از اینکه هنگام اجرای این اسکریپت‌ها از طریق
.BR cron (8)
یا
.BR systemd (1)
ایمیلی به طور ناخواسته ارسال نشود، پیام‌های تشخیصی همیشه به فایل‌های لاگ فرستاده می‌شوند.
به طور پیش‌فرض، این فایل
.I $PCP_LOG_DIR/pmlogger/pmlogger_check.log
است، اما می‌توان آن را با استفاده از گزینه
.B \-l
تغییر داد.
اگر این فایل لاگ هنگام شروع اسکریپت از قبل وجود داشته باشد، پیش از تولید اطلاعات تشخیصی در فایل لاگ، با پسوند
.I .prev
تغییر نام خواهد یافت (و هر فایل لاگی که قبلاً ذخیره شده باشد بازنویسی می‌شود).
گزینه‌های
.B \-l
و
.B \-t
نمی‌توانند هم‌زمان استفاده شوند.
.TP 5
\fB\-N\fR, \fB\-\-showme\fR
این گزینه حالت «نمایش اقدامات» (show me) را فعال می‌کند، که در آن اقدامات به سبک «make \-n» چاپ می‌شوند اما اجرا نمی‌گردند.
استفاده از
.B \-N
همراه با
.B \-V
قابلیت‌های تشخیصی را برای اشکال‌زدایی به حداکثر می‌رساند.
.TP 5
\fB\-n\fR, \fB\-\-noerror\fR
وضعیت خروج را به جز در موارد خطاهای فاجعه‌بار اجباراً 0 قرار می‌دهد.
این گزینه هنگام فراخوانی از یک واحد سرویس یا تایمر
.BR systemd (1)
مفید است تا واحد مربوطه طوری به عنوان ناموفق علامت‌گذاری نشود که از اجرای بعدی توسط
.BR systemd (1)
جلوگیری کند.
.TP 5
\fB\-P\fR, \fB\-\-only\-primary\fR
اگر این گزینه برای
.B pmlogger_check
مشخص شود، تنها مدخل لاگر اولیه (primary) در فایل‌های کنترل پردازش خواهد شد.
این گزینه نقطه مقابل منطقی گزینه \fB\-p\fP است
و برای استفاده در اسکریپت‌های RC که فقط لاگر اولیه را راه‌اندازی می‌کنند، مانند واحد
.B pmlogger.service
در نظر گرفته شده است.
گزینه‌های \fB\-p\fP و \fB\-P\fP مانعة‌الجمع هستند.
.TP 5
\fB\-p\fR, \fB\-\-skip\-primary\fR
اگر این گزینه برای
.B pmlogger_check
مشخص شود، هر خط از فایل‌های کنترل برای
.B pmlogger
اصلی
.RI ( primary )
نادیده گرفته خواهد شد.
این گزینه برای محیط‌هایی در نظر گرفته شده است که در آن‌ها یک دیمن سیستمی مانند
.BR systemd (1)
مسئولیت کنترل (شروع، توقف، راه‌اندازی مجدد و غیره)
.B pmlogger
اصلی را بر عهده دارد.
.TP 5
\fB\-q\fR, \fB\-\-quick\fR
اگر این گزینه برای
.B pmlogger_check
مشخص شود، اسکریپت به صورت «شروع سریع» عمل کرده و از هرگونه پردازش اختیاری مانند فراخوانی
.BR pmlogger_daily (1)
برای انجام وظایف فشرده‌سازی بایگانی خودداری می‌کند.
.TP 5
\fB\-s\fR, \fB\-\-stop\fR
استفاده از این گزینه عملکرد معکوس
.B pmlogger_check
را فراهم می‌کند و اجازه می‌دهد مجموعه فرآیندهای
.B pmlogger
به صورت تمیز متوقف شوند.
.TP 5
\fB\-T\fR, \fB\-\-terse\fR
این گزینه در
.B pmlogger_check
خروجی مختصرتری نسبت به حالت پیش‌فرض تولید می‌کند.
این مورد برای «مزرعه» (farm) لاگرهای
.B pmlogger
که در آن انتظار می‌رود نمونه‌های متعددی از
.B pmlogger
در حال اجرا باشند، بسیار مناسب است.
.TP 5
\fB\-V\fR, \fB\-\-verbose\fR
گزینه
.B \-V
ردیابی با جزئیات کامل (verbose) را فعال می‌کند.
به طور پیش‌فرض،
.B pmlogger_check
هیچ خروجی تولید نمی‌کند مگر اینکه با وضعیت خطا یا هشداری مواجه شود.
درج یک
.B \-V
دوم، میزان جزئیات خروجی را افزایش می‌دهد.
استفاده از
.B \-N
همراه با
.B \-V
قابلیت‌های تشخیصی را برای اشکال‌زدایی به حداکثر می‌رساند.
.TP 5
\fB\-?\fR, \fB\-\-help\fR
نمایش پیام راهنمای نحوه استفاده و خروج.
.SH "پیکربندی (CONFIGURATION)"
برای اطلاع از شرح فایل(های) کنترلی که برای تعیین نمونه‌های
.B pmlogger
و بایگانی‌های تحت مدیریت توسط
.B pmlogger_check
و
.BR pmlogger_daily (1)
استفاده می‌شوند، به
.BR pmlogger.control (5)
مراجعه کنید.
.PP
ابزار
.BR pmlogctl (1)
ممکن است
.B pmlogger_check
را با استفاده از دستور
.BR sudo (1)
فراخوانی کند تا آن را تحت حساب کاربری $PCP_USER یعنی «pcp» اجرا نماید.
اگر
.B sudo
با گزینه غیرپیش‌فرض
.I requiretty
پیکربندی شده باشد (پایین را ببینید)، ممکن است
.B pmlogger_check
به دلیل نداشتن tty پیکربندی‌شده اجرا نشود.
این مشکل را می‌توان با افزودن یک خط دوم
(با بسط دادن $PCP_BINADM_DIR متناسب با پلتفرم خود)
به فایل پیکربندی
.I /etc/sudoers
به صورت زیر حل کرد:
.P
.ft CR
.nf
.in +0.5i
Defaults requiretty
Defaults!$PCP_BINADM_DIR/pmlogger_check !requiretty
.in
.fi
.ft 1
.P
توجه داشته باشید که حساب کاربری غیرمجاز (فاقد دسترسی ریشه) PCP که این دستورات تحت آن اجرا می‌شوند، از
.I /sbin/nologin
به عنوان شل استفاده می‌کند؛ بنابراین گزینه
.I requiretty
در اینجا بی‌اثر است و غیرفعال کردن آن به این شیوه ایمن می‌باشد.
.SH "فایل‌ها (FILES)"
.TP 5
.I $PCP_VAR_DIR/config/pmlogger/config.default
محل پیش‌فرض فایل پیکربندی
.B pmlogger
برای لاگر اصلی محلی، که معمولاً به طور خودکار توسط
.BR pmlogconf (1)
تولید می‌شود.
.TP 5
.I $PCP_ARCHIVE_DIR/<hostname>
محل پیش‌فرض بایگانی‌های اطلاعات کارایی جمع‌آوری‌شده از میزبان
.I hostname
.TP 5
.I $PCP_ARCHIVE_DIR/<hostname>/lock
فایل قفل موقت برای تضمین انحصار متقابل در طول مدیریت
.B pmlogger
برای میزبان
.I hostname
\- در صورت وجود، چنانچه هیچ‌یک از ابزارهای
.BR pmlogger_daily (1)
یا
.B pmlogger_check
در حال اجرا نباشند، می‌توان آن را با خیال راحت حذف کرد.
.TP 5
.I $PCP_ARCHIVE_DIR/<hostname>/Latest
برگه‌دان (folio) بایگانی PCP ایجاد شده توسط
.BR mkaf (1)
برای جدیدترین بایگانی راه‌اندازی‌شده حاوی معیارهای کارایی از میزبان
.I hostname
.TP 5
.I $PCP_LOG_DIR/NOTICES
فایل «اعلان‌ها» (notices) PCP مورد استفاده توسط
.BR pmie (1)
و ابزارهای مرتبط.
.TP 5
.I $PCP_LOG_DIR/pmlogger/pmlogger_check.log
اگر اجرای قبلی
.B pmlogger_check
خروجی‌ای تولید کرده باشد، در اینجا ذخیره می‌شود.
حالت عادی عدم تولید خروجی است که در این صورت این فایل وجود نخواهد داشت.
.TP 5
.I $PCP_ARCHIVE_DIR/SaveLogs
اگر این دایرکتوری وجود داشته باشد، فایل لاگ ناشی از آرگومان
.B \-l
برای
.B pmlogger_check
در این دایرکتوری با قالبی با نام
<date>-\fBpmlogger_check\fP.\fBlog\fP.<pid>
ذخیره خواهد شد.
این امر امکان بازبینی فایل لاگ را در زمانی دیگر فراهم می‌کند، حتی اگر در این فاصله چندین بار
.B pmlogger_check
اجرا شده باشد.
از آنجا که ابزارهای مدیریت بایگانی PCP تحت حساب کاربری $PCP_USER یعنی «pcp» اجرا می‌شوند،
.I $PCP_ARCHIVE_DIR/SaveLogs
معمولاً باید متعلق به کاربر «pcp» باشد.
.TP 6
.I $PCP_ARCHIVE_DIR/<hostname>/SaveLogs
اگر این دایرکتوری وجود داشته باشد، فایل لاگ مربوط به آرگومان
.B \-l
یک
.BR pmlogger (1)
تازه‌راه‌اندازی‌شده برای
.I hostname
در این دایرکتوری با نام
.IB archive .log
ذخیره خواهد شد، که در آن
.I archive
نام پایه (basename) پرونده‌های بایگانی PCP مرتبط با
.BR pmlogger (1)
است.
این قابلیت امکان بازبینی فایل لاگ را در زمانی دیگر فراهم می‌آورد، حتی اگر در این فاصله چندین نمونه از
.BR pmlogger (1)
برای
.I hostname
راه‌اندازی شده باشد.
از آنجا که ابزارهای مدیریت بایگانی PCP تحت حساب کاربری $PCP_USER یعنی «pcp» اجرا می‌شوند،
.I $PCP_ARCHIVE_DIR/<hostname>/SaveLogs
معمولاً باید متعلق به کاربر «pcp» باشد.
.SH "محیط PCP (PCP ENVIRONMENT)"
متغیرهای محیطی با پیشوند \fBPCP_\fP برای پارامتریزه کردن نام فایل‌ها و دایرکتوری‌های مورد استفاده PCP به کار می‌روند.
در هر نصب، فایل \fI/etc/pcp.conf\fP حاوی مقادیر محلی برای این متغیرها است.
همان‌طور که در \fBpcp.conf\fP(5) توضیح داده شده است، متغیر \fB$PCP_CONF\fP می‌تواند برای مشخص کردن یک فایل پیکربندی جایگزین استفاده شود.
.PP
رفتار پیش‌فرض، هنگامی که پیکربندی
.BR pmlogger (1)
از
.BR pmlogconf (1)
ناشی می‌شود، این است که هر زمان
.BR pmlogger (1)
از طریق
.B pmlogger_check
شروع شود، فایل پیکربندی مجدداً تولید شده و تغییرات بررسی گردد.
اگر پیکربندی PMDA پایدار است، این کار الزامی نیست و تنظیم
.B $PMLOGGER_CHECK_SKIP_LOGCONF
روی
.B yes
عملیات تولید مجدد و بررسی را غیرفعال می‌کند.
.SH "همچنین ببینید (SEE ALSO)"
.BR mkaf (1),
.BR PCPIntro (1),
.BR pmie (1),
.BR pmlc (1),
.BR pmlogconf (1),
.BR pmlogctl (1),
.BR pmlogger (1),
.BR pmlogger_daily (1),
.BR pmlogger_daily_report (1),
.BR pmlogger_janitor (1),
.BR sudo (1),
.BR systemd (1),
.BR pmlogger.control (5)
و
.BR cron (8).

.\" control lines for scripts/man-spell
.\" +ok+ RC SaveLogs nologin prev {from .prev suffix} quickstart
.\" +ok+ requiretty runlevel sudoers