نقطة نهاية مقاييس Prometheus - ClickHouse Documentation

يعرض ClickHouse مقاييسه الخاصة على منفذ مخصص بتنسيق Prometheus النصي، ليتمكن خادم Prometheus من سحبها. أما لتخزين مقاييس Prometheus في ClickHouse والاستعلام عنها باستخدام PromQL، فراجع واجهة برمجة تطبيقات HTTP لـ Prometheus وPromQL.

إذا كنت تستخدم ClickHouse Cloud، فيمكنك عرض المقاييس لـ Prometheus عبر تكامل Prometheus.

تهيئة منفذ المقاييس

هيّئ منفذًا مخصصًا عندما يحتاج خادم Prometheus إلى سحب مقاييس ClickHouse الخاصة:

<prometheus>
    <port>9363</port>
    <endpoint>/metrics</endpoint>
    <metrics>true</metrics>
    <asynchronous_metrics>true</asynchronous_metrics>
    <events>true</events>
    <errors>true</errors>
    <histograms>true</histograms>
    <dimensional_metrics>true</dimensional_metrics>
</prometheus>

تهيئة المعالِجات الموسّعة

يمكن استخدام القسم <prometheus.handlers> لإنشاء معالِجات موسّعة أكثر على المنفذ نفسه. هذا القسم مشابه للقسم <http_handlers> لكنه يعمل مع بروتوكولات prometheus:

<prometheus>
    <port>9363</port>
    <handlers>
        <my_rule_1>
            <url>/metrics</url>
            <handler>
                <type>expose_metrics</type>
                <metrics>true</metrics>
                <asynchronous_metrics>true</asynchronous_metrics>
                <events>true</events>
                <errors>true</errors>
                <histograms>true</histograms>
                <dimensional_metrics>true</dimensional_metrics>
                <labels>
                    <environment>production</environment>
                    <shard from_env="SHARD_NAME"></shard>
                </labels>
            </handler>
        </my_rule_1>
    </handlers>
</prometheus>

الإعدادات

للاطلاع على السلوك الكامل لهذه الإعدادات، راجع قسم Prometheus في مرجع إعدادات الخادم.

الاسم	القيمة الافتراضية	الوصف
`port`	لا شيء	المنفذ الذي يقدّم مقاييس ClickHouse.
`endpoint`	`/metrics`	نقطة نهاية HTTP لسحب المقاييس. تبدأ بـ `/`. لا ينبغي استخدامها مع قسم `<handlers>`.
`url` / `headers` / `method`	لا شيء	عوامل تصفية تُستخدم للعثور على المعالج المطابق للطلب. مشابهة للحقول التي تحمل الأسماء نفسها في قسم `<http_handlers>`.
`info`	true	يعرض مقياس `ClickHouse_Info` من نوع gauge مع تسميات هوية الخادم (`name`، `version`، `version_describe`، `version_major`، `version_minor`، `version_patch`).
`metrics`	true	يعرض المقاييس من `system.metrics`.
`asynchronous_metrics`	true	يعرض المقاييس من `system.asynchronous_metrics`.
`events`	true	يعرض المقاييس من `system.events`.
`errors`	true	يعرض أعداد الأخطاء من `system.errors`.
`histograms`	true	يعرض المقاييس من `system.histogram_metrics`.
`dimensional_metrics`	true	يعرض المقاييس من `system.dimensional_metrics`.
`labels`	لا شيء	تسميات ثابتة تُضاف إلى كل مقياس معروض. يحدد كل عنصر فرعي تسمية واحدة: اسم العنصر هو اسم التسمية (ويجب أن يطابق `[a-zA-Z_][a-zA-Z0-9_]*`) وقيمة العنصر هي قيمة التسمية. تدعم قيم التسميات عمليات الاستبدال القياسية في الإعداد مثل السمة `from_env`. يُرفض اسم التسمية إذا بدأ بـ `__` (محجوز من قِبل Prometheus)، أو إذا تعارض مع تسمية تكتبها نقطة النهاية هذه بالفعل لأحد أقسامها المفعّلة. وبالتالي فإن المجموعة المحجوزة تتبع نطاق التصدير النشط لنقطة النهاية: `le` عندما يكون `histograms` مفعّلًا؛ وتسميات `ClickHouse_Info` (`name`، `version`، `version_describe`، `version_major`، `version_minor`، `version_patch`) عندما يكون `info` مفعّلًا؛ وأي تسمية تستخدمها عائلة مقاييس مُدرَّج تكراري أو مقاييس بُعدية معروضة (على سبيل المثال، `group` أو `direction` أو `operation_type`) عندما يكون `histograms` أو `dimensional_metrics` مفعّلًا. ولأن ذلك يتوقف على ما تعرضه نقطة النهاية فعليًا، فقد يكون الاسم صالحًا في نقطة نهاية ومرفوضًا في أخرى.

التحقق من الـ نقطة نهاية

curl http://127.0.0.1:9363/metrics

آخر تعديل في ٢٦ سبتمبر ٢٠٢٦