Prometheus: नियम स्वरूपण उपकरण।

:+1:* ​​:100:

हाँ, यह बहुत अच्छा होगा। टिप्पणियों को संरक्षित करना सबसे बड़ी (और मूल रूप से केवल) समस्या है। और कई पंक्तियों में भावों को विभाजित करने के तरीके पर सहमति।

क्या हम इसे प्रोमटूल में जोड़ने के बीच में नहीं हैं?

संबंधित: https://github.com/prometheus/prometheus/pull/1779

कुछ अवलोकन:

• 2.x नियम प्रारूप (YAML एम्बेडिंग PromQL) के साथ, हम चाहते हैं कि यह YAML फ़ाइलों पर भी कार्य करे।
• इसे YAML और PromQL में दोनों टिप्पणियों को संरक्षित करना चाहिए।
• इंडेंटेशन महत्वपूर्ण है (न केवल लाइन ब्रेक)।
• यह देखना होगा कि क्या इनपुट में कुछ लाइन ब्रेक आउटपुट में संरक्षित किए जाने चाहिए (cf. gofmt यह कैसे करता है)।
• जहां कहीं भी एक नियम का प्रतिपादन किया जाता है, वही स्वरूपण लागू होना चाहिए, विशेष रूप से प्रोमेथियस वेब UI के _Alerts_ और _Rules_ टैब पर। इसका तात्पर्य है कि एएसटी को टिप्पणियां रखने की जरूरत है (और संभवतः कुछ लाइन ब्रेक, पिछला बिंदु देखें)।

इसे YAML में दोनों टिप्पणियों को सुरक्षित रखना चाहिए

हमारी वर्तमान वाईएएमएल लाइब्रेरी ऐसा नहीं करती है, लेकिन "जल्द ही" की उम्मीद कर रही है।

मैं इसे अपने जीएसओसी प्रस्ताव में शामिल करना चाहता हूं। @ ब्रायन-ब्राज़ील, क्या आप उस वाईएएमएल लाइब्रेरी से लिंक कर सकते हैं जिसका आप जिक्र कर रहे हैं?

https://github.com/go-yaml/yaml , लेकिन मैं इसे केवल PromQL तक सीमित कर दूंगा क्योंकि यह खड़ा है।

@ ब्रायन-ब्राज़ील लेकिन चूंकि नियमों से प्रोमक्यूएल हमेशा वाईएएमएल फाइलों में एम्बेडेड होता है, इसलिए कम से कम वाईएएमएल टिप्पणियों को संरक्षित करना पड़ता है, है ना? अन्यथा उपकरण बहुत उपयोगी नहीं होगा क्योंकि कोई भी अपनी टिप्पणियों को प्रारूपण के लाभ से खोना नहीं चाहता है।

यह अच्छा होगा, लेकिन इसके बिना हमें लाभ मिल सकता है। मैं जीएसओसी परियोजना के लिए अस्पष्ट समयरेखा वाली किसी चीज पर निर्भर नहीं होना चाहता।

आइए PromQL भाग से शुरू करते हैं। लाइब्रेरी द्वारा टिप्पणियों और |2 मल्टीलाइन स्ट्रिंग्स के लिए इंडेंटेशन संकेत जैसी चीजों को संरक्षित करने के बाद YAML भाग लगभग तुच्छ होना चाहिए।

ठीक!

YAML लाइब्रेरी का v3 समाप्त हो गया है, जिसे इन सब के लिए अनुमति देनी चाहिए।

FYI करें कॉन्फ़िगरेशन में पूरी तरह से पठनीय नियम

(
    kube_job_status_failed > 0
    UNLESS kube_job_status_succeeded > 0
)
* on (namespace, job_name) group_left(maintainer) label_replace(kube_job_labels, "maintainer", "$1", "label_maintainer", "(.*)")
* on (namespace, job_name) group_left(pager) label_replace(kube_job_labels, "pager", "$1", "label_pager", "(.*)")
* on (namespace, job_name) group_left(paging) label_replace(kube_job_labels, "paging", "$1", "label_paging", "(.*)")

वीएस वेब यूआई में इसका कचरा प्रतिनिधित्व

(kube_deployment_status_replicas_available
  / kube_deployment_spec_replicas * 100) * on(namespace, deployment) group_left(maintainer)
  label_replace(kube_deployment_labels, "maintainer", "$1", "label_maintainer",
  "(.*)") * on(namespace, deployment) group_left(pager) label_replace(kube_deployment_labels,
  "pager", "$1", "label_pager", "(.*)") * on(namespace,
  deployment) group_left(paging) label_replace(kube_deployment_labels, "paging",
  "$1", "label_paging", "(.*)") < 100

@sylr मुझे लगता है कि आपने वेब UI से कोई अन्य नियम पोस्ट किया है। भी @beorn7 मैं इस मुद्दे पर काम करना शुरू कर रहा हूं।

यहाँ यह आपके नियम के लिए मेरे लिए क्या दिखाता है:

(kube_job_status_failed
  > 0 unless kube_job_status_succeeded > 0) * on(namespace, job_name) group_left(maintainer)
  label_replace(kube_job_labels, "maintainer", "$1", "label_maintainer",
  "(.*)") * on(namespace, job_name) group_left(pager) label_replace(kube_job_labels,
  "pager", "$1", "label_pager", "(.*)") * on(namespace,
  job_name) group_left(paging) label_replace(kube_job_labels, "paging", "$1",
  "label_paging", "(.*)")

@geekodour हां, मैंने दो नियमों को मिलाया है।

चूंकि यह अभी भी खुला है और आगामी जीएसओसी के लिए परियोजना विचारों में जोड़ा गया है (https://github.com/cncf/soc#rule-formatting-tool) मैं जीएसओसी के दौरान इसे पूरा करने पर काम करना चाहता हूं। इस बारे में कोई हालिया अपडेट और अतिरिक्त जानकारी @codesome @brian-brazil @juliusv @geekodour @simonpasquier @sylr की सराहना की जाएगी ।
टिप्पणी और अन्य संदर्भ लिंक को पढ़ने से ऐसा लगता है कि अगली क्रिया बिंदु प्रोमक्यूएल एएसटी के साथ प्रोमक्यूएल अभिव्यक्ति के लिए एक फॉर्मेटर बना रहा है?

@haibeey उस दिशा में पहले ही कुछ प्रगति हुई है।

जब यह फ़ॉर्मेटर इस तरह के एक निर्माण शायद सबसे अच्छा हो सकता है कि पहले से ही लागू किया गया है के साथ शुरू करने के लिए होता है यहाँ और उचित सफेद स्थान और टिप्पणी हैंडलिंग जोड़ें।

यह भी अच्छा होगा, जब इस तरह की सुविधाओं को आगामी PromQL भाषा सर्वर के साथ एकीकृत किया जा सकता है। भाषा सर्वर कोड के अंदर YAML फ़ाइलों को प्रारूपित करने के लिए आवश्यक बहुत सी चीजें पहले ही लागू हो चुकी हैं, और इसमें से कुछ का पुन: उपयोग करना समझ में आता है।

ठीक है! धन्यवाद @slrtbtfs । मैं ASAP साझा किए गए लिंक को समझना शुरू कर दूंगा।

क्या मैं इस मुद्दे को उठा सकता हूं? इसे लागू करना पसंद करेंगे।

ऐसा लग रहा है कि @haibeey पहले से ही किसी तरह इस पर काम करने की योजना बना रहा है।

@roidelapluie मैंने पहले ही इसका एक हिस्सा पहले ही लागू कर दिया है। यह सिर्फ इतना है कि मैंने यहां उल्लेख नहीं किया था।

FYI करें कॉन्फ़िगरेशन में पूरी तरह से पठनीय नियम

(
    kube_job_status_failed > 0
    UNLESS kube_job_status_succeeded > 0
)
* on (namespace, job_name) group_left(maintainer) label_replace(kube_job_labels, "maintainer", "$1", "label_maintainer", "(.*)")
* on (namespace, job_name) group_left(pager) label_replace(kube_job_labels, "pager", "$1", "label_pager", "(.*)")
* on (namespace, job_name) group_left(paging) label_replace(kube_job_labels, "paging", "$1", "label_paging", "(.*)")

वीएस वेब यूआई में इसका कचरा प्रतिनिधित्व

(kube_deployment_status_replicas_available
  / kube_deployment_spec_replicas * 100) * on(namespace, deployment) group_left(maintainer)
  label_replace(kube_deployment_labels, "maintainer", "$1", "label_maintainer",
  "(.*)") * on(namespace, deployment) group_left(pager) label_replace(kube_deployment_labels,
  "pager", "$1", "label_pager", "(.*)") * on(namespace,
  deployment) group_left(paging) label_replace(kube_deployment_labels, "paging",
  "$1", "label_paging", "(.*)") < 100

क्या यह स्वरूपण शैली स्वीकार्य है? @codesome @juliusv @brian-brazil @beorn7
मैं इस शैली के आधार पर अपना प्रस्ताव लिख रहा हूं।

स्वरूपण के बाद अंतिम प्रतिनिधित्व पर चर्चा की जा सकती है और जीएसओसी अवधि के दौरान निर्णय लिया जा सकता है (शायद अब भी अगर कोई रखरखाव करना चाहता है, लेकिन मेरे पास इस समय इसकी समीक्षा करने के लिए बैंडविड्थ नहीं है)। मैं (सभी जीएसओसी उम्मीदवारों को) इस पर ध्यान केंद्रित करने का सुझाव दूंगा कि क्या आप इसे हासिल करेंगे।

https://prometheus.io/docs/practices/rules/ सर्वोत्तम प्रथाओं का उपयोग करता है।

मैंने goyacc व्याकरण के नियमों को थोड़ा बढ़ाकर टिप्पणियों को संरक्षित करने के लिए एक मोटा प्रोटोटाइप लिखा था। यहां प्रतिबद्ध करें https://github.com/haibeey/prometheus/commit/885566786ac20bfd400b2e7db470c92545919690

नियम फ़ाइल
वेब यूआई . में रिकॉर्डिंग नियम

यह सही नहीं लगता, ऑपरेटर अपनी लाइन पर नहीं हैं

ओह हां। वह प्रतिबद्ध स्वरूपण नहीं करता है। यह सिर्फ मुद्रण के लिए मूल्यांकन के बाद promql expr में टिप्पणियों को संरक्षित करने के लिए है।
पिछले संस्करण मूल्यांकन के बाद सभी टिप्पणियों पर ध्यान नहीं देते हैं।

मैंने goyacc व्याकरण के नियमों को थोड़ा बढ़ाकर टिप्पणियों को संरक्षित करने के लिए एक मोटा प्रोटोटाइप लिखा था। यहाँ कमिट करें [haibee@8855667]

टिप्पणियों को एएसटी में रखना एक उचित विचार की तरह लगता है।

मैंने वहां कार्यान्वयन के बारे में कुछ टिप्पणियां छोड़ी हैं।

https://prometheus.io/docs/practices/rules/ सर्वोत्तम प्रथाओं का उपयोग करता है।

कृपया लागू न करें:

sum without (instance)(instance_path:requests:rate5m{job="myjob"})

ऊपर

sum(instance_path:requests:rate5m{job="myjob"}) without (instance)

संशोधक को पहले समूहबद्ध करना सबसे अच्छा अभ्यास है, और पहले से ही हम इसे कैसे प्रिंट करते हैं - अन्यथा गैर-तुच्छ अभिव्यक्तियों को पढ़ना बहुत मुश्किल है।

हां, शुरू में इस बारे में मेरी मजबूत राय थी। पहले प्रोमेथियस ने केवल sum(x) by(y) क्योंकि यह मेरे लिए अंग्रेजी की तरह अधिक पढ़ता है और इसलिए मैंने इसे बहुत पसंद किया, लेकिन किसी भी गैर-तुच्छ x यह देखना वास्तव में कठिन हो जाता है कि आप किन आयामों पर एकत्र कर रहे हैं / रखना। काश मैंने इसे शुरुआत से ही sum by(y) (x) बना दिया होता और इसे एकमात्र कानूनी रूप बना दिया होता।

मुझे अभी भी बिल्कुल सटीक स्वरूपण sum by (y)(x) पसंद नहीं है और sum by(y) (x) (मेरे लिए बहुत अधिक समझ में आता है) पसंद करते हैं, यह सुनिश्चित नहीं है कि हमने दस्तावेज़ों में बाद वाले के लिए क्यों जाना चुना।

मुझे लगता है कि हर कोई इस बारे में अपनी राय का हकदार है, मैं व्यक्तिगत रूप से "सर्वोत्तम अभ्यास" को घृणित मानता हूं, लेकिन, जैसा कि सभी वाक्यविन्यास कानूनी हैं, कृपया एक को दूसरे पर लागू न करें।

promfmt टूल का संपूर्ण बिंदु, यदि लागू नहीं होता है, तो कम से कम एक निश्चित "कैनोनिकल" स्वरूपण का "समर्थन" करना है, बहुत कुछ gofmt , इसके पीछे तर्कों की एक पूरी स्ट्रिंग के साथ।

हाँ, gofmt का स्वरूपण किसी का पसंदीदा नहीं है, लेकिन कम से कम यह कई अलग-अलग लोगों के बजाय एक सुसंगत शैली बनाता है, जो अपने आप में एक मूल्य है।

एक साइड नोट के रूप में, यह जीएसओसी के लिए सक्रिय रूप से मांगा गया है। @haibeey मैं देख रहा हूँ कि आप भी

नई go-yamlv3 लाइब्रेरी में कमेंट प्रिजर्विंग पहले से ही बहुत अच्छी तरह से समर्थित है। कार्यान्वयन इतना निर्दोष है कि टिप्पणियों का कोई नुकसान नहीं है। इसलिए, हम बिना किसी चिंता के प्रोमेथियस कोड से स्वतंत्र तंत्र को संरक्षित रख सकते हैं।

ठीक है। मुझे लगता है कि यह मेरे प्रस्ताव जीएसओसी प्रस्ताव के मसौदे को साझा करने का समय है।

अंतिम मसौदे से पहले समीक्षाओं की सराहना की जाएगी। धन्यवाद

@ हरकिशन-सिंह टिप्पणियों के दो स्तर हैं: वाईएएमएल टिप्पणियां और प्रोमक्यूएल अभिव्यक्ति के भीतर टिप्पणियां। https://github.com/prometheus/prometheus/issues/21#issuecomment -604213849 PromQL वाले के बारे में बात कर रहा था (लेकिन YAML वाले भी संरक्षित करने के लिए अच्छे होंगे)।

नई go-yamlv3 लाइब्रेरी में कमेंट प्रिजर्विंग पहले से ही बहुत अच्छी तरह से समर्थित है। कार्यान्वयन इतना निर्दोष है कि टिप्पणियों का कोई नुकसान नहीं है। इसलिए, हम बिना किसी चिंता के प्रोमेथियस कोड से स्वतंत्र तंत्र को संरक्षित रख सकते हैं।

PromQL अभिव्यक्ति के मूल्यांकन के दौरान टिप्पणियों को हटा दिया जाता है।
उस ने कहा कि मुझे लगता है कि स्वरूपण केवल नियमों की फाइलों में ही नहीं बल्कि कुछ जगहों पर वेब यूआई की तरह भी किया जाना है। क्या यह सच है @juliusv ?
तो जैसा कि @slrtbtfs द्वारा बताया गया है

वाईएएमएल टिप्पणियों के संबंध में, v3 के साथ समस्याएं हैं जो कॉर्टेक्स के लिए समस्याएं पैदा कर रही हैं, इसलिए हमें इसके आगे रोलआउट से बचना चाहिए जब तक कि यह सब हल न हो जाए।

उस ने कहा कि मुझे लगता है कि स्वरूपण केवल नियमों की फाइलों में ही नहीं बल्कि कुछ जगहों पर वेब यूआई की तरह भी किया जाना है। क्या यह सच है

वेब ui एकमात्र ऐसा स्थान है जो इसे किया गया है।