प्रोमेथियस के साथ फ्लास्क माइक्रोसर्विसेज की निगरानी

कोड की कुछ पंक्तियाँ और आपका एप्लिकेशन मेट्रिक्स उत्पन्न करता है, वाह!

यह समझने के लिए कि प्रोमेथियस_ कैसे काम करता हैकुप्पी_निर्यातक के लिए एक न्यूनतम उदाहरण ही पर्याप्त है:

from flask import Flask
from prometheus_flask_exporter import PrometheusMetrics

app = Flask(__name__)
metrics = PrometheusMetrics(app)

@app.route('/')
def main():
    return 'OK'

आरंभ करने के लिए आपको बस इतना ही चाहिए! आरंभीकरण के लिए एक आयात और एक पंक्ति जोड़कर प्रोमेथियसमेट्रिक्स, आपको मेट्रिक्स मिलेंगे अनुरोध अवधि и अनुरोध काउंटर, समापन बिंदु पर प्रदर्शित किया गया /मैट्रिक्स फ्लास्क एप्लिकेशन जिसके साथ यह पंजीकृत है, साथ ही आधार से आपको मिलने वाले सभी डिफ़ॉल्ट मेट्रिक्स भी प्रोमेथियस क्लाइंट लाइब्रेरी.

तुम खोज सकते हो प्रयोग करने में आसान उदाहरण GitHub रिपॉजिटरी में जो इंस्टेंस चलाता है प्रोमिथेउस и ग्राफाना मेट्रिक्स उत्पन्न करने के लिए एक डेमो एप्लिकेशन के साथ जो कुछ इस तरह दिखेगा:

आपको इसमें संकेतकों की एक सूची भी मिलेगी README उदाहरण जो डैशबोर्ड में दिखाई देते हैं, साथ ही प्रोमेथियस क्वेरीज़ जो डैशबोर्ड को पॉप्युलेट करती हैं।

समायोजन

लाइब्रेरी में कई कॉन्फ़िगरेशन विकल्प हैं, देखें README संक्षिप्त विवरण के साथ उनके उदाहरण प्रोजेक्ट करें।

मूल विन्यास ऊपर दिखाया गया है। बस एक उदाहरण बनाएं प्रोमेथियसमेट्रिक्स, चलो इसे कॉल करें मेट्रिक्स, और फिर इसका उपयोग उन अतिरिक्त मेट्रिक्स को परिभाषित करने के लिए करें जिन्हें आप फ़ंक्शंस को सजाकर एकत्र करना चाहते हैं:

• @metrics.counter(..)

• @metrics.gauge(..)

• @metrics.summary(..)

• @metrics.histogram(..)

काउंटर कॉलों की गिनती करते हैं, और अन्य उन कॉलों की अवधि के आधार पर मीट्रिक एकत्र करते हैं। आप संभावित रूप से अनुरोध या प्रतिक्रिया गुणों का उपयोग करके इनमें से प्रत्येक के लिए लेबल परिभाषित कर सकते हैं। उदाहरण के लिए:

from flask import Flask, request
from prometheus_flask_exporter import PrometheusMetrics

app = Flask(__name__)

# group by endpoint rather than path
metrics = PrometheusMetrics(app, group_by='endpoint')

@app.route('/collection/:collection_id/item/:item_id')
@metrics.counter(
    'cnt_collection', 'Number of invocations per collection', labels={
        'collection': lambda: request.view_args['collection_id'],
        'status': lambda resp: resp.status_code
    })
def get_item_from_collection(collection_id, item_id):
    pass

उपरोक्त उदाहरण में, समापन बिंदु पर क्लिक करें /संग्रह/10002/आइटम/76 उदाहरण के लिए, काउंटर में वृद्धि का कारण बनेगा cnt_collection{संग्रह = "10002", स्थिति = "200"}, साथ ही आपको डिफ़ॉल्ट लाइब्रेरी से डिफ़ॉल्ट मेट्रिक्स (इस उदाहरण में प्रत्येक समापन बिंदु के लिए) मिलेंगे:

• flask_http_request_duration_seconds - विधि, पथ और स्थिति के अनुसार सभी फ्लास्क अनुरोधों के लिए HTTP अनुरोध अवधि सेकंड में

• flask_http_request_total - विधियों और स्थितियों के अनुसार HTTP अनुरोधों की कुल संख्या

विशिष्ट समापन बिंदुओं की ट्रैकिंग को छोड़ने, अतिरिक्त डिफ़ॉल्ट मेट्रिक्स को लॉग करने या ऊपर सूचीबद्ध लोगों को छोड़ने, या एक ही कस्टम मीट्रिक को कई समापन बिंदुओं पर लागू करने के विकल्प हैं। चेक आउट README यह देखने के लिए प्रोजेक्ट करें कि क्या उपलब्ध है।

app = Flask(__name__)
metrics = PrometheusMetrics(app)

@app.route('/')
def main():
    pass  # requests tracked by default

@app.route('/skip')
@metrics.do_not_track()
def skip():
    pass  # default metrics are not collected

# custom metric to be applied to multiple endpoints
common_counter = metrics.counter(
    'by_endpoint_counter', 'Request count by endpoints',
    labels={'endpoint': lambda: request.endpoint}
)

@app.route('/common/one')
@common_counter
def endpoint_one():
    pass  # tracked by the custom and the default metrics

@app.route('/common/two')
@common_counter
def endpoint_two():
    pass  # also tracked by the custom and the default metrics

# register additional default metrics
metrics.register_default(
    metrics.counter(
        'by_path_counter', 'Request count by request paths',
        labels={'path': lambda: request.path}
    )
)

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

मेट्रिक्स संग्रह

जैसा कि ऊपर बताया गया है, लाइब्रेरी डिफ़ॉल्ट रूप से एक समापन बिंदु प्रदान करती है /मैट्रिक्स फ्लास्क एप्लिकेशन में, जो एक लक्ष्य के रूप में काम कर सकता है प्रोमेथियस बिल्डर.

उपरोक्त डैशबोर्ड उदाहरण में, आप अपने प्रोमेथियस को इस कॉन्फ़िगरेशन के साथ डिफ़ॉल्ट सेटिंग्स वाले फ्लास्क एप्लिकेशन पर लक्षित कर सकते हैं:

scrape_configs:
  - job_name: 'example'

    dns_sd_configs:
      - names: ['app']
        port: 5000
        type: A
        refresh_interval: 5s

पूरा उदाहरण यहां देखें GitHub रिपॉजिटरी. यह मानता है कि प्रोमेथियस आपके फ्लास्क एप्लिकेशन इंस्टेंस को ढूंढ सकता है http://app:5000/metrics, जहां एप्लिकेशन डोमेन नाम संभावित रूप से एकाधिक आईपी पते को हल कर सकता है, उदाहरण के लिए चलते समय Kubernetes या डोकर झुंड.

यदि मेट्रिक्स एंडपॉइंट को इस तरह से उजागर करना आपके लिए उपयुक्त नहीं है, शायद इसलिए कि आप उस तक बाहरी पहुंच की अनुमति नहीं देना चाहते हैं, तो आप इसे पास करके आसानी से अक्षम कर सकते हैं पथ=कोई नहीं एक उदाहरण बनाते समय प्रोमेथियसमेट्रिक्स.

from flask import Flask, request
from prometheus_flask_exporter import PrometheusMetrics

app = Flask(__name__)
metrics = PrometheusMetrics(app, path=None)

...

metrics.start_http_server(5099)

तब आप उपयोग कर सकते हैं प्रारंभ_http_सर्वर(पोर्ट)इस समापन बिंदु को किसी भिन्न HTTP पोर्ट पर खोलने के लिए, 5099 उपरोक्त उदाहरण में. वैकल्पिक रूप से, यदि आप समापन बिंदु के एक ही फ्लास्क एप्लिकेशन में होने से खुश हैं, लेकिन आपको इसका पथ बदलने की आवश्यकता है /मैट्रिक्स, आप या तो पथ पैरामीटर के रूप में एक और यूआरआई पास कर सकते हैं, या उपयोग कर सकते हैं रजिस्टर_एंडपॉइंट(..)इसे बाद में स्थापित करने के लिए.

संदर्भों

• rycus86/prometheus_flask_exporter - प्रोमेथियस के लिए यह बोतल निर्यातक

• प्रोमेथियस-फ्लास्क-निर्यातक README - उपयोग, उदाहरण और कॉन्फ़िगरेशन विकल्प

• प्रोमेथियस-फ्लास्क-निर्यातक उदाहरण - विभिन्न तरीकों से फ्लास्क एप्लिकेशन मॉनिटरिंग स्थापित करने के उदाहरण

• PyPI पर प्रोमेथियस-फ्लास्क-निर्यातक - यह प्रोजेक्ट PyPI पर है

• प्रोमेथियस/क्लाइंट_पायथन - पायथन के लिए आधिकारिक प्रोमेथियस क्लाइंट लाइब्रेरी

यदि आप इसे आज़माने का निर्णय लेते हैं, तो बेझिझक GitHub पर एक मुद्दा खोलें या अपनी टिप्पणियाँ, प्रतिक्रिया और सुझाव छोड़ें!

शुक्रिया!

स्रोत: www.habr.com