प्रोमिथियससह फ्लास्क मायक्रोसर्व्हिसेसचे निरीक्षण करणे

कोडच्या दोन ओळी आणि तुमचा अनुप्रयोग मेट्रिक्स व्युत्पन्न करतो, व्वा!

prometheus_ कसे कार्य करते हे समजून घेण्यासाठीफ्लास्क_निर्यातदार एक किमान उदाहरण पुरेसे आहे:

from flask import Flask
from prometheus_flask_exporter import PrometheusMetrics

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

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

आपल्याला प्रारंभ करण्यासाठी इतकेच आवश्यक आहे! प्रारंभ करण्यासाठी आयात आणि एक ओळ जोडून PrometheusMetrics, तुम्हाला मेट्रिक्स मिळतील विनंती कालावधी и विनंती काउंटर, एंडपॉइंटवर प्रदर्शित केले जाते /मेट्रिक्स फ्लास्क ऍप्लिकेशन ज्यावर ते नोंदणीकृत आहे, तसेच तुम्हाला बेसमधून मिळणारे सर्व डीफॉल्ट मेट्रिक्स प्रोमिथियस क्लायंट लायब्ररी.

आपण शोधू शकता वापरण्यास सोपे उदाहरण GitHub रेपॉजिटरीमध्ये जे उदाहरण चालवते Prometheus и ग्राफाना मेट्रिक्स व्युत्पन्न करण्यासाठी डेमो ऍप्लिकेशनसह जे असे काहीतरी दिसेल:

मध्ये आपल्याला निर्देशकांची सूची देखील मिळेल मला वाचा डॅशबोर्डमध्ये दिसणारी उदाहरणे, प्रोमिथियस क्वेरींसह जे डॅशबोर्ड भरतात.

समायोजन

लायब्ररीमध्ये अनेक कॉन्फिगरेशन पर्याय आहेत, पहा मला वाचा थोडक्यात स्पष्टीकरणासह त्यांची प्रकल्प उदाहरणे.

मूलभूत कॉन्फिगरेशन वर दर्शविले आहे. फक्त एक उदाहरण तयार करा PrometheusMetrics, चला कॉल करूया मेट्रिक्स, आणि नंतर फंक्शन्स सजवून तुम्ही गोळा करू इच्छित अतिरिक्त मेट्रिक्स परिभाषित करण्यासाठी त्याचा वापर करा:

• @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

वरील उदाहरणात, एंडपॉइंटवर क्लिक करणे /collection/10002/item/76 काउंटर वाढण्यास कारणीभूत ठरेल, उदाहरणार्थ cnt_collection{संकलन = "10002", स्थिती = "200"}, तसेच तुम्हाला डीफॉल्ट लायब्ररीमधून डीफॉल्ट मेट्रिक्स (या उदाहरणातील प्रत्येक एंडपॉइंटसाठी) मिळतील:

• flask_http_request_duration_seconds — पद्धत, मार्ग आणि स्थितीनुसार सर्व फ्लास्क विनंत्यांसाठी HTTP विनंती कालावधी सेकंदात

• flask_http_request_total — पद्धती आणि स्थितींनुसार HTTP विनंत्यांची एकूण संख्या

विशिष्ट एंडपॉइंट्सचा मागोवा घेणे वगळणे, अतिरिक्त डीफॉल्ट मेट्रिक्स लॉग करणे किंवा वर सूचीबद्ध केलेले ते वगळणे किंवा एकाधिक एंडपॉइंट्सवर समान कस्टम मेट्रिक लागू करण्याचे पर्याय आहेत. तपासा मला वाचा काय उपलब्ध आहे हे पाहण्यासाठी प्रकल्प.

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}
    )
)

लायब्ररीमध्ये लोकप्रिय मल्टीप्रोसेसिंग लायब्ररी जसे की uWSGI आणि Gunicorn साठी सोयीस्कर विस्तार आहेत. आपण मल्टीप्रोसेसिंगसह लक्ष्यित वापर प्रकरणांची छोटी उदाहरणे देखील शोधू शकता.

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

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

वरील डॅशबोर्ड उदाहरणामध्ये, तुम्ही तुमच्या प्रोमिथियसला या कॉन्फिगरेशनसह डीफॉल्ट सेटिंग्जसह फ्लास्क ऍप्लिकेशनवर लक्ष्य करू शकता:

scrape_configs:
  - job_name: 'example'

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

येथे संपूर्ण उदाहरण पहा GitHub भांडार. हे असे गृहीत धरते की प्रोमिथियस आपल्या फ्लास्क अनुप्रयोगाची उदाहरणे शोधू शकतो http://app:5000/metrics, जेथे ऍप्लिकेशन डोमेन नाव संभाव्यपणे एकाधिक IP पत्त्यांचे निराकरण करू शकते, उदाहरणार्थ चालू असताना कुबेरनेट्स किंवा डॉकर झुंड.

अशा प्रकारे मेट्रिक्स एंडपॉइंट उघड करणे आपल्यास अनुकूल नसल्यास, कदाचित आपण त्यास बाह्य प्रवेशास अनुमती देऊ इच्छित नसल्यामुळे, आपण पास करून तो सहजपणे अक्षम करू शकता मार्ग = काहीही नाही एक उदाहरण तयार करताना PrometheusMetrics.

from flask import Flask, request
from prometheus_flask_exporter import PrometheusMetrics

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

...

metrics.start_http_server(5099)

मग आपण वापरू शकता start_http_server(पोर्ट)हा एंडपॉइंट वेगळ्या HTTP पोर्टवर उघडण्यासाठी, 5099 वरील उदाहरणात. वैकल्पिकरित्या, समान फ्लास्क ऍप्लिकेशनमध्ये एंडपॉईंट असल्याबद्दल तुम्ही आनंदी असल्यास, परंतु तुम्हाला त्याचा मार्ग बदलण्याची आवश्यकता आहे /मेट्रिक्स, तुम्ही एकतर दुसरा URI पाथ पॅरामीटर म्हणून पास करू शकता किंवा वापरू शकता register_endpoint(..)नंतर स्थापित करण्यासाठी.

संदर्भ

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

• prometheus-flask-निर्यातकर्ता README — वापर, उदाहरणे आणि कॉन्फिगरेशन पर्याय

• prometheus-flask-exporter उदाहरणे — फ्लास्क ऍप्लिकेशन मॉनिटरिंग वेगवेगळ्या प्रकारे सेट करण्याची उदाहरणे

• PyPI वर prometheus-flask-exporter — हा प्रकल्प PyPI वर आहे

• prometheus/client_python - पायथनसाठी अधिकृत प्रोमिथियस क्लायंट लायब्ररी

तुम्ही एकदा प्रयत्न करण्याचे ठरविल्यास, GitHub वर समस्या उघडण्यास मोकळ्या मनाने किंवा तुमच्या टिप्पण्या, अभिप्राय आणि सूचना द्या!

धन्यवाद!

स्त्रोत: www.habr.com