'\"macro stdmacro
.\"
.\" Copyright (C) 2019 Marko Myllynen <myllynen@redhat.com>
.\"
.\" 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 PMDANETCHECK 1 "PCP" "Performance Co-Pilot"
.SH "نام (NAME)"
pmdanetcheck \- عامل PMDA بررسی شبکه
.SH "توضیحات (DESCRIPTION)"
\fBpmdanetcheck\fP یک عامل دامنه معیارهای کارایی (PMDA) در Performance Co-Pilot (PCP) است که با استفاده از ماژول‌های ساده پایتون و در برخی موارد، ابزارهای خارجی مانند
.BR ping (1)
بررسی‌های پایه‌ای شبکه را روی میزبان محلی انجام می‌دهد.
.PP
\fBpmdanetcheck\fP بارگذاری و نقش پلی را برای هر تعداد از ماژول‌های پایتون پیکربندی‌شده و مجزای PCP netcheck PMDA که کدهای پایتون یا برنامه‌های خارجی را اجرا می‌کنند، بر عهده می‌گیرد.
به‌کارگیری ماژول‌ها و برنامه‌های موجود پایتون همراه با ماژول‌های PCP netcheck PMDA باید با کمترین تلاش ممکن باشد.
.PP
توجه داشته باشید که در سیستم‌های با SELinux فعال، برای اینکه \fBpmdanetcheck\fP بتواند از دستور
.BR ping (1)
استفاده کند، گروه \fBpcp\fP باید بتواند سوکت‌های ICMP Echo ایجاد کند؛ لطفاً مطمئن شوید شناسه گروه برای \fBpcp\fP در بازه مشخص‌شده در
.I /proc/sys/net/ipv4/ping_group_range
قرار دارد و برای جزئیات بیشتر در این باره به
.BR icmp (7)
مراجعه کنید.
.SH "پیکربندی (CONFIGURATION)"
\fBpmdanetcheck\fP یک فایل پیکربندی الزامی به سبک ini را می‌خواند:
.IP
.PD 0
.IP
.I \f(CR$PCP_PMDAS_DIR\fP/netcheck/netcheck.conf
.PD
.PP
این فایل باید شامل یک بخش \fB[pmda]\fP باشد.
گزینه‌های PMDA زیر در دسترس هستند
(مقادیر پیش‌فرض آن‌ها درون پرانتز نشان داده شده‌اند)،
گزینه‌هایی که با ستاره (\fB*\fP) مشخص شده‌اند را می‌توان در بخش‌های پیکربندی ویژه ماژول بازنویسی کرد:
.TP 15
.B modules \fR(تنظیم‌نشده)\fP
عامل \fBpmdanetcheck\fP پیکربندی اختصاصی ماژول را برای هر ماژول فهرست‌شده در فهرستِ با کاما جداشدهٔ \fBmodules\fP می‌خواند (الزامی).
.TP
.B hosts \fR(\fP\fIDGW,DNS\fP\fR)\fP *
یک فهرستِ با کاما جداشده از \fBhosts\fP (اختیاری) میزبان‌هایی را مشخص می‌کند که بررسی‌ها برای آن‌ها اجرا می‌شود.
مقادیر ویژه \fBDGW\fP، \fBDNS\fP و \fBNTP\fP در هنگام راه‌اندازی PMDA به ترتیب به دروازه پیش‌فرض (default gateway)، کارگزارهای نام فهرست‌شده در
\fB/etc/resolv.conf\fP و کارگزارهای زمانی فهرست‌شده در
\fB/etc/chrony.conf\fP ترجمه خواهند شد.
.TP
.B background_check \fR(\fP\fITrue\fP\fR)\fP *
یک مقدار بولی برای \fBbackground_check\fP (اختیاری) تعیین می‌کند که آیا بررسی‌ها به طور مداوم در پس‌زمینه اجرا شوند یا تنها در صورت تقاضا.
برای توضیحات بیشتر در این مورد به فایل پیکربندی پیش‌فرض مراجعه کنید.
.TP
.B check_hosts_parallel \fR(\fP\fITrue\fP\fR)\fP *
گزینه \fBcheck_hosts_parallel\fP (اختیاری) تعیین می‌کند که آیا ماژول‌ها باید میزبان‌ها را یکی‌یکی بررسی کنند یا به صورت موازی.
.TP
.B check_interval \fR(\fP\fI1m\fP\fR)\fP *
گزینه \fBcheck_interval\fP (اختیاری) بازه زمانی بین دو بررسی متوالی میزبان‌ها را در هنگامی که بررسی‌ها در پس‌زمینه انجام می‌شوند مشخص می‌کند.
برای توضیح کامل ساختار نحوی بازه زمانی به
.BR PCPIntro (1)
مراجعه کنید.
.TP
.B align_interval \fR(\fP\fITrue\fP\fR)\fP *
گزینه \fBalign_interval\fP (اختیاری) مشخص می‌کند که آیا هنگام مکث بین بررسی‌ها، مدت‌زمان بررسی قبلی در نظر گرفته شود یا خیر.
.TP
.B module_failure_fatal \fR(\fP\fITrue\fP\fR)\fP
یک مقدار بولی برای \fBmodule_failure_fatal\fP (اختیاری) مشخص می‌کند که آیا عدم موفقیت در راه‌اندازی اولیه یک ماژول باید موجب توقف کل PMDA شود (این حالت پیش‌فرض است) یا اینکه PMDA با ماژول‌های فعال باقیمانده شروع به کار کند.
خطاهای پیکربندی ماژول و خطاهای داخلی (مانند عدم موفقیت در ثبت معیارهای PMNS ارائه‌شده، نگاه کنید به \fBpmns\fP(5)) همواره مانع شروع به کار PMDA خواهند شد.
.PP
به ازای هر \fImodule\fP فهرست‌شده در \fBmodules\fP باید یک بخش متناظر \fI[module]\fP تعریف شود.
هر بخش \fI[module]\fP دست‌کم می‌تواند شامل گزینه‌های زیر باشد
(مقادیر پیش‌فرض آن‌ها درون پرانتز نشان داده شده‌اند):
.TP 15
.B timeout \fR(\fP\fI1\fP\fR)\fP
اعمال یک مهلت زمانی (\fBtimeout\fP) قطعی (اختیاری) برای هر عملیات بررسی شبکه منفرد.
.TP
.B debug \fR(\fP\fIFalse\fP\fR)\fP
فعال‌سازی ثبت پیام‌های اشکال‌زدایی (\fBdebug\fP) داخلی (به‌ندرت استفاده می‌شود).
.PP
گزینه‌های ویژه ماژول که ماژول‌ها می‌پذیرند در فایل پیکربندی پیش‌فرض شرح داده شده‌اند.
.PP
ماژول‌ها انتظار دارند عملکردهای پایه‌ای شبکه در سیستم موجود باشد، به عنوان نمونه در دسترس بودن نشانی \fBlocalhost\fP.
.SH "نصب (INSTALLATION)"
برای نصب، موارد زیر باید با دسترسی ریشه (root) انجام شوند:
.sp 1
.RS +4
.ft B
.nf
# cd $PCP_PMDAS_DIR/netcheck
# ./Install
.fi
.ft P
.RE
.sp 1
برای حذف نصب، موارد زیر باید با دسترسی ریشه (root) انجام شوند:
.sp 1
.RS +4
.ft B
.nf
# cd $PCP_PMDAS_DIR/netcheck
# ./Remove
.fi
.ft P
.RE
.sp 1
\fBpmdanetcheck\fP توسط \fBpmcd\fP(1) راه‌اندازی می‌شود و هرگز نباید مستقیماً اجرا شود.
اسکریپت‌های \fBInstall\fP و \fBRemove\fP هنگام نصب یا حذف عامل، به \fBpmcd\fP(1) اطلاع می‌دهند.
.PP
در صورتی که \fBmodule_failure_fatal\fP روی \fBFalse\fP تنظیم شده باشد، اگر برخی از ماژول‌های پیکربندی‌شده (نه همگی) در بارگذاری شکست بخورند، نصب PMDA موفقیت‌آمیز در نظر گرفته خواهد شد؛ در چنین مواردی معیارهای ارائه‌شده توسط ماژول‌های شکست‌خورده در دسترس نخواهند بود.
فایل گزارش (log) عامل \fBpmdanetcheck\fP (پایین را ببینید) حاوی اطلاعات دقیقی درباره فعال‌سازی هر ماژول خواهد بود.
.PP
ماژول‌ها تنها پس از جمع‌آوری داده‌ها مقادیر واقعی را ارائه خواهند کرد.
به عنوان مثال، برای ماژول \fBping\fP مقدار معیار برابر مقدار خروج دستور \fBping\fP(1) است و برای \fBping_latency\fP میانگین تأخیر بسته‌ها بر اساس گزارش \fBping\fP(1) است.
برای معیارهایی که بیانگر وضعیت هستند، \fB0\fP نشانه موفقیت است.
در صورتی که یک بررسی هنوز به پایان نرسیده باشد، مقدار معیار آن \fB-1\fP است.
اگر یک بررسی در حین اجرا به دلیل اتمام مهلت زمانی (timeout) متوقف شود، این مقدار \fB-2\fP خواهد بود.
.SH "فایل‌ها (FILES)"
.TP 5
.I \f(CR$PCP_PMDAS_DIR\fP/netcheck/netcheck.conf
فایل پیکربندی برای عامل \fBpmdanetcheck\fP
.TP
.I \f(CR$PCP_PMDAS_DIR\fP/netcheck/netcheck/*.{py,python}
ماژول‌های پایتون PCP netcheck PMDA برای عامل \fBpmdanetcheck\fP
.TP
.I \f(CR$PCP_PMDAS_DIR\fP/netcheck/Install
اسکریپت نصب برای عامل \fBpmdanetcheck\fP
.TP
.I \f(CR$PCP_PMDAS_DIR\fP/netcheck/Remove\fP
اسکریپت حذف نصب برای عامل \fBpmdanetcheck\fP
.TP
.I \f(CR$PCP_LOG_DIR\fP/pmcd/netcheck.log
فایل گزارش پیش‌فرض برای پیام‌های عامل \fBpmdanetcheck\fP
.PP
توجه داشته باشید که مقدار معمول/پیش‌فرض برای \fB$PCP_PMDAS_DIR\fP برابر
.B /var/lib/pcp/pmdas
و پیش‌فرض برای \fB$PCP_LOG_DIR\fP برابر
.B /var/log/pcp
است، اما این تنظیمات وابسته به پلتفرم هستند.
.SH "محیط PCP (PCP ENVIRONMENT)"
متغیرهای محیطی با پیشوند \fBPCP_\fP برای پارامتریک کردن نام فایل‌ها و دایرکتوری‌های مورد استفاده PCP به کار می‌روند.
در هر نصب، فایل \fI/etc/pcp.conf\fP شامل مقادیر محلی برای این متغیرها است.
از متغیر \fB$PCP_CONF\fP می‌توان برای مشخص کردن یک فایل پیکربندی جایگزین استفاده کرد، همان‌طور که در \fBpcp.conf\fP(5) شرح داده شده است.
.SH "همچنین ببینید (SEE ALSO)"
.BR PCPIntro (1),
.BR ping (1),
.BR pmcd (1),
.BR getaddrinfo (3),
.BR resolver (3),
.BR gai.conf (5),
.BR resolv.conf (5),
.BR resolver (5),
.BR icmp (7)
و
.BR ip (8).

.\" control lines for scripts/man-spell
.\" +ok+ check_hosts_parallel module_failure_fatal background_check
.\" +ok+ ping_group_range check_interval align_interval ping_latency
.\" +ok+ pmdanetcheck getaddrinfo timeservers netcheck SELinux resolv chrony
.\" +ok+ ICMP icmp {from \[pmda]} DGW NTP gai {from gai.conf}
.\" +ok+ sys ip {both from /proc/sys/net/ipv4/ping_group_range}
.\" +ok+ py {from $PCP_PMDAS_DIR/netcheck/netcheck/*.<lb>py,python<rb>}