प्रोमेथियसको साथ फ्लास्क माइक्रोसर्भिसेसहरू निगरानी गर्दै

कोडको केही लाइनहरू र तपाईंको अनुप्रयोगले मेट्रिक्स उत्पन्न गर्दछ, वाह!

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 - प्रयोग, उदाहरण र कन्फिगरेसन विकल्पहरू

• प्रोमेथियस-फ्लास्क-निर्यातकर्ता उदाहरणहरू - विभिन्न तरिकामा फ्लास्क अनुप्रयोग अनुगमन सेटअप गर्ने उदाहरणहरू

• PyPI मा prometheus-flask-निर्यातकर्ता - यो परियोजना PyPI मा छ

• prometheus/client_python - पाइथनको लागि आधिकारिक प्रोमेथियस ग्राहक पुस्तकालय

यदि तपाइँ यसलाई प्रयास गर्ने निर्णय गर्नुहुन्छ भने, GitHub मा मुद्दा खोल्न स्वतन्त्र महसुस गर्नुहोस् वा तपाइँको टिप्पणी, प्रतिक्रिया, र सुझावहरू छोड्नुहोस्!

धन्यवाद!

स्रोत: www.habr.com