PCP2ELASTICSEARCH(1) General Commands Manual PCP2ELASTICSEARCH(1)

pcp2elasticsearch - صادرکننده معیارهای کارایی از PCP به Elasticsearch

pcp2elasticsearch [-5CGHIjLmnrRvV?] [-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] [-g URL] [-h host] [-i instances] [-J rank] [-K spec] [-N predicate] [-O origin] [-p type] [-P|-0 precision] [-q|-Q count-scale] [-s samples] [-S starttime] [-t interval] [-T endtime] [-x index] [-X hostid] [-y|-Y time-scale] metricspec [...]

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

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

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

گزینه‌های تعیین‌شده از طریق متغیرهای محیطی (نگاه کنید به pmGetOptions(3)) بر مقادیر پیش‌فرض داخلی متناظر (در صورت وجود) اولویت دارند. گزینه‌های فایل پیکربندی بر متغیرهای محیطی متناظر (در صورت وجود) مقدم هستند. گزینه‌های خط فرمان نیز بر گزینه‌های فایل پیکربندی متناظر (در صورت وجود) اولویت دارند..SH "فایل پیکربندی (CONFIGURATION FILE)" دستور pcp2elasticsearch از یک فایل پیکربندی با ساختار نحوی شرح داده‌شده در 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، include_labels، precision، precision_force، count_scale، count_scale_force، space_scale، space_scale_force، time_scale، time_scale_force. بقیه گزینه‌های pmrep.conf برای سازگاری شناسایی می‌شوند، اما نادیده گرفته خواهند شد.

es_server (رشته)

نشانی اینترنتی (URL) سنجه‌های سرور Elasticsearch مقصد را مشخص می‌کند. گزینهٔ خط فرمان متناظر -g است. پیش‌فرض http://localhost:9200 است.

es_auth (رشته)

نام کاربری مورد استفاده برای درخواست‌های Elasticsearch را مشخص می‌کند. پیش‌فرض none است.

es_password (رشته)

گذرواژهٔ مورد استفاده برای درخواست‌های Elasticsearch را مشخص می‌کند. پیش‌فرض none است.

es_index (رشته)

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

es_hostid (رشته)

شناسهٔ میزبان (host-id) مورد استفاده در Elasticsearch را برای اندازه‌گیری‌ها مشخص می‌کند. گزینهٔ خط فرمان متناظر -X است. پیش‌فرض، میزبان منبع سنجه‌ها است.

es_search_type (رشته)

نوع جستجوی (search type) مورد استفاده در Elasticsearch را برای اندازه‌گیری‌ها مشخص می‌کند. گزینهٔ خط فرمان متناظر -p است. پیش‌فرض pcp-metric است.

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

-0 precision, --precision-force=precision
مانند -P است، اما این گزینه مشخصات اختصاصی هر سنجه را بازنویسی خواهد کرد.
-4 action, --names-change=action
مشخص می‌کند که هنگام دریافت رویداد تغییر نام سنجه‌ها در زمان نمونه‌برداری، چه action (عملیاتی) انجام شود. این رویدادها زمانی رخ می‌دهند که یک PMDA مدتی پس از راه‌اندازی، سنجه‌های جدیدی را کشف کرده و به ابزارهای کلاینت در حال اجرا مانند pcp2elasticsearch اطلاع می‌دهد. مقادیر معتبر برای action عبارتند از update (تازه‌سازی سنجه‌های در حال نمونه‌برداری)، ignore (کاری انجام نده - رفتار پیش‌فرض) و abort (خروج از برنامه در صورت وقوع چنین رویدادی).
-5, --ignore-unknown
نادیده گرفتن بدون هشدار هر نام سنجه‌ای که قابل حل (resolve) نباشد. برای شروع به کار ابزار، حداقل باید یک سنجه یافت شود.
-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 folio ایجادشده توسط ابزارهایی مانند pmchart(1) یا، با فراوانی کمتر، به‌صورت دستی با mkaf(1).
واحد/مقیاس برای سنجه‌های فضا (بایت)؛ مقادیر ممکن شامل bytes، Kbytes، KB، Mbytes، MB و مواردی از این دست است. این گزینه مشخصات احتمالی اختصاصی هر سنجه را بازنویسی نخواهد کرد. همچنین ببینید pmParseUnitsStr(3).
مانند -b است، اما این گزینه مشخصات اختصاصی هر سنجه را بازنویسی خواهد کرد.
مشخص کردن فایل یا دایرکتوری config مورد استفاده. در صورتی که config یک دایرکتوری باشد، تمام فایل‌های درون آن که به .conf ختم می‌شوند لحاظ خواهند شد. پیش‌فرض، نخستین مورد یافت‌شده از بین موارد زیر است: ./pcp2elasticsearch.conf، $HOME/.pcp2elasticsearch.conf، $HOME/pcp/pcp2elasticsearch.conf و $PCP_SYSCONF_DIR/pcp2elasticsearch.conf. برای جزئیات بیشتر، به بخش بالا و pmrep.conf(5) مراجعه کنید.
واکشی سنجه‌های کارایی از container مشخص‌شده، به‌صورت محلی یا از راه دور (ببینید -h)..TP -C, --check خروج پیش از گزارش هرگونه مقدار، اما پس از تجزیهٔ پیکربندی و سنجه‌ها و چاپ سرآیندهای احتمالی.
اجرا به‌صورت دیمن (daemon) در زمان راه‌اندازی.
مشخص کردن سنجه‌های کارایی derived (اشتقاقی). اگر derived با یک اسلش (``/'') یا با یک نقطه (``.'') آغاز شود، به‌صورت یک فایل پیکربندی سنجه‌های اشتقاقی PCP تفسیر خواهد شد، در غیر این صورت به‌صورت عبارات سنجه‌های اشتقاقی جداشده با کاما یا نقطه‌ویرگول تفسیر می‌شود. برای توضیحات کامل دربارهٔ سنجه‌های اشتقاقی و فایل‌های پیکربندی سنجه‌های اشتقاقی PCP به pmLoadDerivedConfig(3) و pmRegisterDerived(3) مراجعه کنید. همچنین، استفاده از نحو پیکربندی pmrep.conf(5) امکان تعریف سنجه‌های اشتقاقی را به‌صورت بخشی از مجموعه سنجه‌ها (metricsets) فراهم می‌کند.

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

URL سنجهٔ سرور Elasticsearch مقصد.
شامل نکردن سنجه‌های سراسری در گزارش‌دهی (ببینید: pmrep.conf(5)).
واکشی سنجه‌های کارایی از pmcd(1) روی host، به‌جای localhost پیش‌فرض.
هیچ سرآیندی چاپ نشود.
تنها دریافت و گزارش instances (نمونه‌های) مشخص‌شدهٔ سنجه. به‌طور پیش‌فرض، تمام نمونه‌ها، اعم از فعلی و آینده، گزارش می‌شوند.

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

نادیده گرفتن سنجه‌های ناسازگار. به‌طور پیش‌فرض، سنجه‌های ناسازگار (یعنی نوع آن‌ها پشتیبانی نمی‌شود یا مطابق درخواست نمی‌توان آن‌ها را مقیاس‌بندی کرد) باعث می‌شوند که pcp2elasticsearch با یک پیام خطا متوقف شود. با این گزینه، تمام سنجه‌های ناسازگار بدون هشدار از گزارش‌دهی حذف می‌شوند. این امر ممکن است به‌ویژه هنگام درخواست گره‌های غیربرگ درخت PMNS برای گزارش‌دهی مفید باشد.
انجام پالایش زندهٔ نمونه‌ها (live filtering). این ویژگی اجازه می‌دهد همهٔ نمونه‌های نام‌گذاری‌شده ثبت شوند، حتی اگر فرایندها در نقطه‌ای مجدداً راه‌اندازی شوند (برخلاف حالت بدون پالایش زنده). انجام پالایش زنده بر روی تعداد بسیار زیادی از نمونه‌ها سربار داخلی ایجاد می‌کند، بنابراین احتیاط کاربر توصیه می‌شود. همچنین ببینید: -n.
محدود کردن نتایج به بالاترین/پایین‌ترین نمونه‌های ranked (رتبه‌بندی‌شده) از سنجه‌های با مقادیر چندگانه (set-valued). یک عدد صحیح مثبت، نمونه‌هایی با بالاترین مقدار را در گزارش لحاظ می‌کند. یک عدد صحیح منفی، نمونه‌هایی با پایین‌ترین مقدار را در گزارش لحاظ می‌کند. مقدار صفر هیچ رتبه‌بندی‌ای انجام نمی‌دهد. رتبه‌بندی به معنای مرتب‌سازی نیست، ببینید: -6. همچنین ببینید: -8.
هنگام واکشی سنجه‌ها از یک بافت محلی (ببینید: -L)، می‌توان از گزینهٔ -K برای کنترل آن دسته از PMDAهای DSO که باید در دسترس قرار گیرند، استفاده کرد. آرگومان spec از نحو شرح داده شده در pmSpecLocalPMDA(3) پیروی می‌کند. می‌توان از بیش از یک گزینهٔ -K استفاده کرد.
استفاده از یک بافت محلی برای جمع‌آوری سنجه‌ها از DSO PMDAها روی میزبان محلی بدون PMCD. همچنین ببینید: -K.
گنجاندن برچسب‌های سنجه‌های PCP در خروجی.
انجام رتبه‌بندی پیش از پالایش زنده. به‌طور پیش‌فرض، پالایش زندهٔ نمونه‌ها (در صورت درخواست، ببینید: -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) مراجعه کنید.
type جستجوی Elasticsearch برای اندازه‌گیری‌ها.
استفاده از precision برای مقادیر خروجی عددی غیرصحیح (اعشاری). پیش‌فرض، استفاده از ۳ رقم اعشار است (در صورت امکان). این گزینه مشخصات احتمالی به ازای هر سنجه را لغو نخواهد کرد..TP -q scale, --count-scale=scale واحد/مقیاس برای معیارهای شمارشی، مقادیر ممکن شامل count x 10^-1، count، count x 10، count x 10^2، و به همین ترتیب از 10^-8 تا 10^7 است. (این مقادیر در حال حاضر به فاصله حساس هستند.) این گزینه مشخصات احتمالی به ازای هر معیار را بازنویسی نخواهد کرد. همچنین ببینید: pmParseUnitsStr(3).
مشابه -q اما این گزینه مشخصات به ازای هر معیار را بازنویسی خواهد کرد.
نمایش مقادیر خام معیارها بدون تبدیل شمارنده‌های تجمعی به نرخ. این گزینه مشخصات احتمالی به ازای هر معیار را بازنویسی خواهد کرد.
مشابه -r اما این گزینه مشخصات به ازای هر معیار را بازنویسی نخواهد کرد.
آرگومان samples تعداد نمونه‌هایی را که باید دریافت و گزارش شوند مشخص می‌کند. اگر samples برابر 0 باشد یا -s مشخص نشده باشد، pcp2elasticsearch به‌صورت پیوسته (در حالت بلادرنگ) یا تا انتهای مجموعه بایگانی‌های PCP (در حالت بایگانی) نمونه‌برداری و گزارش خواهد کرد. همچنین ببینید: -T.
هنگام گزارش معیارهای بایگانی‌شده، گزارش محدود به رکوردهایی خواهد بود که در زمان starttime یا پس از آن ثبت شده‌اند. برای توضیحات کامل درباره نحو starttime به PCPIntro(1) مراجعه کنید.
تنظیم interval گزارش‌گیری روی مقداری غیر از مقدار پیش‌فرض ۱ ثانیه. آرگومان interval از نحو شرح داده شده در PCPIntro(1) پیروی می‌کند و در ساده‌ترین شکل می‌تواند یک عدد صحیح بدون علامت باشد (واحد ضمنی در این حالت ثانیه است). همچنین گزینهٔ -T را ببینید.
هنگام گزارش معیارهای بایگانی‌شده، گزارش محدود به رکوردهایی خواهد بود که در زمان endtime یا پیش از آن ثبت شده‌اند. برای توضیحات کامل درباره نحو endtime به PCPIntro(1) مراجعه کنید.

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

فقط معیارهای با مقادیر مجموعه‌ای (set-valued) دارای نمونه (مانند disk.dev.read) گزارش می‌شوند و از معیارهای تک‌مقداری «مسطح» (flat) بدون نمونه (مانند kernel.all.sysfork) صرف‌نظر می‌شود. گزینه‌های -i و -I را ببینید.
نمایش شماره نسخه و خروج.
index در Elasticsearch برای نام‌های معیارها.
hostid در Elasticsearch برای اندازه‌گیری‌ها.
واحد/مقیاس برای معیارهای زمانی، مقادیر ممکن شامل nanosec، ns، microsec، us، millisec، ms و به همین ترتیب تا hour، hr است. این گزینه مشخصات احتمالی به ازای هر معیار را بازنویسی نخواهد کرد. همچنین ببینید: pmParseUnitsStr(3).
مشابه -y اما این گزینه مشخصات به ازای هر معیار را بازنویسی خواهد کرد.
-?, --help
نمایش پیام راهنما و خروج..SH "قالب خروجی (OUTPUT FORMAT)" ابتدا، pcp2elasticsearch این تعریف نوع را به Elasticsearch ارسال می‌کند:

{
"mappings": {
"properties": {
"@timestamp": {
"type": "long"
},
"host-id": {
"type": "text"
}
}
}
}

سند واقعی داده‌های سنجه‌ها مشابه این مثال است:


{
"@host-id": "bozo",
"@timestamp": 1507637520,
"mem": {
"util": {
"used": 4525820,
"free": 3344000
}
},
"disk": {
"partitions": {
"@instances": [
{
"read": 1121,
"@id": "sda1"
},
{
"read": 77306,
"@id": "sda2"
},
{
"read": 131,
"@id": "sda3"
}
]
}
}
}

فایل پیکربندی pcp2elasticsearch (به -c مراجعه کنید)
$PCP_SYSCONF_DIR/pmrep/*.conf
فایل‌های پیکربندی پیش‌فرض pmrep ارائه‌شده توسط سیستم

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

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

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

گزینه -D یا --debug خروجی داده‌های عیب‌یابی تکمیلی را در stderr فعال می‌کند تا به ارزیابی مشکلات کمک کند، اگرچه این اطلاعات گاهی مبهم است و در وهله اول به جای کاربران نهایی، برای ارائه راهنمایی به توسعه‌دهندگان در نظر گرفته شده است. debug یک فهرست از گزینه‌های اشکال‌زدایی است که با کاما از هم جدا شده‌اند؛ از pmdbg(1) همراه با گزینه -l استفاده کنید تا فهرستی از گزینه‌های اشکال‌زدایی موجود و معانی آن‌ها را به دست آورید..SH "همچنین ببینید (SEE ALSO)" PCPIntro(1)، mkaf(1)، pcp(1)، pcp2graphite(1)، pcp2influxdb(1)، pcp2json(1)، pcp2spark(1)، pcp2xlsx(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).

PCP Performance Co-Pilot