Prometheus를 사용하여 Flask 마이크로서비스 모니터링

몇 줄의 코드와 애플리케이션이 측정항목을 생성합니다. 와!

prometheus_의 작동 방식을 이해하려면플라스크_수출업자는 최소한의 예만으로 충분합니다:

from flask import Flask
from prometheus_flask_exporter import PrometheusMetrics

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

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

시작하는 데 필요한 전부입니다! 초기화를 위한 가져오기 및 라인 추가 Prometheus메트릭스, 측정항목을 얻게 됩니다. 요청 기간 и 요청 카운터, 엔드포인트에 표시됨 /측정항목 등록된 Flask 애플리케이션과 기본에서 얻는 모든 기본 측정항목 프로메테우스 클라이언트 라이브러리.

당신은 찾을 수 있습니다 사용하기 쉬운 예 인스턴스를 실행하는 GitHub 저장소에서 프로 메테우스 и 그라 파나 데모 애플리케이션과 함께 다음과 같은 측정항목을 생성합니다.

또한 다음에서 지표 목록을 찾을 수 있습니다. README 대시보드를 채우는 Prometheus 쿼리와 함께 대시보드에 표시되는 예입니다.

조정

라이브러리에는 많은 구성 옵션이 있습니다. README 간단한 설명과 함께 프로젝트 사례를 소개합니다.

기본 구성은 위에 나와 있습니다. 그냥 인스턴스를 만들어 보세요 Prometheus메트릭스, 불러보자 통계, 그리고 이를 사용하여 함수를 장식하여 수집하려는 추가 측정항목을 정의합니다.

• @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", 상태 = "200"}, 또한 기본 라이브러리에서 기본 측정항목(이 예에서는 각 엔드포인트에 대한)을 가져옵니다.

• flask_http_request_duration_seconds — 메서드, 경로 및 상태별 모든 Flask 요청에 대한 HTTP 요청 기간(초)

• 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 또는 도커 스웜.

이러한 방식으로 측정항목 끝점을 노출하는 것이 적합하지 않은 경우(아마도 외부 액세스를 허용하고 싶지 않기 때문에) 다음을 전달하여 쉽게 비활성화할 수 있습니다. 경로=없음 인스턴스를 생성할 때 Prometheus메트릭스.

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 — 프로메테우스의 병 수출업자

• 프로메테우스-플라스크-수출기 README — 사용법, 예시 및 구성 옵션

• prometheus-flask-exporter 예제 — 다양한 방식으로 Flask 애플리케이션 모니터링을 설정하는 예

• PyPI의 prometheus-flask-exporter — 이 프로젝트는 PyPI에 있습니다.

• 프로메테우스/client_python — Python용 공식 Prometheus 클라이언트 라이브러리

한번 시도해 보시기로 결정하셨다면 GitHub에서 문제를 공개하시거나 댓글, 피드백, 제안을 남겨주세요!

감사합니다!

출처 : habr.com