Clever Geek Handbook

Surveillance des microservices Flask avec Prometheus

Quelques lignes de code et votre application génère des métriques, wow!

Afin de comprendre le fonctionnement de prometheus_ flask_ exporter , un exemple minimal suffit:

from flask import Flask
from prometheus_flask_exporter import PrometheusMetrics

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

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

C'est tout ce dont vous avez besoin pour commencer! En ajoutant une importation et une ligne pour initialiser PrometheusMetrics , vous obtiendrez les métriques de durée de demande et les compteurs de demande affichés sur le point de terminaison / metrics de l' application Flask avec laquelle il est enregistré, ainsi que toutes les métriques par défaut que vous obtenez de la bibliothèque client Prometheus sous-jacente .

Vous pouvez trouver un exemple facile à utiliser dans le référentiel GitHub qui lance une instance de Prometheus et Grafana avec une application de démonstration pour générer des métriques qui ressemblent à ceci:

README , , Prometheus, .

, README .

. PrometheusMetrics, metrics, , , :

  • @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", status = "200"}, ( ) :

  • flask_http_request_duration_seconds - HTTP- Flask ,

  • 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. , .

, /metrics Flask, Prometheus.

Prometheus Flask :

scrape_configs:
  - job_name: 'example'

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

GitHub. , Prometheus Flask http://app:5000/metrics, IP-, , Kubernetes Docker Swarm.

, , , , path=None 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(port), HTTP-, 5099 . , , Flask, /metrics, URI , register_endpoint(..), .

Si vous décidez de l'essayer, n'hésitez pas à ouvrir un problème sur GitHub ou à laisser vos commentaires, vos commentaires et vos suggestions!

Merci!



More articles:


All Articles