PCP2GRAPHITE(1) General Commands Manual PCP2GRAPHITE(1) نام (NAME) pcp2graphite - صادرکننده معیارهای کارایی از PCP به Graphite خلاصه دستور (SYNOPSIS) pcp2graphite [-5CGHIjLnrRvV?] [-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 text- port] [-g server] [-h host] [-i instances] [-J rank] [-K spec] [-N predicate] [-O origin] [-p pickle-port] [-P|-0 precision] [-q|-Q count- scale] [-s samples] [-S starttime] [-t interval] [-T endtime] [-x prefix] [-X pickle-protocol] [-y|-Y time-scale] metricspec [...] توضیحات (DESCRIPTION) دستور pcp2graphite ابزاری با قابلیت سفارشی‌سازی برای صدور معیارهای کارایی از PCP به Graphite است. هر معیار کارایی موجود، به‌صورت زنده یا بایگانی‌شده، سیستمی یا برنامه‌ای، می‌تواند با استفاده از آرگومان‌های خط فرمان یا یک فایل پیکربندی برای صدور انتخاب شود. دستور pcp2graphite ارتباط نزدیکی با pmrep(1) دارد. برای شرح metricspec پذیرفته‌شده در خط فرمان pcp2graphite، به pmrep(1) مراجعه کنید. برای شرح نحو فایل پیکربندی pcp2graphite.conf به pmrep.conf(5) مراجعه نمایید. این صفحه گزینه‌های اختصاصی pcp2graphite و تفاوت‌های فایل پیکربندی آن با pmrep.conf(5) را توصیف می‌کند. همچنین pmrep(1) چندین مثال کاربردی را فهرست می‌کند که بیشتر آن‌ها برای pcp2graphite نیز قابل استفاده هستند. تنها گزینه‌های خط فرمان ذکرشده در این صفحه پشتیبانی می‌شوند؛ سایر گزینه‌های موجود برای pmrep(1) پشتیبانی نمی‌شوند. گزینه‌های مشخص‌شده از طریق متغیرهای محیطی (به pmGetOptions(3) مراجعه کنید) مقادیر پیش‌فرض توکار متناظر را (در صورت وجود) بازنویسی می‌کنند. گزینه‌های فایل پیکربندی، متغیرهای محیطی متناظر را (در صورت وجود) بازنویسی می‌کنند. گزینه‌های خط فرمان، گزینه‌های فایل پیکربندی متناظر را (در صورت وجود) بازنویسی می‌کنند. فایل پیکربندی (CONFIGURATION FILE) دستور pcp2graphite از یک فایل پیکربندی با نحو توصیف‌شده در 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 برای سازگاری شناسایی می‌شوند اما نادیده گرفته می‌شوند. گزینه‌های اختصاصی pcp2graphite graphite_host (رشته) مشخص کردن نام میزبان یا نشانی IP سرور مقصد Graphite. گزینه خط فرمان متناظر -g است. پیش‌فرض localhost است. graphite_port (عدد صحیح) مشخص کردن شماره درگاه سرور Graphite (متن ساده یا pickle). گزینه‌های خط فرمان متناظر -p و -E هستند. پیش‌فرض 2004 است. pickle (بولی) مشخص کردن استفاده یا عدم استفاده از پروتکل pickle. گزینه‌های خط فرمان متناظر -p و -E هستند. پیش‌فرض yes است. pickle_protocol (عدد صحیح) مشخص کردن نسخه پروتکل pickle. گزینه خط فرمان متناظر -X است. پیش‌فرض 0 است. prefix (رشته) مشخص کردن پیشوند معیارهای ارسالی به سرور. گزینه خط فرمان متناظر -x است. پیش‌فرض pcp. است. گزینه‌ها (OPTIONS) گزینه‌های خط فرمان موجود عبارتند از: -0 precision, --precision-force=precision مانند -P است، اما این گزینه مشخصات تعیین‌شده برای هر معیار را بازنویسی خواهد کرد. -4 action, --names-change=action اقدام (action) مورد نظر هنگام دریافت رویداد تغییر نام معیارها در حین نمونه‌برداری را مشخص می‌کند. این رویدادها زمانی رخ می‌دهند که یک PMDA مدتی پس از راه‌اندازی، معیارهای جدیدی کشف کرده و به ابزارهای کلاینت در حال اجرا مانند pcp2graphite اطلاع دهد. مقادیر معتبر برای action عبارتند از update (تازه‌سازی معیارهای در حال نمونه‌برداری)، ignore (نادیده گرفتن - رفتار پیش‌فرض) و abort (خروج از برنامه در صورت وقوع چنین رویدادی). -5, --ignore-unknown نادیده گرفتن خاموش هر نام معیاری که قابل حل نباشد. حداقل یک معیار باید پیدا شود تا ابزار شروع به کار کند. -8 limit, --limit-filter=limit محدود کردن نتایج به نمونه‌هایی با مقادیر بالاتر/پایین‌تر از limit. یک عدد صحیح مثبت، نمونه‌هایی با مقادیر مساوی یا بالاتر از حد را در گزارش لحاظ می‌کند. یک عدد صحیح منفی، نمونه‌هایی با مقادیر مساوی یا پایین‌تر از حد را در گزارش لحاظ می‌کند. مقدار صفر هیچ فیلتر محدودیتی اعمال نمی‌کند. این گزینه مشخصات احتمالی تعیین‌شده برای هر معیار را بازنویسی نخواهد کرد. همچنین ببینید: -J و -N. -9 limit, --limit-filter-force=limit مانند -8 است، اما این گزینه مشخصات تعیین‌شده برای هر معیار را بازنویسی خواهد کرد. -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 واحد/مقیاس (scale) برای معیارهای فضا (بایت)؛ مقادیر ممکن شامل bytes، Kbytes، KB، Mbytes، MB و غیره هستند. این گزینه مشخصات احتمالی تعیین‌شده برای هر معیار را بازنویسی نخواهد کرد. همچنین به pmParseUnitsStr(3) مراجعه کنید. -B scale, --space-scale-force=scale مانند -b است، اما این گزینه مشخصات تعیین‌شده برای هر معیار را بازنویسی خواهد کرد. -c config, --config=config مشخص کردن فایل یا پوشه پیکربندی (config) مورد استفاده. در صورتی که config یک پوشه باشد، تمام فایل‌های درون آن که به .conf ختم می‌شوند لحاظ خواهند شد. مقدار پیش‌فرض اولین مورد یافت‌شده از میان موارد زیر است: ./pcp2graphite.conf، $HOME/.pcp2graphite.conf، $HOME/pcp/pcp2graphite.conf و $PCP_SYSCONF_DIR/pcp2graphite.conf. برای جزئیات به بخش بالا و pmrep.conf(5) مراجعه کنید. --container=container واکشی معیارهای کارایی از کانتینر (container) مشخص‌شده، به‌صورت محلی یا از راه دور (به -h مراجعه کنید). -C, --check خروج پیش از گزارش هرگونه مقدار، اما پس از تجزیه پیکربندی و معیارها و چاپ هدرهای احتمالی. --daemonize اجرا به‌صورت پس‌زمینه (Daemonize) در زمان راه‌اندازی. -e derived, --derived=derived مشخص کردن معیارهای کارایی مشتق‌شده (derived). اگر derived با یک اسلش («/») یا با یک نقطه («.») شروع شود، به عنوان یک فایل پیکربندی معیارهای مشتق‌شده PCP تفسیر خواهد شد؛ در غیر این صورت به عنوان عبارات معیارهای مشتق‌شده جداشده با کاما یا نقطه‌ویرگول تفسیر می‌شود. برای شرح کامل معیارهای مشتق‌شده و فایل‌های پیکربندی معیارهای مشتق‌شده PCP به pmLoadDerivedConfig(3) و pmRegisterDerived(3) مراجعه کنید. متناوباً، استفاده از نحو پیکربندی pmrep.conf(5) امکان تعریف معیارهای مشتق‌شده را به عنوان بخشی از مجموعه‌معیارها فراهم می‌کند. در صورت بروز مشکل در معیارهای مشتق‌شده، صفحات راهنمای یادشده را به دقت بررسی کرده و اطمینان حاصل کنید که تمام معیارهای مورد نیاز، به‌ویژه هنگام استفاده از بایگانی‌ها، در دسترس هستند. از -Dderive برای مشاهده اطلاعات اشکال‌زدایی اضافی درباره تجزیه معیارهای مشتق‌شده استفاده کنید. -E port, --text-port=port درگاه متن ساده (port) سرور Graphite. استفاده از این گزینه پروتکل pickle را غیرفعال می‌کند. -g server, --graphite-host=server نام میزبان یا نشانی IP سرور مقصد Graphite. -G, --no-globals عدم درج معیارهای عمومی در گزارش (به pmrep.conf(5) مراجعه کنید). -h host, --host=host واکشی معیارهای کارایی از pmcd(1) روی host، به جای مقدار پیش‌فرض localhost. -H, --no-header چاپ نکردن هیچ‌گونه هدر. -i instances, --instances=instances بازیابی و گزارش فقط نمونه‌های (instances) مشخص‌شده معیار. به‌طور پیش‌فرض تمام نمونه‌ها، اعم از موجود و آینده، گزارش می‌شوند. برای شرح کامل این گزینه به pmrep(1) مراجعه کنید. -I, --ignore-incompat نادیده گرفتن معیارهای ناسازگار. به‌طور پیش‌فرض معیارهای ناسازگار (یعنی نوع آن‌ها پشتیبانی نمی‌شود یا طبق درخواست مقیاس‌پذیر نیستند) باعث می‌شوند pcp2graphite با یک پیام خطا متوقف شود. با این گزینه، تمامی معیارهای ناسازگار به‌صورت خاموش از گزارش حذف می‌شوند. این گزینه به‌ویژه هنگام درخواست گره‌های غیربرگ درخت PMNS برای گزارش‌دهی مفید است. -j, --live-filter انجام فیلتر زنده نمونه‌ها. این قابلیت امکان به دام انداختن تمام نمونه‌های نام‌گذاری‌شده را حتی در صورت راه‌اندازی مجدد فرآیندها در طول زمان فراهم می‌کند (برخلاف حالت بدون فیلتر زنده). انجام فیلتر زنده روی تعداد بسیار زیادی از نمونه‌ها سربار داخلی اضافه می‌کند، بنابراین رعایت احتیاط توصیه می‌شود. همچنین به -n مراجعه کنید. -J rank, --rank=rank محدود کردن نتایج به بالاترین/پایین‌ترین رتبه (rank) نمونه‌های معیارهای چندمقداره. یک عدد صحیح مثبت، نمونه‌هایی با بالاترین مقدار را در گزارش لحاظ می‌کند. یک عدد صحیح منفی، نمونه‌هایی با کمترین مقدار را در گزارش لحاظ می‌کند. مقدار صفر هیچ رتبه‌بندی انجام نمی‌دهد. رتبه‌بندی به معنای مرتب‌سازی نیست، به -6 مراجعه کنید. همچنین به -8 مراجعه کنید. -K spec, --spec-local=spec هنگام واکشی معیارها از یک بافت محلی (به -L مراجعه کنید)، گزینه -K می‌تواند برای کنترل DSO PMDAهایی که باید قابل دسترسی باشند استفاده شود. آرگومان spec از نحو توصیف‌شده در pmSpecLocalPMDA(3) پیروی می‌کند. می‌توان از بیش از یک گزینه -K استفاده کرد. -L, --local-PMDA استفاده از یک بافت محلی برای جمع‌آوری معیارها از DSO PMDAها روی میزبان محلی بدون PMCD. همچنین به -K مراجعه کنید. -n, --invert-filter انجام رتبه‌بندی پیش از فیلتر زنده. به‌طور پیش‌فرض، فیلتر زنده نمونه‌ها (در صورت درخواست، به -j مراجعه کنید) پیش از رتبه‌بندی نمونه‌ها (در صورت درخواست، به -J مراجعه کنید) رخ می‌دهد. با این گزینه، منطق معکوس شده و رتبه‌بندی پیش از فیلتر زنده انجام می‌شود. -N predicate, --predicate=predicate مشخص کردن فهرستی جداشده با کاما از معیارهای مرجع فیلتر گزاره‌ای (predicate). به‌طور پیش‌فرض، رتبه‌بندی (به -J مراجعه کنید) برای هر معیار به‌صورت جداگانه انجام می‌شود. با گزاره‌ها، رتبه‌بندی فقط برای معیارهای گزاره‌ای مشخص‌شده انجام خواهد شد. هنگام گزارش‌دهی، بقیه معیارهایی که دامنه نمونه یکسانی (به PCPIntro(1) مراجعه کنید) با گزاره دارند، فقط شامل بالاترین/پایین‌ترین رتبه نمونه‌های گزاره متناظر خواهند بود. رتبه‌بندی به معنای مرتب‌سازی نیست، به -6 مراجعه کنید. به عنوان مثال، با استفاده از proc.memory.rss (اندازه حافظه مقیم فرآیند) به عنوان معیار predicate همراه با proc.io.total_bytes و mem.util.used به عنوان معیارهای گزارش‌دهی، فقط فرآیندهایی که بیشترین/کمترین (طبق -J) حافظه را مصرف می‌کنند، هنگام گزارش کل بایت‌های نوشته‌شده توسط فرآیندها لحاظ خواهند شد. از آنجا که mem.util.used یک معیار تک‌مقداره است (و بنابراین دامنه نمونه یکسانی با معیارهای مرتبط با فرآیند ندارد)، طبق معمول گزارش خواهد شد. -O origin, --origin=origin هنگام گزارش معیارهای بایگانی‌شده، شروع گزارش‌دهی در مبدأ زمانی origin درون پنجره زمانی (به -S و -T مراجعه کنید). برای شرح کامل نحو origin به PCPIntro(1) مراجعه کنید. -p port, --pickle-port=port درگاه پروتکل pickle سرور Graphite. استفاده از این گزینه پروتکل pickle را فعال می‌کند. -P precision, --precision=precision استفاده از دقت اعشار (precision) برای مقادیر عددی غیرصحیح در خروجی. حالت پیش‌فرض استفاده از ۳ رقم اعشار است (در صورت کاربرد). این گزینه مشخصات احتمالی تعیین‌شده برای هر معیار را بازنویسی نخواهد کرد. -q scale, --count-scale=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 مشخص نشده باشد، pcp2graphite به‌صورت پیوسته (در حالت بلادرنگ) یا تا پایان مجموعه بایگانی‌های 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) مراجعه کنید. هنگامی که برای تعیین زمان اجرا پیش از خروج pcp2graphite استفاده می‌شود، اگر هیچ samples داده نشده باشد (به -s مراجعه کنید)، تعداد نمونه‌های گزارش‌شده به interval بستگی دارد (به -t مراجعه کنید). اگر samples مشخص شده باشد، آن‌گاه interval طوری تنظیم می‌شود که امکان گزارش samples در طول زمان اجرا فراهم گردد. در صورتی که هر سه گزینه -T، -s و -t مشخص شده باشند، endtime زمان واقعی اجرای pcp2graphite را تعیین می‌کند. -v, --omit-flat گزارش فقط معیارهای چندمقداره دارای نمونه (مانند disk.dev.read) و صرف‌نظر از معیارهای تک‌مقداره «تخت» بدون نمونه (مانند kernel.all.sysfork). به -i و -I مراجعه کنید. -V, --version نمایش شماره نسخه و خروج. -x prefix, --prefix=prefix پیشوند (prefix) معیارها برای مقادیر اندازه‌گیری‌شده ارسالی به سرور. -X protocol, --pickle-protocol=protocol شماره نسخه پروتکل pickle (protocol). -y scale, --time-scale=scale واحد/مقیاس (scale) برای معیارهای زمان؛ مقادیر ممکن شامل nanosec، ns، microsec، us، millisec، ms و غیره تا hour، hr هستند. این گزینه مشخصات احتمالی تعیین‌شده برای هر معیار را بازنویسی نخواهد کرد. همچنین به pmParseUnitsStr(3) مراجعه کنید. -Y scale, --time-scale-force=scale مانند -y است، اما این گزینه مشخصات تعیین‌شده برای هر معیار را بازنویسی خواهد کرد. -?, --help نمایش پیام راهنما و خروج. فایل‌ها (FILES) pcp2graphite.conf فایل پیکربندی pcp2graphite (به -c مراجعه کنید) $PCP_SYSCONF_DIR/pmrep/*.conf فایل‌های پیکربندی پیش‌فرض سیستم برای pmrep محیط PCP (PCP ENVIRONMENT) متغیرهای محیطی با پیشوند PCP_ برای پارامتربندی نام فایل‌ها و دایرکتوری‌های مورد استفاده PCP به کار می‌روند. در هر نصب، فایل /etc/pcp.conf حاوی مقادیر محلی برای این متغیرها است. متغیر $PCP_CONF می‌تواند برای مشخص کردن یک فایل پیکربندی جایگزین استفاده شود، همان‌طور که در pcp.conf(5) توصیف شده است. برای متغیرهای محیطی مؤثر بر ابزارهای PCP، به pmGetOptions(3) مراجعه کنید. به‌ویژه، متغیر PCP_DISCRETE_ONCE می‌تواند طوری تنظیم شود که تضمین کند مقادیر معیارهای گسسته فقط یک‌بار گزارش شوند، مگر اینکه در نقطه‌ای تغییر کنند. گزینه‌های اشکال‌زدایی (DEBUGGING OPTIONS) گزینه -D یا --debug خروجی عیب‌یابی‌های اضافی را در stderr برای کمک به تفکیک و رفع مشکلات فعال می‌کند، اگرچه این اطلاعات گاهی مبهم است و در درجه اول برای راهنمایی توسعه‌دهندگان در نظر گرفته شده است تا کاربران نهایی. آرگومان debug فهرستی جداشده با کاما از گزینه‌های اشکال‌زدایی است؛ از pmdbg(1) همراه با گزینه -l برای دریافت فهرستی از گزینه‌های اشکال‌زدایی موجود و معانی آن‌ها استفاده کنید. همچنین ببینید (SEE ALSO) PCPIntro(1), mkaf(1), pcp(1), pcp2elasticsearch(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). Performance Co-Pilot PCP PCP2GRAPHITE(1)