Code Monkey home page Code Monkey logo

flask-prom's Introduction

Flask-Prom

This will allow you to easily add Prometheus metrics to your Flask applications.

This extension instruments every flask route and exports the following metrics:

  • Histogram: <myapp_flask_request_latency_seconds> {'endpoint', 'method'}
  • Summary: <myapp_flask_request_count> {'endpoint','method','http_status'}

Install

pip install flask_prom

Usage

1. WSGI Add-On (Same Port)

For serving Prometheus metrics on the same port as your Flask application.

from flask import Flask
from flask_prom import monitor

app = Flask("myapp")

@app.route('/')
def hello():
    return 'Hello'

app.wsgi_app = monitor(app, path="/metrics")
app.run()

Then visit localhost:8000/metrics to see your metrics. They are served from the same port as your application!

2. HTTP Server (Different Port)

For creating a separate HTTP server to serve prometheus metrics.

from flask import Flask
from flask_prom import monitor

app = Flask("myapp")

@app.route('/')
def hello():
    return 'Hello'

monitor(app, path="/metrics", http_server=True, port=9090, addr="127.0.0.1")
app.run()

Then visit localhost:9090/metrics to see your metrics.

Credits

This python library was forked from https://github.com/sbarratt/flask-prometheus, since it was no longer being maintained.

License

BSD-3

TODO

  • automatic release to GitHub/PyPi on new tag

flask-prom's People

Contributors

xeroc avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.