'\"macro stdmacro
.\"
.\" Copyright (c) 2013-2016,2019 Red Hat.
.\" Copyright (c) 2000-2004 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 PMIE_CHECK 1 "PCP" "Performance Co-Pilot"
.SH "نام (NAME)"
\f3pmie_check\f1,
\f3pmie_daily\f1 \- مدیریت موتور استنتاج Performance Co-Pilot
.SH "خلاصه دستور (SYNOPSIS)"
.B $PCP_BINADM_DIR/pmie_check
[\f3\-CNPpsTV?\f1]
[\f3\-c\f1 \f2control\f1]
[\f3\-l\f1 \f2logfile\f1]
.br
.B $PCP_BINADM_DIR/pmie_daily
[\f3\-NV?\f1]
[\f3\-c\f1 \f2control\f1]
[\f3\-k\f1 \f2discard\f1]
[\f3\-l\f1 \f2logfile\f1]
[\f3\-m\f1 \f2addresses\f1]
[\f3\-x\f1 \f2compress\f1]
[\f3\-X\f1 \f2program\f1]
[\f3\-Y\f1 \f2regex\f1]
.SH "توضیحات (DESCRIPTION)"
این مجموعه از اسکریپت‌های شل و فایل‌های کنترلی مرتبط را می‌توان برای ایجاد یک شیوه مدیریتی و اجرایی سفارشی برای موتور استنتاج Performance Co-Pilot (ببینید
.BR PCPIntro (1))
، یعنی
.BR pmie (1)
به‌کار برد.
.PP
دستور
.B pmie_check
می‌تواند در هر زمانی از شبانه‌روز اجرا شود و بررسی می‌کند که آیا مجموعه مورد نظری از فرایندهای
.B pmie
در حال اجرا هستند یا خیر.
در غیر این صورت، هر فرایند مفقود موتور استنتاج را اجرا (یا راه‌اندازی مجدد) می‌کند.
.PP
دستور
.B pmie_daily
برای اجرا یک بار در روز، ترجیحاً در اوایل صبح و در اسرع وقت پس از نیمه‌شب در نظر گرفته شده است.
وظیفه آن چرخش (rotate) فایل‌های لاگ برای فرایندهای در حال اجرای
.B pmie
است \- این فایل‌ها در صورتی که عمل
\&``print''
استفاده شود، یا هر عمل دیگری از
.B pmie
در جریان‌های stdout/stderr خود بنویسد، ممکن است به‌طور نامحدود رشد کنند.
پس از گذشت مدتی، فایل‌های لاگ قدیمی
.B pmie
دور ریخته (حذف) می‌شوند.
.SH "گزینه‌ها (OPTIONS)"
گزینه‌های خط فرمان موجود عبارتند از:
.TP 5
\fB\-c\fR \fIcontrol\fR, \fB\-\-control\fR=\fIcontrol\fR
هر دو دستور
.B pmie_check
و
.B pmie_daily
توسط فایل(های) کنترلی موتور استنتاج PCP کنترل می‌شوند که نمونه‌های
.B pmie
تحت مدیریت را مشخص می‌کنند.
فایل
.I control
پیش‌فرض
.B $PCP_PMIECONTROL_PATH
است اما می‌توان یک فایل جایگزین را با استفاده از گزینه
.BR \-c
مشخص کرد.
اگر دایرکتوری
.BR $PCP_PMLOGGERCONTROL_PATH .d
(یا
.IR control .d
از گزینه
.BR \-c )
وجود داشته باشد، محتوای هر فایل
.I control
اضافی درون آن به انتهای فایل کنترل اصلی (که باید وجود داشته باشد) اضافه خواهد شد.
.TP
\fB\-C\fR
این گزینه باعث می‌شود
.B pmie_check
اطلاعات سطح اجرای (runlevel) سرویس سیستمی را برای
.B pmie
پرس‌وجو کرده و از آن برای تعیین اینکه آیا فرایندها شروع شوند یا خیر استفاده کند.
.TP
\fB\-k\fR \fIperiod\fR, \fB\-\-discard\fR=\fIperiod\fR
دوره نگهداری لاگ (
.IR period )
به‌طور پیش‌فرض ۱۴ روز است، اما می‌توان با استفاده از این گزینه آن را تغییر داد.
دو مقدار ویژه برای
.I period
حذف شناخته می‌شود؛ یعنی
.B 0
برای نگهداری نکردن از هیچ فایل لاگی فراتر از لاگ فعلی، و
.B forever
برای جلوگیری از دور ریختن (حذف) هرگونه فایل لاگ.
.TP
\fB\-l\fR \fIfile\fR, \fB\-\-logfile\fR=\fIfile\fR
به منظور اطمینان از اینکه هنگام اجرای این اسکریپت‌ها از طریق
.BR cron (8)
ایمیلی به‌طور ناخواسته ارسال نشود، اطلاعات تشخیصی همیشه به فایل‌های لاگ ارسال می‌شوند.
به‌طور پیش‌فرض، این فایل‌ها
.B $PCP_LOG_DIR/pmie/pmie_daily.log
و
.B $PCP_LOG_DIR/pmie/pmie_check.log
هستند، اما می‌توان این را با استفاده از گزینه
.B \-l
تغییر داد.
اگر این
.I file
لاگ هنگام شروع اسکریپت از قبل وجود داشته باشد، پیش از اینکه اطلاعات تشخیصی در فایل لاگ جدید ثبت شوند، با پسوند
.I .prev
تغییر نام داده می‌شود (و هر فایل لاگی را که قبلاً ذخیره شده باشد بازنویسی می‌کند).
.TP
\fB\-m\fR \fIaddresses\fR, \fB\-\-mail\fR=\fIaddresses\fR
استفاده از این گزینه باعث می‌شود
.B pmie_daily
خلاصه‌ای از فایل‌های لاگ ایجاد شده برای همه میزبان‌های تحت نظارت را در ۲۴ ساعت گذشته تولید کند (خطوط منطبق بر \&`` OK '' حذف می‌شوند)، و آن خلاصه را به مجموعه‌ای از
.I addresses
که با فاصله از هم جدا شده‌اند ایمیل کند.
.TP
\fB\-N\fR, \fB\-\-showme\fR
این گزینه یک حالت \&``show me'' (نمایشی) را فعال می‌کند، که در آن اقدامات برنامه بدون اجرا شدن و به سبک \&``make \-n'' نمایش داده می‌شوند.
استفاده از
.B \-N
به همراه
.B \-V
قابلیت‌های تشخیصی را برای اشکال‌زدایی به حداکثر می‌رساند.
.TP
\fB\-s\fR, \fB\-\-stop\fR
استفاده از این گزینه عملکرد معکوس
.B pmie_check
را ارائه می‌دهد، و امکان متوقف کردن مرتب و تمیز مجموعه فرایندهای
.B pmie
را فراهم می‌کند.
.TP
\fB\-p\fR, \fB\-\-skip\-primary\fR
اگر این گزینه برای
.B pmie_check
مشخص شده باشد، هر خطی از فایل‌های کنترل برای
.I primary
.B pmie
نادیده گرفته خواهد شد.
این گزینه برای محیط‌هایی در نظر گرفته شده که در آن یک دیمن سیستمی، مانند
.BR systemd (1)،
مسئول کنترل (شروع، توقف، راه‌اندازی مجدد، و غیره)
.I primary
.BR pmie
است.
.TP
\fB\-P\fR, \fB\-\-only\-primary\fR
اگر این گزینه برای
.B pmie_check
مشخص شده باشد، تنها مدخل pmie اصلی (primary) در فایل‌های کنترل پردازش خواهد شد.
این گزینه از نظر منطقی برعکس گزینه \fB\-p\fP شرح‌داده‌شده در بالا است
و برای استفاده توسط اسکریپت‌های RC که فقط pmie اصلی را اجرا می‌کنند، مانند واحد
.B pmie.service
در نظر گرفته شده است.
گزینه‌های \fB\-p\fP و \fB\-P\fP برای \fBpmie_check\fP مانعة‌الجمع هستند.
.TP
\fB\-T\fR, \fB\-\-terse\fR
این گزینه برای
.B pmie_check
خروجی مختصرتری نسبت به حالت پیش‌فرض تولید می‌کند.
این گزینه برای یک
.I pmie
\&``farm'' که در آن انتظار می‌رود نمونه‌های زیادی از
.I pmie
در حال اجرا باشند، بسیار مناسب است.
.TP
\fB\-V\fR, \fB\-\-verbose\fR
خروجی حاصل از اجرای اسکریپت‌ها توسط
.BR cron
می‌تواند با استفاده از گزینه
.B \-V
گسترش یابد که ردیابی پرجزئیات فعالیت آن‌ها را فعال می‌کند.
به‌طور پیش‌فرض، اسکریپت‌ها هیچ خروجی تولید نمی‌کنند مگر اینکه با شرایط خطا یا هشدار مواجه شوند.
استفاده از
.B \-N
به همراه
.B \-V
قابلیت‌های تشخیصی را برای اشکال‌زدایی به حداکثر می‌رساند.
.TP
\fB\-x\fR \fIperiod\fR, \fB\-\-compress\-after\fR=\fIperiod\fR
فایل‌های لاگ را می‌توان اختیاری پس از گذشت یک
.I period
(دوره زمانی) فشرده کرد تا فضای دیسک حفظ شود.
این امر به ویژه برای تعداد زیادی از فرایندهای
.B pmie
تحت کنترل
.B pmie_check
مفید است.
گزینه
.B \-x
تعداد روزهایی را مشخص می‌کند که پس از آن، فایل‌های داده بایگانی باید فشرده شوند..TP
\fB\-X\fR \fIprogram\fR, \fB\-\-compressor\fR=\fIprogram\fR
این گزینه برنامه‌ی مورد استفاده برای فشرده‌سازی را مشخص می‌کند \- که به‌طور پیش‌فرض
.BR xz (1)
است.
.TP
\fB\-Y\fR \fIregex\fR, \fB\-\-regex\fR=\fIregex\fR
این گزینه امکان تعیین یک عبارت باقاعده را فراهم می‌کند که باعث نادیده گرفتن فایل‌هایی از مجموعه‌ی فایل‌های منطبق‌شده برای فشرده‌سازی می‌شود \- این کار اجازه می‌دهد فقط فایل داده فشرده شود، و همچنین از تلاش مجدد برنامه برای فشرده‌سازی آن جلوگیری می‌کند.
مقدار پیش‌فرض
.I regex
برابر است با
.br
"\e.(meta|index|Z|gz|bz2|zip|xz|lzma|lzo|lz4|zst)$"
.br
\- چنین فایل‌هایی با استفاده از گزینهٔ
.B \-v
در
.BR egrep (1)
فیلتر می‌شوند.
.TP
\fB\-?\fR, \fB\-\-help\fR
نمایش پیام راهنمای استفاده و خروج.
.SH "پیکربندی (CONFIGURATION)"
.BR هشدار :
فایل‌های
.B $PCP_PMIECONTROL_PATH
و
.BR $PCP_PMIECONTROL_PATH .d
نباید توسط هیچ کاربری به جز root قابل نوشتن باشند.
.PP
فایل(های) کنترلی باید بر اساس قوانین زیر که برای نسخه کنونی (1.1) قالب فایل کنترلی تعریف شده‌اند، سفارشی‌سازی شوند.
.IP 1. 4m
خطوطی که با «#» آغاز می‌شوند، توضیحات (کامنت) هستند.
.PD 0
.IP 2.
خطوطی که با «$» آغاز می‌شوند، به عنوان مقداردهی به متغیرهای محیطی به سبک
.BR sh (1)
در نظر گرفته می‌شوند، و تمام متن پس از «$» توسط اسکریپتی که فایل کنترلی را می‌خواند
.BR eval
می‌شود، و متغیر مربوطه به محیط صادر (export) می‌گردد.
این قابلیت به‌ویژه برای تنظیم و صادر کردن متغیرها به محیط اسکریپت مدیریتی مفید است، به عنوان مثال:
.br
.in +4n
.ft CR
.nf
$ PMCD_CONNECT_TIMEOUT=20
.fi
.ft R
.in -4n
.IP 3.
در فایل کنترلی اولیه
.B باید
یک خط نسخه به شکل زیر وجود داشته باشد:
.br
.in +4n
.ft CR
.nf
$ version=1.1
.fi
.ft R
.in -4n
.IP 4.
در فایل(های) کنترلی باید برای هر نمونه از
.B pmie
یک خط به فرم زیر وجود داشته باشد:

.in +4n
.ft CR
.nf
\f2host\f1 \f3y\f1|\f3n\f1 \f3y\f1|\f3n\f1 \f2logfile\f1 \f2args\f1
.fi
.ft R
.in -4n

.IP 5.
فیلدهای درون یک خط از فایل(های) کنترلی با یک یا چند فاصله یا تب از یکدیگر جدا می‌شوند.
.IP 6.
فیلد
.I اول
نام میزبانی است که منبع پیش‌فرض سنجه‌های عملکردی برای این نمونه‌ی
.B pmie
می‌باشد.
.IP 7.
فیلد
.I دوم
نشان می‌دهد که آیا این یک نمونه‌ی
.I اصلی
(primary) از
.B pmie
است (\c
.BR y )
یا خیر (\c
.BR n ).
از آنجا که موتور استنتاج اصلی باید روی میزبان محلی اجرا شود، و برای یک میزبان مشخص حداکثر می‌تواند یک نمونه‌ی اصلی وجود داشته باشد، این فیلد حداکثر برای یک نمونه از
.B pmie
می‌تواند
.B y
باشد، که در این حالت نام میزبان باید نام میزبان محلی باشد.
هنگام تولید فایل‌های پیکربندی
.BR pmie ،
بند primary نشان می‌دهد که
.BR pmieconf (1)
باید علاوه‌بر تمام قوانین پیش‌فرض دیگر، کلیه قوانین گروه primary را نیز فعال کند.
.IP 8.
فیلد
.I سوم
مشخص می‌کند که آیا این نمونه‌ی
.B pmie
نیاز دارد تحت کنترل
.BR pmsocks (1)
راه‌اندازی شود تا بتواند از میان یک دیواره‌آتش به یک
.B pmcd
متصل گردد (\c
.B y
یا
.BR n ).
.IP 9.
فیلد
.I چهارم
نام فایل گزارش فعالیت (activity log) مربوط به
.B pmie
است.
یک قرارداد سودمند این است که نمونه‌های
.B pmie
ناظر بر میزبان محلی با نام میزبان
.I myhost
در دایرکتوری
.BI $PCP_LOG_DIR/pmie/ myhost\fR
نگهداری شوند، در حالی که گزارش‌های فعالیت برای میزبان راه دور
.I mumble
در
.BI $PCP_LOG_DIR/pmie/ mumble\fR
نگهداری می‌گردند.
این سازگار با روشی است که
.BR pmlogger (1)
گزارش‌های فعالیت و فایل‌های بایگانی خود را مدیریت می‌کند.
.IP 10.
تمام فیلدهای دیگر به عنوان آرگومان‌هایی تفسیر می‌شوند که باید به
.BR pmie (1)
پاس داده شوند.
به‌طور معمول این آرگومان گزینهٔ
.B \-c
خواهد بود.
.PD
.PP
خطوط کنترلی نمونهٔ زیر یک نمونه‌ی
.B pmie
را مشخص می‌کنند که میزبان محلی (\c
.IR wobbly )
را پایش می‌کند، و نمونه‌ای دیگر سنجه‌های عملکردی را از میزبان
.IR splat
نظارت می‌نماید.
.PP
.nf
.ft CR
wobbly  n  PCP_LOG_DIR/pmie/wobbly  \-c config.default
splat   n  PCP_LOG_DIR/pmie/splat   \-c splat/cpu.conf
.ft 1
.fi
.PP
مدخل‌های معمول
.BR crontab (5)
برای اجرای دوره‌ای
.B pmie_daily
و
.B pmie_check
در
.BR $PCP_SYSCONF_DIR/pmie/crontab
ارائه شده‌اند (مگر اینکه پیش‌تر به‌طور پیش‌فرض در
.IR /etc/cron.d
نصب شده باشند)
و در زیر نشان داده شده‌اند.
.PP
.nf
.ft CR
# daily processing of pmie logs
08      0       *       *       *       $PCP_BINADM_DIR/pmie_daily
# every 30 minutes, check pmie instances are running
28,58   *       *       *       *       $PCP_BINADM_DIR/pmie_check
.ft 1
.fi
هنگام استفاده از
.BR systemd (1)
در لینوکس، نیازی به مدخل‌های
.B crontab
نیست چرا که به‌جای آن از سازوکار تایمر ارائه‌شده توسط
.B systemd
استفاده می‌شود..PP
ابزار
.BR pmiectl (1)
ممکن است
.B pmie_check
را با استفاده از دستور
.BR sudo (1)
فراخوانی کند تا آن را تحت حساب کاربری
$PCP_USER
«pcp»
اجرا نماید.
اگر
.B sudo
با گزینهٔ غیرپیش‌فرض
.I requiretty
پیکربندی شده باشد (پایین را ببینید)، ممکن است
.B pmie_check
به دلیل نداشتن یک tty پیکربندی‌شده در اجرا با شکست مواجه شود.
این مشکل می‌تواند با افزودن یک سطر دوم
(مقدار $PCP_BINADM_DIR را بر اساس پلتفرم خود بسط دهید)
به فایل پیکربندی
.I /etc/sudoers
به صورت زیر برطرف شود:
.P
.ft CR
.nf
.in +0.5i
Defaults requiretty
Defaults!$PCP_BINADM_DIR/pmie_check !requiretty
.in
.fi
.ft 1
.P
توجه داشته باشید که حساب کاربری غیرممتاز PCP که این دستورها تحت آن اجرا می‌شوند، از
.I /sbin/nologin
به عنوان شل استفاده می‌کند؛ بنابراین گزینهٔ
.I requiretty
در اینجا بی‌اثر بوده و غیرفعال کردن آن به این شیوه ایمن است.
.SH "فایل‌ها (FILES)"
.TP 5
.I $PCP_PMIECONTROL_PATH
فایل کنترل پیش‌فرض موتور استنتاج PCP
.br
.BR هشدار :
این فایل نباید توسط هیچ کاربری غیر از root قابل نوشتن باشد.
.TP
.I $PCP_PMIECONTROL_PATH.d
دایرکتوری اختیاری حاوی فایل‌های کنترل تکمیلی موتور استنتاج PCP، معمولاً یک فایل به ازای هر میزبان
.br
.BR هشدار :
فایل‌های موجود در این دایرکتوری نباید توسط هیچ کاربری غیر از root قابل نوشتن باشند.
.TP
.I $PCP_SYSCONF_DIR/pmie/crontab
نمونه crontab برای اجرای خودکار اسکریپت توسط $PCP_USER (یا root) \-
تنها در صورتی وجود دارد که پلتفرم از سازوکار
.I /etc/cron.d
پشتیبانی نکند.
.TP
.I $PCP_VAR_DIR/config/pmie/config.default
مسیر پیش‌فرض فایل پیکربندی
.B pmie
برای یک موتور استنتاج localhost، که معمولاً به‌طور خودکار توسط
.BR pmieconf (1)
تولید می‌شود.
.TP
.I $PCP_LOG_DIR/pmie/pmie_check.log
مسیر پیش‌فرض برای فایل لاگ
.BR pmie_check .
هنگام اجرا به عنوان یک سرویس دیمن (daemon)، اگر فرایند
.B pmie
نتواند شروع شود یا زودتر از موعد خارج شود، ممکن است پیام‌های خطا در این فایل ثبت شوند، به‌ویژه اگر دیمن نتواند فایل لاگ اختصاصی خود را باز کند.
.TP
.I $PCP_LOG_DIR/pmie/pmie_daily.log
مسیر پیش‌فرض برای پیام‌های خطای تولید شده در طول عملیات روزانهٔ نگهداری سرویس
.BR pmie .
.TP
.I $PCP_LOG_DIR/pmie/<hostname>
مسیر دایرکتوری پیش‌فرض برای فایل لاگ pmie برای میزبان
.I hostname
.TP
.I $PCP_LOG_DIR/pmie/<hostname>/lock
فایل قفل گذرا جهت تضمین انحصار متقابل در طول مدیریت
.B pmie
برای میزبان
.I hostname
\- در صورت وجود، چنانچه هیچ‌یک از
.B pmie_daily
یا
.B pmie_check
در حال اجرا نباشند، می‌توان آن را با اطمینان حذف کرد.
.TP
.I $PCP_LOG_DIR/NOTICES
فایل اطلاعیه‌های PCP («notices») مورد استفاده توسط
.BR pmie (1)
و ابزارهای وابسته
.SH "محیط PCP (PCP ENVIRONMENT)"
متغیرهای محیطی با پیشوند \fBPCP_\fP برای تعیین نام فایل‌ها و دایرکتوری‌های مورد استفاده PCP به کار می‌روند.
در هر نصب، فایل \fI/etc/pcp.conf\fP حاوی مقادیر محلی این متغیرها است.
متغیر \fB$PCP_CONF\fP می‌تواند برای مشخص کردن یک فایل پیکربندی جایگزین استفاده شود، همان‌طور که در \fBpcp.conf\fP(5) شرح داده شده است.
.SH "همچنین ببینید (SEE ALSO)"
.BR egrep (1)،
.BR PCPIntro (1)،
.BR pmie (1)،
.BR pmieconf (1)،
.BR systemd (1)،
.BR xz (1)
و
.BR cron (8).

.\" control lines for scripts/man-spell
.\" +ok+ RC {from RC scripts} args
.\" +ok+ lz lzma lzo {from compression suffixes}
.\" +ok+ myhost nologin prev requiretty runlevel sudoers