Flaski mikroteenuste jälgimine Prometheuse abil

Paari koodirida ja teie rakendus genereerib mõõdikud, vau!

Kuna on oluline mõista, kuidas prometheus_flask_exporter töötab, piisab minimaalsest näitest:

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! Lisa import ja rea algatamiseks PrometheusMetrics, saate mõõdikud päringute kestuse ja päringu loendurid, mis kuvatakse Flaski rakenduse lõpp-punktis, kus ta on registreeritud, samuti kõik vaike mõõdikud, mis tulevad baasist /metrics Prometheuse kliendi teek Leiate.

kasutajasõbraliku näite GitHubi hoidlast, mis käivitab instantsi koos demonstreeriva rakendusega, et genereerida mõõdikud, mis näevad välja umbes nii: Prometheus ja Grafana Leiate ka mõõdikute nimekirja

README näiteks, mis kuvatakse armatuurlaudade peal koos Prometheuse päringutega, mis täidavad armatuure. Teegis on palju konfiguratsioonivõimalusi, vaata

Seadistamine

projekti näiteid lühikese selgitusega. näiteks, mis kuvatakse armatuurlaudade peal koos Prometheuse päringutega, mis täidavad armatuure. Baaskonfiguratsioon on esitatud üleval. Lihtsalt loo instants

, nimetame seda PrometheusMetricsmetrics , ja seejärel määrake lisamõõdikud, mida soovite koguda, funktsioone dekoreerides:@metrics.counter(..)

• @metrics.gauge(..)

• @metrics.summary(..)

• @metrics.histogram(..)

• Loendurid loevad kutsed, samas kui ülejäänud koguvad mõõdikud nende kutsumise kestuse alusel. Võite määrata silte igaühe jaoks, potentsiaalselt kasutades päringu või vastuse atribuute. Näiteks:

from flask import Flask, request from prometheus_flask_exporter import PrometheusMetricsapp = Flask(__name__)# rühmitamine lõpp-punkti, mitte tee järgi metrics = PrometheusMetrics(app, group_by='endpoint')@app.route('\/collection\/collection_id\/item\/item_id') @metrics.counter( 'cnt_collection', 'Kutsede arv kogumise kaupa', labels={ 'collection': lambda: request.view_args['collection_id'], 'status': lambda resp: resp.status_code }) def get_item_from_collection(collection_id, item_id): pass

Ülaltoodud näites lõpp-punkti klikkimine

tõstab loendurit, näiteks /collection/10002/item/76 cnt_collection{collection = "10002", status = "200"} , pluss, saate vaikemõõdikud (iga lõpp-punkti jaoks selles näites) vaiketeegist:flask_http_request_duration_seconds

• — HTTP päringu kestus sekundites kõikide Flaski päringute, meetodi, tee ja staatuse järgi flask_http_request_total

• — Kõigi HTTP päringute koguarv meetodite ja staatuste kaupa — Üldine HTTP-päringute arv meetodite ja staatuste kaupa

On olemas võimalusi teatud lõpp-punktide jälgimise vahelejätmiseks, registreerida vaikimisi täiendavad mõõdikud või vahele jätta ülaltoodud ning rakendada sama kohandatud mõõdikut mitmele lõpp-punktile. Tutvuge näiteks, mis kuvatakse armatuurlaudade peal koos Prometheuse päringutega, mis täidavad armatuure. projektiga, et näha, mis on saadaval.

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

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

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

# kohandatud mõõdik, mida rakendatakse 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 järgi

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

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

Raamatukogus on mugavad laiendused populaarsete mitmeprotsessoriliste raamatukogude jaoks, nagu uWSGI ja Gunicorn. Samuti leiate väikseid näiteid sihtotstarbeliste kasutusvõimaluste kohta, sealhulgas mitmeprotsessoriliste.

Mõõdikute kogumine

Nagu eespool mainitud, pakub raamatukogu vaikimisi lõpp-punkti /metrics Flaski rakenduses, mis võib teenida sihtmärgiks Prometheuse kogumisele.

Eespool toodud juhtumi jaoks, kus armatuurlaud on, saate suunata oma Prometheuse Flaski rakendusele vaikeseadistuste järgi sellise konfiguratsiooniga:

scrape_configs:
  - job_name: 'example'

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

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

Kui see mõõdikute lõpp-punkt ei sobi teile, võib-olla seetõttu, et te ei soovi sellele välispääsu lubada, 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 nagu eespool näidatud. Alternatiivselt, kui te pole vastu, et lõpp-punkt oleks samas Flaski rakenduses, kuid peate selle tee muutma /metrics, saate kas edastada teise URI teede parameetrina või kasutada register_endpoint(..), et seada see hiljem.

Viidatud lingid

• rycus86/prometheus_flask_exporter — See on Prometheuse flaski eksportija

• prometheus-flask-exporter README — Kasutus, näited ja konfigureerimise parameetrid

• prometheus-flask-exporter examples — Flaski rakenduste jälgimise seadistamise näited erinevates viisides

• prometheus-flask-exporter on PyPI — See projekt on PyPI-s

• prometheus/client_python — Prometheuse ametlik klientteek Pythonis

Kui otsustate proovida, siis ärge kartke avada probleem GitHubis või jätta oma kommentaare, tagasisidet ja ettepanekuid!

Aitäh!

Allikas: habr.com