🥇 Flaski mikroteenuste jälgimine Prometheuse abil

Koodiread ja teie rakendus genereerib mõõdikud, vau!

Kuidas prometheus_ töötab, et sellest aru saadaflask_exporter'i puhul on piisav minimaalne näide:

from flask import Flask
from prometheus_flask_exporter import PrometheusMetrics

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

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

See on kõik, mis on vajalik alustamiseks! Lisades impordi ja initsialiseerimisread PrometheusMetrics, saate mõõdikud päringute kestuse ja päringute loendurid, mis kuvatakse Flaski rakenduse lõpp-punktis, kus see on registreeritud, ning kõik vaikimisi mõõdikud, mida saate baasilt /metrics Prometheuse klientraamatukogast Kuidas leida.

kasutajasõbralik näide GitHubi hoidlates, mis käivitab instantsi koos demonstraatsioonirakendusega, et genereerida mõõdikud, mis näevad välja enam-vähem sellised: Prometheus ja Grafana Leiate ka näidise mõõdikute nimekirja

, mis kuvatakse armatuurlaual koos Prometheusele esitatud päringutega, mis täidavad paneele. README Raamatukogus on palju konfiguratsioonivalikuid, vaadake nende näiteid

Seadistamine

projekti alt koos lühikese selgitusega. README Aluskonfiguratsioon on näidatud ülal. Looge lihtsalt instants

, nimetame selle PrometheusMetrics, nimetame seda mõõdikutest, ja seejärel määrake täiendavad mõõdikud, mida soovite koguda, funktsioone dekoreerides:

@metrics.counter(..)
@metrics.gauge(..)
@metrics.summary(..)
@metrics.histogram(..)

Kalkulaatorid loendavad kutseid, samas kui ülejäänud koguvad mõõdikud vastavalt nende kutsete kestusele. Saate määrata silte igale neist, kasutades potentsiaalselt päringu või vastuse omadusi. Näiteks:

from flask import Flask, request
from prometheus_flask_exporter import PrometheusMetrics

app = Flask(__name__)

# grupp endpointi järgi, mitte tee järgi
metrics = PrometheusMetrics(app, group_by='endpoint')

@app.route('/collection/:collection_id/item/:item_id')
@metrics.counter(
    'cnt_collection', 'Kutsete arv iga kollektsiooni kohta', labels={
        'collection': lambda: request.view_args['collection_id'],
        'status': lambda resp: resp.status_code
    })
def get_item_from_collection(collection_id, item_id):
    pass

Eespooltoodud näites viib lõpp-punkti vajutamine /collection/10002/item/76 selle kahjuks suurendamiseni, näiteks cnt_collection{collection = «10002», status = «200»}, pluss saate vaikemõõdikud (iga lõpp-punkti jaoks selles näites) vaikimisi raamatukogust:

flask_http_request_duration_seconds — HTTP-päringu kestus sekundites kõigi Flaski päringute jaoks meetodi, tee ja staatuse järgi
flask_http_request_total — Kõigi HTTP-päringute koguarv meetodite ja staatuste lõikes

On olemas võimalusi teatud lõpp-punktide jälgimise vahelejätmiseks, lisada vaikimisi täiendavaid mõõdikuid või vahele jätta ülaltoodud määratud mõõdikud, või rakendada sama kohandatud mõõdikut mitmele lõpp-punktile. Tutvuge README projektiga, et teada saada, mis on saadaval.

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

@app.route('/')
def main():
    pass  # päringud jälgitakse vaikimisi

@app.route('/skip')
@metrics.do_not_track()
def skip():
    pass  # vaikimisi mõõdikuid ei koguta

# kohandatud mõõdik, mida rakendada mitmele lõpp-punktile
common_counter = metrics.counter(
    'by_endpoint_counter', 'Päringute arv lõpp-punktide kaupa',
    labels={'endpoint': lambda: request.endpoint}
)

@app.route('/common/one')
@common_counter
def endpoint_one():
    pass  # jälgitakse kohandatud ja vaikimisi mõõdikute poolt

@app.route('/common/two')
@common_counter
def endpoint_two():
    pass  # jälgitakse samuti kohandatud ja vaikimisi mõõdikute poolt

# registreeri täiendavad vaikimisi mõõdikud
metrics.register_default(
    metrics.counter(
        'by_path_counter', 'Päringute arv päringu teede kaupa',
        labels={'path': lambda: request.path}
    )
)

Raamatukogus on mugavad laiendused populaarsetele mitme protsessori raamatukogudele, nagu uWSGI ja Gunicorn. Samuti võite leida väikeseid näiteid sihtotstarbelistest kasutusvariantidest, sealhulgas mitme protsessoriga.

Mõõdiku kogumine

Nagu eespool mainitud, pakub raamatukogu vaikimisi lõpp-punkti /metrics Flaski rakenduses, mis võib olla sihtpunktiks Prometheuse kogujale.

Ülaltoodud näites olev sööstur võimaldab teil suunata oma Prometheuse Flaski rakendusele vaikeseadetega sellise konfiguratsiooniga:

scrape_configs:
  - job_name: 'example'

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

Vaata täisnäidet GitHubi hoidlast. See eeldab, et Prometheus suudab leida teie Flaski rakenduse instantsid http://app:5000/metrics, kus rakenduse domeeninimi võib potentsiaalselt resolveeruda mitmele IP-aadressile, näiteks töötades Kubernetes või Docker Swarm.

Kui selline mõõdikute lõpp-punkti avalikustamine teile ei sobi, võib-olla seetõttu, et te ei soovi sellele väljastpoolt juurdepääsu, saate selle hõlpsasti keelata, edastades path=None instantsi loomisel 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)

Seejärel saate kasutada start_http_server(port), et avada see lõpp-punkt teisel HTTP-porti 5099 ülaltoodud näites. Alternatiivselt, kui teile sobib, et lõpp-punkt on samas Flaski rakenduses, kuid peate muutma selle teed /metrics, saate kas edastada teise URI teekonna parameetrina või kasutada register_endpoint(..), et seada see hiljem.

Lingid

rycus86/prometheus_flask_exporter — See on Prometheuse flaski eksportija
prometheus-flask-exporter README — Kasutamine, näited ja konfiguratsiooni parameetrid
prometheus-flask-exporter examples — Näited Flaski rakenduste jälgimise seadistamiseks erinevatele viisidele
prometheus-flask-exporter on PyPI — See projekt on PyPIs
prometheus/client_python — Prometheuse ametlik klientide teek Pythonile