🥇Наблюдение на микроуслугите на Flask с Prometheus

Няколко реда код и вашето приложение генерира показатели, уау!

За да разберете как работи Прометей_колба_износител е достатъчен минимален пример:

from flask import Flask
from prometheus_flask_exporter import PrometheusMetrics

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

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

Това е всичко, от което се нуждаете, за да започнете! Чрез добавяне на импорт и ред за инициализация Метрика на Прометей, ще получите показатели продължителност на заявката и броячи на заявкипоказани в крайната точка /метрика приложението Flask, с което е регистрирано, плюс всички показатели по подразбиране, които получавате от базата Клиентска библиотека на Prometheus.

можете да намерите лесен за използване пример в хранилището на GitHub, което стартира екземпляра Прометей и Графана заедно с демонстрационно приложение за генериране на показатели, което би изглеждало така:

Ще намерите и списък с индикатори в README примери, които се появяват в таблото за управление, заедно със заявките на Prometheus, които попълват таблата за управление.

регулиране

Библиотеката има много опции за конфигурация, разгледайте README проектират своите примери с кратко обяснение.

Основната конфигурация е показана по-горе. Просто инстанцирайте Метрика на Прометей, да го наречем метрикаи след това го използвайте, за да дефинирате допълнителни показатели, които искате да съберете чрез декориращи функции:

@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

В горния пример щракване върху крайната точка /колекция/10002/т./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 адреси, като например при стартиране Kubernetes или Докер рояк.

Ако излагането на крайната точка на показателите по този начин не ви подхожда, може би защото не искате да разрешите външен достъп до нея, можете лесно да я деактивирате, като преминете път=Няма при инстанциране Метрика на Прометей.

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(порт)за да отворите тази крайна точка на различен HTTP порт, 5099 в горния пример. Като алтернатива, ако сте доволни от това, че крайната точка е в същото приложение на Flask, но трябва да промените пътя му от /метрика, можете да подадете различен URI като параметър на пътя или да използвате регистър_крайна точка(..)за да го инсталирате по-късно.

Позоваването

rycus86/prometheus_flask_exporter - Този износител на колба за Прометей
prometheus-flask-exporter README - Използване, примери и опции за конфигурация
примери за прометей-колба-износител - Примери за конфигуриране на мониторинг на Flask приложения по различни начини
prometheus-flask-exporter на PyPI — Този проект е на PyPI
prometheus/client_python - Официална клиентска библиотека на Prometheus за Python