Flask mikroservisu uzraudzība ar Prometheus

Dažas koda rindas un jūsu lietotne ģenerē metrikas, wow!

Lai saprastu, kā darbojas prometheus_flask_ekspress ieraksta pietiek ar minimālu piemēru:

no flask import Flask
no prometheus_flask_exporter import PrometheusMetrics

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

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

Tas ir viss, kas nepieciešams, lai sāktu! Pievienojot importu un inicializācijas rindu PrometheusMetrics, jūs saņemsiet metrikas pieprasījumu ilguma un pieprasījumu skaitītājus, kas tiek parādīti Flask lietojumprogrammas galapunktā, kurā tas ir reģistrēts, kā arī visas noklusējuma metrikas, kuras jūs saņemat no pamata /metrics Prometheus klienta bibliotēkas Jūs varat atrast.

vieglu lietojamu piemēru GitHub krātuvē, kas palaiž instanci kopā ar demonstrācijas lietojumprogrammu metrikas ģenerēšanai, kas izskatīsies aptuveni tā: Prometheus un Grafana Jūs arī atradīsiet rādītāju sarakstu

piemērā, kas tiek rādīts vadībā, kopā ar Prometheus vaicājumiem, kas aizpilda paneļus. README Bibliotēkā ir daudz konfigurācijas opciju, skatiet

Iestatījumi

projekta piemērus ar īsu skaidrojumu. README Pamatkonfigurācija ir parādīta augšpusē. Vienkārši izveidojiet instanci

, nosauksim to par PrometheusMetricsmetrics , un tad ar tās palīdzību definējiet papildu metrikas, kuras vēlaties vācēt, dekoriējot funkcijas:@metrics.counter(..)

• @metrics.gauge(..)

• @metrics.summary(..)

• @metrics.histogram(..)

• Skaitītāji skaita izsaukumus, bet pārējie vāc metrikas atkarībā no šo izsaukumu ilguma. Jūs varat definēt atzīmes katram no tiem, potenciāli izmantojot pieprasījuma vai atbildes īpašības. Piemēram:

no flask import Flask, request no prometheus_flask_exporter import PrometheusMetricsapp = Flask(__name__)# grupēt pēc galapunkta, nevis ceļa metrics = PrometheusMetrics(app, group_by='endpoint')@app.route(' / collection / :collection_id / item / :item_id') @metrics.counter( 'cnt_collection', 'Izsaukumu skaits katrai kolekcijai', etiketēm={ 'collection': lambda: request.view_args['collection_id'], 'status': lambda resp: resp.status_code }) def get_item_from_collection(collection_id, item_id): pass

Iepriekš minētajā piemērā nospiežot uz galapunkta

palielinās skaitītājs, piemēram /collection/10002/item/76 cnt_collection{collection = «10002», status = «200»} , kā arī jūs saņemsiet noklusējuma metrikas (katrai galapunktam šajā piemērā) no noklusējuma bibliotēkas:flask_http_request_duration_seconds

• — HTTP pieprasījuma ilgums sekundēs visiem Flask pieprasījumiem pēc metodes, ceļa un statusa flask_http_request_total

• — Kopējais HTTP pieprasījumu skaits pēc metodēm un statusiem — Kopējais HTTP pieprasījumu skaits pēc metodēm un statusiem

Ir iespējas izlaist noteiktu punktu izsekošanu, reģistrēt papildu noklusējuma metrikas vai izlaist iepriekš minētās, vai piemērot to pašu pielāgoto metriku vairākiem punktiem. Iepazīstieties ar README projekta, lai uzzinātu, kas ir pieejams.

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

Bibliotēkā ir ērti paplašinājumi populārām daudzprocesoru bibliotēkām, piemēram, uWSGI un Gunicorn. Jūs arī varat atrast nelielus piemērus mērķa izmantošanas gadījumiem, tostarp daudzprocesoriem.

Metriku vākšana

Kā minēts iepriekš, bibliotēka pēc noklusējuma nodrošina beigu punktu /metrics Flask lietotnē, kas var kalpot par mērķi Prometheus vācējam.

Iepriekš minētajā paneļa piemērā varat norādīt savu Prometheus uz Flask lietotni ar noklusējuma iestatījumiem ar šādu konfigurāciju:

scrape_configs:
  - job_name: 'example'

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

Skatiet pilnu piemēru GitHub repozitorijā. Tas pieņem, ka Prometheus var atrast jūsu Flask lietotnes instancēm uz http://app:5000/metrics, kur programmas domēna nosaukums var potenciāli atrisināties uz vairākiem IP adresēm, piemēram, darbojoties Kubernetes vai Docker Swarm.

Ja šāda metriku gala punkta atklāšana jums nepiestāv, iespējams, jo nevēlaties atļaut piekļuvi tam no ārpuses, jūs varat viegli to atslēgt, nododot path=None veidojot instanci 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)

Tad jūs varat izmantot start_http_server(port), lai atvērtu šo beigu punktu citā HTTP portā, 5099 iepriekš minētajā piemērā. Alternatīvi, ja jums ir labi, ka beigu punkts atrodas tajā pašā Flask lietotnē, bet jums jāmaina tā ceļš no /metrics, jūs varat vai nu nodot citu URI kā ceļa parametru, vai izmantot register_endpoint(..), lai to izveidotu vēlāk.

Saites

• rycus86/prometheus_flask_exporter — Šis ir Prometheus Flask eksportētājs

• prometheus-flask-exporter README — Izmantošana, piemēri un konfigurācijas opcijas

• prometheus-flask-exporter examples — Flask lietojumprogrammu uzraudzības iestatīšanas piemēri dažādos veidos

• prometheus-flask-exporter on PyPI — Šis projekts ir pieejams PyPI

• prometheus/client_python — Oficiālā Prometheus klienta bibliotēka Python valodā

Ja nolemsiet izmēģināt, nevilcinieties atvērt jautājumu GitHub vai atstāt savus komentārus, atsauksmes un ieteikumus!

Paldies!

Avots: habr.com