ניטור מיקרו-שירותי Flask עם Prometheus

כמה שורות קוד והאפליקציה שלך מייצרת מדדים, וואו!

על מנת להבין איך פרומתאוס_ עובדבקבוק_ליצואן מספיקה דוגמה מינימלית:

from flask import Flask
from prometheus_flask_exporter import PrometheusMetrics

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

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

זה כל מה שאתה צריך כדי להתחיל! על ידי הוספת ייבוא ​​ושורה לאתחול PrometheusMetrics, תקבל מדדים משך הבקשה и דלפקי בקשה, מוצג בנקודת הקצה /מטרים אפליקציית Flask שבה היא רשומה, כמו גם כל מדדי ברירת המחדל שאתה מקבל מהבסיס ספריית לקוחות פרומתאוס.

אתה יכול למצוא דוגמה קלה לשימוש במאגר GitHub שמפעיל את המופע פרומתאוס и גרפנה יחד עם אפליקציית הדגמה ליצירת מדדים שיראו בערך כך:

תמצא גם רשימה של אינדיקטורים ב README דוגמאות המופיעות בלוח המחוונים, יחד עם שאילתות פרומתאוס המאכלסות את לוחות המחוונים.

התאמה

ישנן אפשרויות תצורה רבות בספריה, תראה README פרויקט דוגמאות שלהם עם הסבר קצר.

התצורה הבסיסית מוצגת למעלה. פשוט צור מופע PrometheusMetrics, בואו נקרא לזה מדדים, ולאחר מכן השתמש בו כדי להגדיר את המדדים הנוספים שברצונך לאסוף על ידי עיטור הפונקציות:

• @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. אתה יכול גם למצוא דוגמאות קטנות למקרי שימוש ממוקדים, כולל ריבוי עיבודים.

אוסף מדדים

כפי שהוזכר לעיל, הספרייה מספקת נקודת קצה כברירת מחדל /מטרים ביישום Flask, שיכול לשמש מטרה עבור בונה פרומתאוס.

בדוגמה של לוח המחוונים לעיל, תוכל למקד את ה-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 מרובות, למשל בעת ריצה קוברנט או נחיל דוקר.

אם חשיפת נקודת הקצה של המדדים בצורה זו לא מתאימה לך, אולי בגלל שאינך רוצה לאפשר גישה חיצונית אליה, תוכל לבטל אותה בקלות על ידי מעבר נתיב=אין בעת יצירת מופע 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, אך עליך לשנות את הנתיב שלה מ /מטרים, אתה יכול להעביר URI אחר כפרמטר הנתיב, או להשתמש register_endpoint(..)להתקין אותו מאוחר יותר.

תזכור

• rycus86/prometheus_flask_exporter - יצואן הבקבוקים הזה עבור פרומתאוס

• prometheus-flask-exporter README - שימוש, דוגמאות ואפשרויות תצורה

• דוגמאות של prometheus-flask-exporter - דוגמאות להגדרת ניטור יישומי Flask בדרכים שונות

• prometheus-flask-exporter על PyPI - הפרויקט הזה נמצא ב- PyPI

• prometheus/client_python - ספריית לקוחות רשמית של Prometheus עבור Python

אם תחליט לנסות את זה, אל תהסס לפתוח בעיה ב-GitHub או להשאיר את ההערות, המשוב וההצעות שלך!

תודה לך!

מקור: www.habr.com