Надгледање Фласк микросервиса са Прометхеусом

Неколико линија кода и ваша апликација генерише метрику, вау!

Да бисмо разумели како прометеј_ функционишефласк_извозник довољан је минимални пример:

from flask import Flask
from prometheus_flask_exporter import PrometheusMetrics

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

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

То је све што вам треба да започнете! Додавањем увоза и линије за иницијализацију ПрометхеусМетрицс, добићете метрику трајање захтева и бројачи захтева, приказан на крајњој тачки /метрицс Фласк апликацију за коју је регистрован, као и све подразумеване метрике које добијате из базе Прометхеус клијентска библиотека.

можете наћи једноставан за употребу пример у ГитХуб спремишту које покреће инстанцу Прометеј и Графана заједно са демо апликацијом за генерисање метрике која ће изгледати отприлике овако:

Такође ћете пронаћи листу индикатора у РЕАДМЕ примери који се појављују на контролној табли, заједно са Прометхеус упитима који попуњавају контролне табле.

подешавање

У библиотеци постоји много опција за конфигурацију, погледајте РЕАДМЕ пројектне примере њих са кратким образложењем.

Основна конфигурација је приказана изнад. Само креирајте инстанцу ПрометхеусМетрицс, назовимо то метрике, а затим га користите да дефинишете додатне метрике које желите да прикупите украшавањем функција:

• @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 ће узроковати повећање бројача, на пример цнт_цоллецтион{цоллецтион = "10002", статус = "200"}, плус добићете подразумевану метрику (за сваку крајњу тачку у овом примеру) из подразумеване библиотеке:

• flask_http_request_duration_seconds — Трајање ХТТП захтева у секундама за све Фласк захтеве према методу, путањи и статусу

• flask_http_request_total — Укупан број ХТТП захтева по методама и статусима

Постоје опције да прескочите праћење одређених крајњих тачака, евидентирате додатне подразумеване метрике или прескочите оне горе наведене или примените исту прилагођену метрику на више крајњих тачака. Провери РЕАДМЕ пројекат да видите шта је доступно.

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

Библиотека има погодна проширења за популарне библиотеке за више процеса као што су уВСГИ и Гуницорн. Такође можете пронаћи мале примере циљаних случајева употребе, укључујући вишепроцесну обраду.

Колекција метрика

Као што је горе поменуто, библиотека подразумевано обезбеђује крајњу тачку /метрицс у Фласк апликацији, која може послужити као мета за Прометеј градитељ.

У горњем примеру контролне табле, можете циљати свој Прометхеус на Фласк апликацију са подразумеваним подешавањима са овом конфигурацијом:

scrape_configs:
  - job_name: 'example'

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

Погледајте цео пример на ГитХуб спремишта. Ово претпоставља да Прометхеус може да пронађе инстанце ваше Фласк апликације http://app:5000/metrics, где би име домена апликације потенцијално могло да се разреши на више ИП адреса, на пример када се покреће Кубернетес или Доцкер Сварм.

Ако вам излагање крајње тачке метрике на овај начин не одговара, можда зато што не желите да јој дозволите спољни приступ, можете је лако онемогућити тако што ћете пренети патх=Ништа приликом креирања инстанце ПрометхеусМетрицс.

from flask import Flask, request
from prometheus_flask_exporter import PrometheusMetrics

app = Flask(__name__)
metrics = PrometheusMetrics(app, path=None)

...

metrics.start_http_server(5099)

Онда можете користити старт_хттп_сервер(порт)да отворите ову крајњу тачку на другом ХТТП порту, 5099 у горњем примеру. Алтернативно, ако сте задовољни што је крајња тачка у истој Фласк апликацији, али морате да промените њену путању са /метрицс, можете проследити други УРИ као параметар путање или користити регистер_ендпоинт(..)да бисте га касније инсталирали.

референце

• рицус86/прометхеус_фласк_екпортер — Овај извозник боца за Прометеј

• прометхеус-фласк-екпортер РЕАДМЕ — Употреба, примери и опције конфигурације

• примери прометеј-фласк-екпортер — Примери подешавања праћења Фласк апликација на различите начине

• прометхеус-фласк-екпортер на ПиПИ — Овај пројекат је на ПиПИ

• прометхеус/цлиент_питхон — Званична Прометхеус клијентска библиотека за Питхон

Ако одлучите да пробате, слободно отворите проблем на ГитХуб-у или оставите своје коментаре, повратне информације и сугестије!

Хвала!

Извор: ввв.хабр.цом