نام (NAME)

pcp2xlsx - صادرکننده معیارهای عملکرد از PCP به XLSX

خلاصه دستور (SYNOPSIS)

pcp2xlsx [-5CGHILmrRvVz?] [-4 action] [-a archive] [-A align] [--archive-folio folio] [-b|-B space-scale] [-c config] [--container container] [--daemonize] [-e derived] [-f format] [-F outfile] [-h host] [-i instances] [-K spec] [-O origin] [-P|-0 precision] [-q|-Q count-scale] [-s samples] [-S starttime] [-t interval] [-T endtime] [-y|-Y time-scale] [-Z timezone] metricspec [...]

توضیحات (DESCRIPTION)

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

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

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

گزینه‌های تعیین‌شده از طریق متغیرهای محیطی (به pmGetOptions(3) مراجعه کنید) بر مقادیر پیش‌فرض توکار متناظر (در صورت وجود) اولویت دارند و جایگزین آن‌ها می‌شوند. گزینه‌های فایل پیکربندی بر متغیرهای محیطی متناظر (در صورت وجود) اولویت دارند. گزینه‌های خط فرمان نیز بر گزینه‌های متناظر در فایل پیکربندی (در صورت وجود) اولویت دارند.

فایل پیکربندی (CONFIGURATION FILE)

pcp2xlsx از یک فایل پیکربندی با ساختار نحوی شرح‌داده‌شده در pmrep.conf(5) استفاده می‌کند. گزینه‌های زیر با pmrep.conf مشترک هستند: version، source، speclocal، derived، header، globals، samples، interval، type، type_prefer، ignore_incompat، names_change، instances، omit_flat، include_labels، precision، precision_force، count_scale، count_scale_force، space_scale، space_scale_force، time_scale، time_scale_force. سایر گزینه‌های pmrep.conf جهت حفظ سازگاری شناسایی می‌شوند اما نادیده گرفته می‌شوند..SS گزینه‌های اختصاصی pcp2xlsx هیچ.

گزینه‌ها (OPTIONS)

گزینه‌های دردسترس خط فرمان عبارتند از:

-0 precision, --precision-force=precision: مانند -P اما این گزینه مشخصات تعیین‌شده به ازای هر متریک را بازنویسی خواهد کرد.
-4 action, --names-change=action: مشخص می‌کند که هنگام دریافت رویداد تغییر نام متریک‌ها حین نمونه‌برداری، چه action (اقدامی) انجام گیرد. این رویدادها زمانی رخ می‌دهند که یک PMDA مدتی پس از راه‌اندازی متریک‌های جدیدی را شناسایی کرده و به ابزارهای کلاینت در حال اجرا مانند pcp2xlsx اطلاع می‌دهد. مقادیر مجاز برای action عبارتند از update (تازه‌سازی متریک‌های در حال نمونه‌برداری)، ignore (کاری انجام نده - رفتار پیش‌فرض) و abort (خروج از برنامه در صورت وقوع چنین رویدادی).
-5, --ignore-unknown: نادیده گرفتن بی‌سروصدای هر نام متریکی که قابل تفکیک نیست. برای شروع به کار ابزار باید حداقل یک متریک پیدا شود.
-a archive, --archive=archive: مقادیر متریک کارایی از مجموعه فایل‌های آرشیو Performance Co-Pilot (PCP) که با آرگومان archive مشخص شده‌اند بازیابی می‌شوند؛ این آرگومان فهرستی از نام‌های جداشده با کاما است که هر یک می‌تواند نام پایه یک آرشیو یا نام یک دایرکتوری حاوی یک یا چند آرشیو باشد.
-A align, --align=align: هم‌تراز کردن اجباری نمونه اولیه بر روی مرز یک واحد زمانی طبیعی align. برای شرح کامل نحو مربوط به align به PCPIntro(1) مراجعه کنید.
--archive-folio=folio: خواندن آرشیوهای منبع متریک از folio آرشیو PCP ایجادشده توسط ابزارهایی مانند pmchart(1) یا در موارد کمتر معمول، به‌صورت دستی با mkaf(1).
-b scale, --space-scale=scale: واحد/مقیاس برای متریک‌های فضا (بایت)؛ مقادیر ممکن شامل bytes، Kbytes، KB، Mbytes، MB و غیره است. این گزینه مشخصات احتمالی به ازای هر متریک را بازنویسی نخواهد کرد. همچنین ببینید: pmParseUnitsStr(3).
-B scale, --space-scale-force=scale: مانند -b اما این گزینه مشخصات به ازای هر متریک را بازنویسی خواهد کرد.
-c config, --config=config: مشخص کردن فایل یا دایرکتوری config مورد استفاده. در صورتی که config یک دایرکتوری باشد، تمام فایل‌های موجود در آن که پسوند .conf دارند لحاظ خواهند شد. پیش‌فرض نخستین مورد یافت‌شده از میان موارد زیر است: ./pcp2xlsx.conf، $HOME/.pcp2xlsx.conf، $HOME/pcp/pcp2xlsx.conf و $PCP_SYSCONF_DIR/pcp2xlsx.conf. برای جزئیات بیشتر، بخش بالا و pmrep.conf(5) را ببینید.
--container=container: واکشی متریک‌های کارایی از container مشخص‌شده، چه به‌صورت محلی یا از راه دور (ببینید -h).
-C, --check: خروج پیش از گزارش هرگونه مقادیر، اما پس از تجزیه پیکربندی و متریک‌ها و چاپ سرآیندهای احتمالی.
--daemonize: اجرا به صورت دیمون هنگام راه‌اندازی.
-e derived, --derived=derived: مشخص کردن متریک‌های کارایی derived (مشتق‌شده). اگر derived با یک اسلش (``/'') یا با یک نقطه (``.'') شروع شود، به عنوان یک فایل پیکربندی متریک‌های مشتق‌شده PCP تفسیر خواهد شد، در غیر این صورت به عنوان عبارات متریک مشتق‌شده جداشده با کاما یا نقطه-ویرگول تفسیر می‌شود. برای شرح کامل متریک‌های مشتق‌شده و فایل‌های پیکربندی متریک‌های مشتق‌شده PCP ببینید: pmLoadDerivedConfig(3) و pmRegisterDerived(3). همچنین، استفاده از نحو پیکربندی pmrep.conf(5) امکان تعریف متریک‌های مشتق‌شده را به عنوان بخشی از metricsets فراهم می‌کند.

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

-G, --no-globals: متریک‌های سراسری (global) را در گزارش لحاظ نکن (ببینید pmrep.conf(5)).
-f format, --timestamp-format=format: استفاده از رشته format برای قالب‌بندی برچسب زمان (timestamp). این قالب با متد datetime.strftime پایتون استفاده خواهد شد که تا حد زیادی مشابه همان توصیف‌شده در strftime(3) است. پیش‌فرض %Y-%m-%d %H:%M:%S است.
-F outfile, --output-file=outfile: مشخص کردن فایل خروجی outfile.
-h host, --host=host: واکشی متریک‌های کارایی از pmcd(1) روی host، به جای مقدار پیش‌فرض localhost.
-H, --no-header: هیچ سرآیندی چاپ نشود.
-i instances, --instances=instances: تنها بازیابی و گزارش نمونه‌های instances مشخص‌شده از میان نمونه‌های متریک موجود در حال حاضر. به‌طور پیش‌فرض تمام نمونه‌های فعلی گزارش می‌شوند.

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

-I, --ignore-incompat: نادیده گرفتن متریک‌های ناسازگار. به‌طور پیش‌فرض، متریک‌های ناسازگار (یعنی نوع آن‌ها پشتیبانی نمی‌شود یا طبق درخواست قابل مقیاس‌بندی نیستند) باعث می‌شوند pcp2xlsx با یک پیام خطا متوقف شود. با این گزینه، تمام متریک‌های ناسازگار بی‌سروصدا از گزارش‌گیری حذف می‌شوند. این امر به‌ویژه هنگام درخواست گره‌های غیربرگ (non-leaf) از درخت PMNS برای گزارش مفید است.
-K spec, --spec-local=spec: هنگام واکشی متریک‌ها از یک بافت (context) محلی (ببینید -L)، گزینه -K می‌تواند برای کنترل DSO PMDAهایی که باید در دسترس قرار گیرند استفاده شود. آرگومان spec از نحو توصیف‌شده در pmSpecLocalPMDA(3) پیروی می‌کند. می‌توان بیش از یک گزینه -K را به کار برد.
-L, --local-PMDA: استفاده از یک بافت محلی برای جمع‌آوری متریک‌ها از DSO PMDAها روی میزبان محلی بدون PMCD. همچنین ببینید: -K.
-m, --include-labels: گنجاندن برچسب‌های متریک PCP در خروجی..TP -O origin, --origin=origin هنگام گزارش معیارهای آرشیو شده، گزارش را از origin درون بازه زمانی آغاز می‌کند (رجوع کنید به -S و -T). برای توضیحات کامل درباره نحو origin به PCPIntro(1) مراجعه کنید.
-P precision, --precision=precision: استفاده از precision برای مقادیر خروجی عددی غیر صحیح (اعشاری). پیش‌فرض استفاده از ۳ رقم اعشار است (در صورت امکان). این گزینه مشخصات احتمالی اختصاصی هر معیار را بازنویسی نخواهد کرد.
-q scale, --count-scale=scale: واحد/مقیاس برای معیارهای شمارشی؛ مقادیر ممکن شامل count x 10^-1، count، count x 10، count x 10^2 و به همین ترتیب از 10^-8 تا 10^7 است. (این مقادیر در حال حاضر به فاصله حساس هستند.) این گزینه مشخصات احتمالی اختصاصی هر معیار را بازنویسی نخواهد کرد. همچنین رجوع کنید به pmParseUnitsStr(3).
-Q scale, --count-scale-force=scale: مشابه -q اما این گزینه مشخصات اختصاصی هر معیار را بازنویسی خواهد کرد.
-r, --raw: نمایش مقادیر خام معیارها؛ شمارنده‌های تجمعی به نرخ تبدیل نمی‌شوند. این گزینه مشخصات احتمالی اختصاصی هر معیار را بازنویسی خواهد کرد.
-R, --raw-prefer: مشابه -r اما این گزینه مشخصات اختصاصی هر معیار را بازنویسی نخواهد کرد.
-s samples, --samples=samples: آرگومان samples تعداد نمونه‌هایی را که باید دریافت و گزارش شوند مشخص می‌کند. اگر samples برابر با 0 باشد یا -s مشخص نشده باشد، pcp2xlsx به‌طور پیوسته (در حالت زمان‌واقعی) یا تا انتهای مجموعه‌ی آرشیوهای PCP (در حالت آرشیو) به نمونه‌برداری و گزارش‌دهی ادامه خواهد داد. همچنین رجوع کنید به -T.
-S starttime, --start=starttime: هنگام گزارش معیارهای آرشیو شده، گزارش به رکوردهایی محدود خواهد شد که در زمان starttime یا پس از آن ثبت شده باشند. برای توضیحات کامل درباره نحو starttime به PCPIntro(1) مراجعه کنید.
-t interval, --interval=interval: تنظیم interval (بازه زمانی) گزارش‌دهی به مقداری غیر از پیش‌فرضِ ۱ ثانیه. آرگومان interval از نحو شرح داده شده در PCPIntro(1) پیروی می‌کند و در ساده‌ترین حالت می‌تواند یک عدد صحیح بدون علامت باشد (واحد ضمنی در این حالت، ثانیه است). همچنین گزینه -T را ببینید.
-T endtime, --finish=endtime: هنگام گزارش معیارهای آرشیو شده، گزارش به رکوردهایی محدود خواهد شد که در زمان endtime یا پیش از آن ثبت شده باشند. برای توضیحات کامل درباره نحو endtime به PCPIntro(1) مراجعه کنید.

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

-v, --omit-flat: تنها معیارهای مجموعه‌مقداری دارای نمونه (مانند disk.dev.read) گزارش شوند و معیارهای تک‌مقداریِ «مسطح» بدون نمونه (مانند kernel.all.sysfork) نادیده گرفته شوند. رجوع کنید به -i و -I.
-V, --version: نمایش شماره نسخه و خروج.
-y scale, --time-scale=scale: واحد/مقیاس برای معیارهای زمانی؛ مقادیر ممکن شامل nanosec، ns، microsec، us، millisec، ms و به همین ترتیب تا hour، hr است. این گزینه مشخصات احتمالی اختصاصی هر معیار را بازنویسی نخواهد کرد. همچنین رجوع کنید به pmParseUnitsStr(3).
-Y scale, --time-scale-force=scale: مشابه -y اما این گزینه مشخصات اختصاصی هر معیار را بازنویسی خواهد کرد.
-z, --hostzone: استفاده از منطقه زمانی محلیِ میزبانی که منبع معیارهای کارایی است، همان‌طور که با گزینه‌های -h یا -a مشخص می‌شود. پیش‌فرض استفاده از منطقه زمانی میزبان محلی است.
-Z timezone, --timezone=timezone: استفاده از timezone برای تاریخ و زمان. timezone در قالب متغیر محیطی TZ است، همان‌گونه که در environ(7) شرح داده شده است. توجه داشته باشید که هنگام گنجاندن رشته منطقه زمانی در خروجی، آفست‌های UTC به سبک ISO 8601 استفاده می‌شوند (بنابراین عبارتی مانند -Z EST+5 به UTC-5 تبدیل خواهد شد).
-?, --help: نمایش پیام راهنما و خروج..SH "فایل‌ها (FILES)"
pcp2xlsx.conf: فایل پیکربندی pcp2xlsx (نگاه کنید به -c)
$PCP_SYSCONF_DIR/pmrep/*.conf: فایل‌های پیکربندی پیش‌فرض pmrep ارائه‌شده توسط سیستم

محیط PCP (PCP ENVIRONMENT)

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

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

همچنین ببینید (SEE ALSO)

PCPIntro(1)، mkaf(1)، pcp(1)، pcp2elasticsearch(1)، pcp2graphite(1)، pcp2influxdb(1)، pcp2json(1)، pcp2spark(1)، pcp2xml(1)، pcp2zabbix(1)، pmcd(1)، pminfo(1)، pmrep(1)، pmGetOptions(3)، pmLoadDerivedConfig(3)، pmParseUnitsStr(3)، pmRegisterDerived(3)، pmSpecLocalPMDA(3)، LOGARCHIVE(5)، pcp.conf(5)، pmrep.conf(5)، PMNS(5) و environ(7).