ਪ੍ਰੋਮੀਥੀਅਸ ਦੇ ਨਾਲ ਫਲਾਸਕ ਮਾਈਕ੍ਰੋ ਸਰਵਿਸਿਜ਼ ਦੀ ਨਿਗਰਾਨੀ ਕਰਨਾ

ਕੋਡ ਦੀਆਂ ਕੁਝ ਲਾਈਨਾਂ ਅਤੇ ਤੁਹਾਡੀ ਐਪਲੀਕੇਸ਼ਨ ਮੈਟ੍ਰਿਕਸ ਤਿਆਰ ਕਰਦੀ ਹੈ, ਵਾਹ!

ਇਹ ਸਮਝਣ ਲਈ ਕਿ 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 и ਗ੍ਰਾਫਨਾ ਮੈਟ੍ਰਿਕਸ ਤਿਆਰ ਕਰਨ ਲਈ ਇੱਕ ਡੈਮੋ ਐਪਲੀਕੇਸ਼ਨ ਦੇ ਨਾਲ ਜੋ ਕੁਝ ਇਸ ਤਰ੍ਹਾਂ ਦਿਖਾਈ ਦੇਵੇਗਾ:

ਵਿੱਚ ਤੁਹਾਨੂੰ ਸੂਚਕਾਂ ਦੀ ਇੱਕ ਸੂਚੀ ਵੀ ਮਿਲੇਗੀ README ਉਦਾਹਰਨਾਂ ਜੋ ਡੈਸ਼ਬੋਰਡ ਵਿੱਚ ਦਿਖਾਈ ਦਿੰਦੀਆਂ ਹਨ, ਪ੍ਰੋਮੀਥੀਅਸ ਸਵਾਲਾਂ ਦੇ ਨਾਲ ਜੋ ਡੈਸ਼ਬੋਰਡਾਂ ਨੂੰ ਭਰਦੀਆਂ ਹਨ।

ਵਿਵਸਥਾ

ਲਾਇਬ੍ਰੇਰੀ ਵਿੱਚ ਬਹੁਤ ਸਾਰੇ ਸੰਰਚਨਾ ਵਿਕਲਪ ਹਨ, ਵੇਖੋ README ਇੱਕ ਸੰਖੇਪ ਵਿਆਖਿਆ ਦੇ ਨਾਲ ਉਹਨਾਂ ਦੀਆਂ ਪ੍ਰੋਜੈਕਟ ਉਦਾਹਰਣਾਂ।

ਬੁਨਿਆਦੀ ਸੰਰਚਨਾ ਉੱਪਰ ਦਿਖਾਇਆ ਗਿਆ ਹੈ. ਬਸ ਇੱਕ ਉਦਾਹਰਨ ਬਣਾਓ 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{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}
    )
)

ਲਾਇਬ੍ਰੇਰੀ ਵਿੱਚ ਪ੍ਰਸਿੱਧ ਮਲਟੀਪ੍ਰੋਸੈਸਿੰਗ ਲਾਇਬ੍ਰੇਰੀਆਂ ਜਿਵੇਂ ਕਿ 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 ਪਾਸ ਕਰ ਸਕਦੇ ਹੋ, ਜਾਂ ਵਰਤ ਸਕਦੇ ਹੋ ਰਜਿਸਟਰ_ਐਂਡਪੁਆਇੰਟ(..)ਇਸ ਨੂੰ ਬਾਅਦ ਵਿੱਚ ਇੰਸਟਾਲ ਕਰਨ ਲਈ.

ਹਵਾਲੇ

• rycus86/prometheus_flask_exporter - ਪ੍ਰੋਮੀਥੀਅਸ ਲਈ ਇਹ ਬੋਤਲ ਨਿਰਯਾਤਕ

• prometheus-flask-exporter README — ਵਰਤੋਂ, ਉਦਾਹਰਨਾਂ ਅਤੇ ਸੰਰਚਨਾ ਚੋਣਾਂ

• prometheus-flask-exporter ਉਦਾਹਰਨਾਂ — ਵੱਖ-ਵੱਖ ਤਰੀਕਿਆਂ ਨਾਲ ਫਲਾਸਕ ਐਪਲੀਕੇਸ਼ਨ ਨਿਗਰਾਨੀ ਨੂੰ ਸਥਾਪਤ ਕਰਨ ਦੀਆਂ ਉਦਾਹਰਨਾਂ

• PyPI 'ਤੇ prometheus-flask-exporter - ਇਹ ਪ੍ਰੋਜੈਕਟ PyPI 'ਤੇ ਹੈ

• prometheus/client_python - ਪਾਈਥਨ ਲਈ ਅਧਿਕਾਰਤ ਪ੍ਰੋਮੀਥੀਅਸ ਕਲਾਇੰਟ ਲਾਇਬ੍ਰੇਰੀ

ਜੇ ਤੁਸੀਂ ਇਸਨੂੰ ਅਜ਼ਮਾਉਣ ਦਾ ਫੈਸਲਾ ਕਰਦੇ ਹੋ, ਤਾਂ GitHub 'ਤੇ ਕੋਈ ਮੁੱਦਾ ਖੋਲ੍ਹਣ ਲਈ ਬੇਝਿਜਕ ਮਹਿਸੂਸ ਕਰੋ ਜਾਂ ਆਪਣੀਆਂ ਟਿੱਪਣੀਆਂ, ਫੀਡਬੈਕ ਅਤੇ ਸੁਝਾਅ ਛੱਡੋ!

ਤੁਹਾਡਾ ਧੰਨਵਾਦ!

ਸਰੋਤ: www.habr.com