Övervakning av Flask-mikrotjänster med Prometheus

Ett par kodrader och din applikation genererar mätvärden, wow!

För att förstå hur prometheus_ fungerarflask_exporter behövs ett enkelt exempel:

from flask import Flask
from prometheus_flask_exporter import PrometheusMetrics

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

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

Det är allt som behövs för att komma igång! Genom att lägga till import och en rad för att initiera PrometheusMetrics, får du mätvärden förfrågningarnas varaktighet och förfrågningsräknare, som visas i slutpunkten /metrics av Flask-applikationen där det är registrerat, samt alla standardmätvärden som du får från den grundläggande klientbiblioteket Prometheus.

Du kan hitta ett enkelt exempel i GitHub-förvaret som kör en instans Prometheus och Grafana tillsammans med ett demonstrationsprogram för att generera mätvärden som skulle se ut ungefär så här:

Du kommer också att hitta en lista över mätvärden i README exemplet som visas på instrumentpanelen, tillsammans med Prometheus-förfrågningar som fyller panelerna.

Inställning

Biblioteket har många konfigurationsalternativ, kolla in README projektet för deras exempel med en kort förklaring.

Den grundläggande konfigurationen visas högst upp. Skapa bara en instans PrometheusMetrics, låt oss kalla den metrics, och använd sedan den för att definiera ytterligare mätvärden som du vill samla in genom att dekorera funktioner:

• @metrics.counter(..)

• @metrics.gauge(..)

• @metrics.summary(..)

• @metrics.histogram(..)

Räknare räknar anrop, medan de andra samlar in mätvärden beroende på varaktigheten av dessa anrop. Du kan definiera etiketter för var och en av dem, potentiellt använda egenskaper från förfrågan eller svaret. Till exempel:

from flask import Flask, request
from prometheus_flask_exporter import PrometheusMetrics

app = Flask(__name__)

# gruppera efter slutpunkt istället för sökväg
metrics = PrometheusMetrics(app, group_by='endpoint')

@app.route(' / collection / :collection_id / item / :item_id')
@metrics.counter(
    'cnt_collection', 'Antal anrop per samling', labels={
        'collection': lambda: request.view_args['collection_id'],
        'status': lambda resp: resp.status_code
    })
def get_item_from_collection(collection_id, item_id):
    pass

I det ovanstående exemplet kommer ett tryck på slutpunkten /collection/10002/item/76 att öka räknaren, till exempel cnt_collection{collection = "10002", status = "200"}, plus att du får standardmätvärden (för varje slutpunkt i detta exempel) från biblioteket som standard:

• flask_http_request_duration_seconds — Varaktigheten av HTTP-förfrågan i sekunder för alla Flask-förfrågningar efter metod, sökväg och status

• flask_http_request_total — Totalt antal HTTP-förfrågningar efter metoder och statusar

Det finns alternativ för att hoppa över att spåra vissa slutpunkter, registrera ytterligare standardmetrik eller hoppa över de ovan angivna, eller tillämpa samma anpassade metrik på flera slutpunkter. Läs mer om README projektet för att ta reda på vad som är tillgängligt.

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

Biblioteket har användarvänliga tillägg för populära flertrådiga bibliotek som uWSGI och Gunicorn. Du kan även hitta små exempel på praktiska användningsfall, inklusive flertrådiga.

Insamling av metrik

Som nämnts tidigare tillhandahåller biblioteket som standard en slutpunkt /metrics i Flask-applikationen som kan fungera som mål för Prometheus-samlaren.

I det ovan nämnda exemplet med instrumentpanelen kan du rikta din Prometheus mot Flask-applikationen med standardinställningar med följande konfiguration:

scrape_configs:
  - job_name: 'example'

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

Se hela exemplet i GitHub-repo. Detta förutsätter att Prometheus kan hitta dina instanser av Flask-applikationen på http://app:5000/metrics, där domännamnet för applikationen potentiellt kan lösas till flera IP-adresser, exempelvis när du kör i Kubernetes eller Docker Swarm.

Om sådan exponering av metrikens slutpunkt inte passar dig, kanske för att du inte vill tillåta extern åtkomst till den, kan du enkelt inaktivera den genom att skicka path=None när du skapar instansen 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)

Du kan sedan använda start_http_server(port), för att öppna denna slutpunkt på en annan HTTP-port, 5099 i det ovan nämnda exemplet. Alternativt, om du är okej med att slutpunkten är i samma Flask-applikation, men behöver ändra dess väg från /metrics, du kan antingen ange en annan URI som en sökvägsparameter eller använda register_endpoint(..), för att ställa in detta senare.

Länkar

• rycus86/prometheus_flask_exporter — Denna flask-exportör för Prometheus

• prometheus-flask-exporter README — Användning, exempel och konfigurationsalternativ

• prometheus-flask-exporter examples — Exempel på hur man konfigurerar övervakning av Flask-appar på olika sätt

• prometheus-flask-exporter på PyPI — Detta projekt finns på PyPI

• prometheus/client_python — Den officiella klientbiblioteket för Prometheus för Python

Om du bestämmer dig för att prova, tveka inte att öppna en issue på GitHub eller lämna dina kommentarer, recensioner och förslag!

Tack!

Källa: habr.com