PCP2ZABBIX(1) General Commands Manual PCP2ZABBIX(1)

pcp2zabbix - صادرکننده معیارهای کارایی PCP به Zabbix

pcp2zabbix [-5CGHIjlLnrRvV?] [-4 action] [-8|-9 limit] [-a archive] [-A align] [--archive-folio folio] [-b|-B space-scale] [-c config] [--container container] [-D debug] [--daemonize] [-e derived] [-E send-interval] [-g server] [-h host] [-i instances] [-J rank] [-K spec] [-N predicate] [-O origin] [-p port] [-P|-0 precision] [-q|-Q count-scale] [-s samples] [-S starttime] [-t interval] [-T endtime] [-x prefix] [-X hostname] [-y|-Y time-scale] metricspec [...]

pcp2zabbix یک ابزار با قابلیت سفارشی‌سازی برای صادر کردن معیارهای کارایی از PCP به Zabbix است. هر معیار کارایی دردسترس، به‌صورت زنده یا بایگانی‌شده، سیستمی و/یا برنامه‌ای، می‌تواند با استفاده از آرگومان‌های خط فرمان یا یک فایل پیکربندی برای صدور انتخاب شود.

pcp2zabbix خویشاوند نزدیک pmrep(1) است. برای شرح metricspec پذیرفته‌شده در خط فرمان pcp2zabbix، به pmrep(1) مراجعه کنید. برای شرح ساختار فایل پیکربندی pcp2zabbix.conf به pmrep.conf(5) مراجعه نمایید. این صفحه گزینه‌های اختصاصی pcp2zabbix و تفاوت‌های فایل پیکربندی با pmrep.conf(5) را شرح می‌دهد. pmrep(1) همچنین مثال‌هایی از کاربرد را فهرست می‌کند که بیشتر آن‌ها برای pcp2zabbix نیز قابل استفاده هستند.

تنها گزینه‌های خط فرمانی که در این صفحه فهرست شده‌اند پشتیبانی می‌شوند؛ سایر گزینه‌های موجود در pmrep(1) پشتیبانی نمی‌شوند.

گزینه‌های تعیین‌شده از طریق مقادیر متغیرهای محیطی (ببینید pmGetOptions(3)) بر مقادیر پیش‌فرض توکار مربوطه (در صورت وجود) اولویت دارند. گزینه‌های فایل پیکربندی بر متغیرهای محیطی مربوطه (در صورت وجود) اولویت دارند. گزینه‌های خط فرمان نیز بر گزینه‌های متناظر در فایل پیکربندی (در صورت وجود) مقدم هستند..SH "فایل پیکربندی (CONFIGURATION FILE)" pcp2zabbix از یک فایل پیکربندی با ساختار نحوی شرح‌داده‌شده در pmrep.conf(5) استفاده می‌کند. گزینه‌های زیر با pmrep.conf مشترک هستند: version، source، speclocal، derived، header، globals، samples، interval، type، type_prefer، ignore_incompat، names_change، instances، live_filter، rank، limit_filter، limit_filter_force، invert_filter، predicate، omit_flat، precision، precision_force، count_scale، count_scale_force، space_scale، space_scale_force، time_scale، time_scale_force. بقیه گزینه‌های pmrep.conf برای سازگاری شناسایی می‌شوند اما نادیده گرفته خواهند شد.

zabbix_server (رشته)

نام میزبان یا نشانی IP سرور مقصد Zabbix را مشخص می‌کند. اگر میزبانی توسط یک پراکسی پایش می‌شود، باید به جای آن از نام میزبان یا نشانی IP پراکسی استفاده شود. گزینه خط فرمان متناظر -g است. پیش‌فرض localhost است.

zabbix_port (عدد صحیح)

شماره درگاه (port) بخش server trapper که روی سرور در حال اجراست را مشخص می‌کند. گزینه خط فرمان متناظر -p است. پیش‌فرض 10051 است.

zabbix_host (رشته)

نام میزبان عامل (agent) را همان‌گونه که در واسط کاربری Zabbix ثبت شده است مشخص می‌کند. نشانی IP میزبان و نام DNS کار نخواهند کرد. گزینه خط فرمان متناظر -X است. پیش‌فرض، میزبان مبدأ سنجه‌ها است.

zabbix_interval (رشته)

بازه زمانی ارسال سنجه‌ها به سرور Zabbix را مشخص می‌کند. این مقدار می‌تواند طولانی‌تر از بازه گزارش‌گیری (interval) باشد تا بار اضافی (overhead) هنگام ارتباط با سرور کاهش یابد (زیرا هر ارسال یک اتصال جدید ایجاد می‌کند). از ساختار نحوی زمان شرح‌داده‌شده در PCPIntro(1) پیروی می‌کند. گزینه خط فرمان متناظر -E است. پیش‌فرض، بازه گزارش‌گیری (interval) است. ابزارهای Zabbix در هر نوبت حداکثر ۲۵۰ سنجه ارسال می‌کنند. هنگام خواندن سنجه‌ها از آرشیوهای PCP نادیده گرفته می‌شود که در این حالت سنجه‌ها تقریباً در دسته‌های ۲۵۰تایی ارسال خواهند شد.

zabbix_prefix (رشته)

پیشوند سنجه‌های ارسالی به سرور Zabbix را مشخص می‌کند. گزینه خط فرمان متناظر -x است. پیش‌فرض pcp. است.

zabbix_lld (بولی)

مشخص می‌کند که آیا کشف سطح پایین (low-level discovery) در Zabbix فعال باشد یا خیر. گزینه خط فرمان متناظر -l است. پیش‌فرض no است. گزینه‌های خط فرمان موجود عبارتند از:
-0 precision, --precision-force=precision
مانند -P است، اما این گزینه مشخصات تعیین‌شده به ازای هر معیار را بازنویسی خواهد کرد.
-4 action, --names-change=action
مشخص می‌کند که هنگام دریافت رویداد تغییر نام معیار در حین نمونه‌برداری، چه action (عملیاتی) انجام شود. این رویدادها زمانی رخ می‌دهند که یک PMDA مدتی پس از راه‌اندازی، معیارهای جدیدی کشف کرده و به ابزارهای کلاینت در حال اجرا مانند pcp2zabbix اطلاع دهد. مقادیر معتبر برای action عبارتند از: update (تازه‌سازی معیارهای در حال نمونه‌برداری)، ignore (کاری انجام نده - رفتار پیش‌فرض) و abort (خروج از برنامه در صورت وقوع چنین رویدادی).
-5, --ignore-unknown
نادیده گرفتن بی‌صدای هر نام معیاری که قابل حل نباشد. برای شروع به کار ابزار، حداقل یک معیار باید پیدا شود.
-8 limit, --limit-filter=limit
محدود کردن نتایج به نمونه‌هایی با مقادیر بالاتر/پایین‌تر از limit. یک عدد صحیح مثبت، نمونه‌هایی با مقادیر برابر یا بالاتر از حد تعیین‌شده را در گزارش لحاظ می‌کند. یک عدد صحیح منفی، نمونه‌هایی با مقادیر برابر یا کمتر از حد تعیین‌شده را در گزارش لحاظ می‌کند. مقدار صفر هیچ فیلتر محدودیتی اعمال نمی‌کند. این گزینه مشخصات احتمالی تعیین‌شده به ازای هر معیار را بازنویسی نخواهد کرد. همچنین ببینید: -J و -N.
-9 limit, --limit-filter-force=limit
مانند -8 است، اما این گزینه مشخصات تعیین‌شده به ازای هر معیار را بازنویسی خواهد کرد.
مقادیر معیارهای کارایی از مجموعه‌ای از فایل‌های بایگانی Performance Co-Pilot (PCP) که توسط آرگومان archive مشخص شده است، بازیابی می‌شوند؛ این آرگومان فهرستی از نام‌هاست که با کاما از هم جدا شده‌اند، و هر کدام می‌تواند نام پایه یک بایگانی یا نام دایرکتوری حاوی یک یا چند بایگانی باشد.
اجبار نمونه‌برداری اولیه به تراز شدن روی مرز یک واحد زمانی طبیعی align. برای شرح کامل نحو align به PCPIntro(1) مراجعه کنید.
خواندن بایگانی‌های منبع معیار از PCP archive folio ایجادشده توسط ابزارهایی مانند pmchart(1) یا با فراوانی کمتر، به‌صورت دستی با mkaf(1).
واحد/مقیاس برای معیارهای فضا (بایت)؛ مقادیر ممکن شامل bytes، Kbytes، KB، Mbytes، MB و مانند آن است. این گزینه مشخصات احتمالی تعیین‌شده به ازای هر معیار را بازنویسی نخواهد کرد. همچنین ببینید: pmParseUnitsStr(3).
مانند -b است، اما این گزینه مشخصات تعیین‌شده به ازای هر معیار را بازنویسی خواهد کرد.
فایل یا دایرکتوری config مورد استفاده را مشخص می‌کند. در صورتی که config یک دایرکتوری باشد، تمام فایل‌های درون آن که به .conf ختم می‌شوند، لحاظ خواهند شد. پیش‌فرض، نخستین مورد یافت‌شده از موارد زیر است: ./pcp2zabbix.conf، $HOME/.pcp2zabbix.conf، $HOME/pcp/pcp2zabbix.conf و $PCP_SYSCONF_DIR/pcp2zabbix.conf. برای جزئیات، بخش بالا و pmrep.conf(5) را ببینید.
دریافت معیارهای کارایی از container مشخص‌شده، به‌صورت محلی یا از راه دور (ببینید -h).
خروج پیش از گزارش هر مقداری، اما پس از تجزیه پیکربندی و معیارها و چاپ سرآیندهای احتمالی.
تبدیل شدن به دیمن در هنگام راه‌اندازی.
معیارهای کارایی مشتق‌شده ( derived ) را مشخص می‌کند. اگر derived با یک اسلش (``/'') یا یک نقطه (``.'') شروع شود، به عنوان یک فایل پیکربندی معیارهای مشتق‌شده PCP تفسیر خواهد شد؛ در غیر این صورت به عنوان عبارات معیارهای مشتق‌شده که با کاما یا نقطه-ویرگول از هم جدا شده‌اند، تفسیر می‌شود. برای شرح کامل معیارهای مشتق‌شده و فایل‌های پیکربندی معیارهای مشتق‌شده PCP به pmLoadDerivedConfig(3) و pmRegisterDerived(3) مراجعه کنید. همچنین، استفاده از نحو پیکربندی pmrep.conf(5) امکان تعریف معیارهای مشتق‌شده را به عنوان بخشی از مجموعه‌معیارها (metricsets) فراهم می‌کند.

در صورت بروز مشکل در معیارهای مشتق‌شده، صفحات راهنمای ذکرشده را با جزئیات بررسی کرده و اطمینان حاصل کنید که همه معیارهای مورد نیاز، به‌ویژه هنگام استفاده از بایگانی‌ها، در دسترس هستند. از -Dderive برای مشاهده اطلاعات اشکال‌زدایی بیشتر درباره تجزیه معیارهای مشتق‌شده استفاده کنید.

فاصله زمانی ( interval ) را برای ارسال معیارها به سرور مشخص می‌کند. برای جزئیات بیشتر، به توضیحات zabbix_interval در بالا مراجعه کنید.
server مقصد زبیکس (Zabbix).
معیارهای سراسری در گزارش لحاظ نشوند (ببینید pmrep.conf(5)).
دریافت معیارهای کارایی از pmcd(1) روی host، به جای localhost پیش‌فرض.
هیچ سرآیندی چاپ نشود.
تنها نمونه‌های ( instances ) مشخص‌شده از معیار بازیابی و گزارش شوند. به‌طور پیش‌فرض، تمام نمونه‌های فعلی و آینده گزارش می‌شوند.

برای شرح کامل این گزینه به pmrep(1) مراجعه کنید.

نادیده گرفتن معیارهای ناسازگار. به‌طور پیش‌فرض معیارهای ناسازگار (یعنی نوع آن‌ها پشتیبانی نمی‌شود یا نمی‌توان آن‌ها را طبق درخواست مقیاس‌بندی کرد) موجب می‌شوند که pcp2zabbix با یک پیام خطا خاتمه یابد. با این گزینه، تمام معیارهای ناسازگار به‌صورت بی‌صدا از گزارش حذف می‌شوند. این گزینه به‌ویژه هنگام درخواست گره‌های غیربرگ (non-leaf) از درخت PMNS برای گزارش‌گیری مفید است..TP -l, --zabbix-lld افزودن معیارهای کشف سطح پایین (LLD). این قابلیت امکان ارسال دامنه‌های نمونه (instance domains) معیارهای PCP را به Zabbix فراهم می‌کند، تا آیتم‌ها/محرک‌ها/نمودارهای اولیه (prototype) به‌طور خودکار توسط Zabbix ایجاد شوند. به ازای هر معیار PCP که دارای دامنه نمونه است، کلید pcp.discovery[pcp.met.ric] به‌طور دوره‌ای ارسال می‌شود. این نماد باید به یک قاعده کشف افزوده شود و ماکروی LLD {#PCP.MET.RIC} را تعریف خواهد کرد. این ماکرو به نوبه خود می‌تواند برای تعریف آیتم‌ها/محرک‌ها/نمودارهای اولیه استفاده شود. اگر از -x برای بازنویسی پیشوند pcp. استفاده شده باشد، نام‌ها تطبیق داده می‌شوند.
انجام فیلترسازی زنده نمونه‌ها. این قابلیت اجازه می‌دهد همه نمونه‌های نام‌گذاری‌شده ثبت شوند، حتی اگر فرایندها در مقطعی مجدداً راه‌اندازی شوند (برخلاف حالت بدون فیلترسازی زنده). انجام فیلترسازی زنده روی تعداد بسیار زیادی از نمونه‌ها مقداری سربار داخلی اضافه خواهد کرد، بنابراین احتیاط کاربر توصیه می‌شود. همچنین ببینید: -n.
محدود کردن نتایج به بالاترین/پایین‌ترین نمونه‌های ranked (رتبه‌بندی‌شده) از معیارهای مجموعه‌مقدار (set-valued). یک عدد صحیح مثبت، نمونه‌های دارای بالاترین مقدار را در گزارش لحاظ می‌کند. یک عدد صحیح منفی، نمونه‌های دارای کمترین مقدار را در گزارش لحاظ می‌کند. مقدار صفر هیچ رتبه‌بندی‌ای انجام نمی‌دهد. رتبه‌بندی به معنای مرتب‌سازی نیست، ببینید: -6. همچنین ببینید: -8.
هنگام واکشی معیارها از یک بافت محلی (ببینید: -L)، گزینه -K می‌تواند برای کنترل DSO PMDAهایی که باید قابل دسترسی باشند استفاده شود. آرگومان spec از نحو شرح داده شده در pmSpecLocalPMDA(3) پیروی می‌کند. می‌توان بیش از یک گزینه -K را استفاده کرد.
استفاده از یک بافت محلی برای جمع‌آوری معیارها از DSO PMDAها روی میزبان محلی بدون PMCD. همچنین ببینید: -K.
انجام رتبه‌بندی پیش از فیلترسازی زنده. به‌طور پیش‌فرض، فیلترسازی زنده نمونه‌ها (در صورت درخواست، ببینید: -j) پیش از رتبه‌بندی نمونه‌ها (در صورت درخواست، ببینید: -J) انجام می‌شود. با این گزینه، این منطق معکوس شده و رتبه‌بندی پیش از فیلترسازی زنده رخ می‌دهد.
مشخص کردن یک فهرست جداشده با کاما از معیارهای مرجعِ پالایه predicate. به‌طور پیش‌فرض، رتبه‌بندی (ببینید: -J) برای هر معیار به‌صورت مجزا انجام می‌شود. با گزاره‌ها (predicates)، رتبه‌بندی تنها برای معیارهای گزارهٔ مشخص‌شده انجام می‌شود. هنگام گزارش‌دهی، بقیه معیارهایی که دامنه نمونه مشترکی ( instance domain؛ ببینید: PCPIntro(1)) با گزاره دارند، تنها شامل نمونه‌های با بالاترین/پایین‌ترین رتبه از گزاره متناظر خواهند بود. رتبه‌بندی به معنای مرتب‌سازی نیست، ببینید: -6.

بنابراین برای مثال، با استفاده از proc.memory.rss (اندازه حافظه مقیم فرایند) به‌عنوان معیار predicate همراه با proc.io.total_bytes و mem.util.used به‌عنوان معیارهایی که باید گزارش شوند، تنها فرایندهایی که بیشترین/کمترین حافظه را (مطابق با -J) مصرف می‌کنند، هنگام گزارش کل بایت‌های نوشته‌شده توسط فرایندها گنجانده خواهند شد. از آنجا که mem.util.used یک معیار تک‌مقداری است (و بنابراین دامنه نمونه یکسانی با معیارهای مرتبط با فرایند ندارد)، طبق معمول گزارش خواهد شد.

هنگام گزارش معیارهای بایگانی‌شده، شروع گزارش‌دهی از origin درون پنجره زمانی (ببینید: -S و -T). برای شرح کامل ساختار نحوی origin، به PCPIntro(1) مراجعه کنید.
port سرور Zabbix.
استفاده از precision برای مقادیر خروجی عددی غیر صحیح. پیش‌فرض استفاده از ۳ رقم اعشار است (در صورت امکان). این گزینه مشخصات احتمالی به ازای هر معیار را بازنویسی نخواهد کرد.
واحد/مقیاس برای معیارهای شمارشی، مقادیر ممکن شامل count x 10^-1، count، count x 10، count x 10^2 و به همین ترتیب از 10^-8 تا 10^7 است. (این مقادیر در حال حاضر به فاصله حساس هستند.) این گزینه مشخصات احتمالی به ازای هر معیار را بازنویسی نخواهد کرد. همچنین ببینید: pmParseUnitsStr(3).
مشابه -q اما این گزینه مشخصات به ازای هر معیار را بازنویسی خواهد کرد.
ارائه مقادیر خام معیارها در خروجی؛ شمارنده‌های تجمعی به نرخ تبدیل نمی‌شوند. این گزینه مشخصات احتمالی به ازای هر معیار را بازنویسی خواهد کرد.
مشابه -r اما این گزینه مشخصات به ازای هر معیار را بازنویسی نخواهد کرد.
آرگومان samples تعداد نمونه‌هایی را که باید دریافت و گزارش شوند مشخص می‌کند. اگر samples برابر 0 باشد یا -s مشخص نشده باشد، pcp2zabbix به‌طور پیوسته (در حالت بلادرنگ) یا تا انتهای مجموعه بایگانی‌های PCP (در حالت بایگانی) نمونه‌برداری و گزارش خواهد کرد. همچنین ببینید: -T.
هنگام گزارش معیارهای بایگانی‌شده، گزارش محدود به رکوردهایی خواهد بود که در starttime یا پس از آن ثبت شده‌اند. برای شرح کامل ساختار نحوی starttime، به PCPIntro(1) مراجعه کنید.
تنظیم interval (بازه زمانی) گزارش‌دهی روی مقداری غیر از پیش‌فرضِ ۱ ثانیه. آرگومان interval از نحو شرح داده شده در PCPIntro(1) پیروی می‌کند، و در ساده‌ترین شکل می‌تواند یک عدد صحیح بدون علامت باشد (واحد ضمنی در این حالت، ثانیه است). همچنین گزینه -T را ببینید..TP -T endtime, --finish=endtime هنگام گزارش معیارهای بایگانی‌شده، گزارش به رکوردهایی محدود می‌شود که پیش از یا در endtime ثبت شده‌اند. برای شرح کامل نحوِ endtime به PCPIntro(1) مراجعه کنید.

هنگامی که برای تعیین مدت‌زمان اجرا پیش از خروج pcp2zabbix استفاده می‌شود، چنانچه هیچ samples مشخص نشده باشد (به -s مراجعه کنید)، تعداد نمونه‌های گزارش‌شده به interval بستگی دارد (به -t مراجعه کنید). اگر samples مشخص شده باشد، آن‌گاه interval به‌گونه‌ای تنظیم خواهد شد که امکان گزارش samples در طول زمان اجرا فراهم شود. در صورتی که هر سه گزینهٔ -T، -s و -t داده شده باشند، endtime مدت‌زمان واقعی اجرای pcp2zabbix را تعیین می‌کند.

تنها معیارهای مجموعه‌مقدار دارای نمونه (مانند disk.dev.read) گزارش شوند و از معیارهای تک‌مقداریِ ``مسطح'' بدون نمونه (مانند kernel.all.sysfork) صرف‌نظر شود. به -i و -I مراجعه کنید.
نمایش شماره نسخه و خروج.
پیشوندِ ( prefix) معیارها برای مقادیر اندازه‌گیری‌شدهٔ ارسال‌شده به سرور.
نام میزبانِ ( hostname) عامل (agent)، همان‌گونه که در frontend زبیکس ثبت شده است.
واحد/مقیاس برای معیارهای زمانی؛ مقادیر ممکن شامل nanosec، ns، microsec، us، millisec، ms، و به همین ترتیب تا hour، hr است. این گزینه تنظیمات احتمالیِ اختصاصی هر معیار را بازنویسی نمی‌کند. همچنین ببینید pmParseUnitsStr(3).
مشابه -y اما این گزینه مشخصات اختصاصی هر معیار را بازنویسی خواهد کرد.
-?, --help
نمایش پیام راهنما و خروج.

فایل پیکربندی pcp2zabbix (به -c مراجعه کنید)
$PCP_SYSCONF_DIR/pmrep/*.conf
فایل‌های پیکربندی پیش‌فرض pmrep ارائه‌شده توسط سیستم.SH "محیط PCP (PCP ENVIRONMENT)" متغیرهای محیطی با پیشوند PCP_ برای تعیین نام فایل‌ها و دایرکتوری‌های مورد استفادهٔ PCP به کار می‌روند. در هر نصب، فایل /etc/pcp.conf شامل مقادیر محلی برای این متغیرها است. متغیر $PCP_CONF می‌تواند برای تعیین یک فایل پیکربندی جایگزین استفاده شود، همان‌گونه که در pcp.conf(5) شرح داده شده است.

برای متغیرهای محیطی تأثیرگذار بر ابزارهای PCP، به pmGetOptions(3) مراجعه کنید.

به‌طور ویژه، PCP_DISCRETE_ONCE می‌تواند به‌گونه‌ای تنظیم شود تا اطمینان حاصل گردد مقادیر متریک‌های گسسته تنها یک‌بار گزارش می‌شوند، مگر آن‌که در مقطعی تغییر کنند.

گزینهٔ -D یا --debug خروجی داده‌های عیب‌یابی بیشتر را بر روی stderr فعال می‌کند تا به بررسی و دسته‌بندی مشکلات کمک کند، اگرچه این اطلاعات گاهی مبهم بوده و در وهلهٔ اول برای راهنمایی توسعه‌دهندگان طراحی شده است تا کاربران نهایی. debug فهرستی از گزینه‌های اشکال‌زدایی است که با کاما از یکدیگر جدا شده‌اند؛ از pmdbg(1) همراه با گزینهٔ -l برای دریافت فهرستی از گزینه‌های اشکال‌زدایی موجود و معانی آن‌ها استفاده کنید.

PCPIntro(1), mkaf(1), pcp(1), pcp2elasticsearch(1), pcp2graphite(1), pcp2influxdb(1), pcp2json(1), pcp2spark(1), pcp2xlsx(1), pcp2xml(1), pmcd(1), pminfo(1), pmrep(1), pmGetOptions(3), pmLoadDerivedConfig(3), pmParseUnitsStr(3), pmRegisterDerived(3), pmSpecLocalPMDA(3), zbxpcp(3), LOGARCHIVE(5), pcp.conf(5), pmrep.conf(5) و PMNS(5).

PCP Performance Co-Pilot