o ^۷i5@sddlZddlZddlZddlZddlZddlZddlmZddl m Z m Z m Z m Z mZmZmZmZddlmZmZmZmZmZddlmZddlmZddlmZddlmZdd l m!Z!Gd d d Z"dS) N)Enum)Any AwaitableCallableListOptionalSequenceUnioncast)CONTENT_TYPE_LATESTREGISTRYCollectorRegistrygenerate_latest multiprocess) Starlette)Request)Response)metrics)"PrometheusInstrumentatorMiddlewarec@sFeZdZdddddddggdddddfdeded ed ed ed ed edeedeedededededeedfddfddZ     d0de dededede ee efd e ee efddfd!d"Z  #  d1de d$ed%ed&ed'eeeeefd(eddfd)d*Zd+eeejgededffddfd,d-Zdefd.d/ZdS)2PrometheusFastApiInstrumentatorTFENABLE_METRICShttp_requests_inprogressNshould_group_status_codesshould_ignore_untemplatedshould_group_untemplatedshould_round_latency_decimalsshould_respect_env_var%should_instrument_requests_inprogress!should_exclude_streaming_durationexcluded_handlers body_handlersround_latency_decimals env_var_nameinprogress_nameinprogress_labelsregistryreturncCs||_||_||_||_||_||_||_| |_| |_| |_ | |_ dd|D|_ dd| D|_ g|_ g|_dtjvrOdtjvrOtjdtjd<tdt|rU||_nt|_dtjvrptjd}tj|srtd|dd Sd S) a Create a Prometheus FastAPI (and Starlette) Instrumentator. Args: should_group_status_codes (bool): Should status codes be grouped into `2xx`, `3xx` and so on? Defaults to `True`. should_ignore_untemplated (bool): Should requests without a matching template be ignored? Defaults to `False`. This means that by default a request like `curl -X GET localhost:80/doesnotexist` will be ignored. should_group_untemplated (bool): Should requests without a matching template be grouped to handler `none`? Defaults to `True`. should_round_latency_decimals: Should recorded latencies be rounded to a certain number of decimals? should_respect_env_var (bool): Should the instrumentator only work - for example the methods `instrument()` and `expose()` - if a certain environment variable is set to `true`? Usecase: A base FastAPI app that is used by multiple distinct apps. The apps only have to set the variable to be instrumented. Defaults to `False`. should_instrument_requests_inprogress (bool): Enables a gauge that shows the inprogress requests. See also the related args starting with `inprogress`. Defaults to `False`. should_exclude_streaming_duration: Should the streaming duration be excluded? Only relevant if default metrics are used. Defaults to `False`. excluded_handlers (List[str]): List of strings that will be compiled to regex patterns. All matches will be skipped and not instrumented. Defaults to `[]`. body_handlers (List[str]): List of strings that will be compiled to regex patterns to match handlers for the middleware to pass through response bodies to instrumentations. So only relevant for instrumentations that access `info.response.body`. Note that this has a noticeable negative impact on performance with responses larger than a few MBs. Defaults to `[]`. round_latency_decimals (int): Number of decimals latencies should be rounded to. Ignored unless `should_round_latency_decimals` is `True`. Defaults to `4`. env_var_name (str): Any valid os environment variable name that will be checked for existence before instrumentation. Ignored unless `should_respect_env_var` is `True`. Defaults to `"ENABLE_METRICS"`. inprogress_name (str): Name of the gauge. Defaults to `http_requests_inprogress`. Ignored unless `should_instrument_requests_inprogress` is `True`. inprogress_labels (bool): Should labels `method` and `handler` be part of the inprogress label? Ignored unless `should_instrument_requests_inprogress` is `True`. Defaults to `False`. registry (CollectorRegistry): A custom Prometheus registry to use. If not provided, the default `REGISTRY` will be used. This can be useful if you need to run multiple apps at the same time, with their own registries, for example during testing. Raises: ValueError: If `PROMETHEUS_MULTIPROC_DIR` env var is found but doesn't point to a valid directory. cSg|]}t|qSrecompile.0pathr)r)g/home/ubuntu/vllm_env/lib/python3.10/site-packages/prometheus_fastapi_instrumentator/instrumentation.py z.cSr(r)r*r-r)r)r0r1r2prometheus_multiproc_dirPROMETHEUS_MULTIPROC_DIRzpprometheus_multiproc_dir variable has been deprecated in favor of the upper case naming PROMETHEUS_MULTIPROC_DIRz"Env var PROMETHEUS_MULTIPROC_DIR='z' not a directory.N)rrrrrrrr"r#r$r%r r!instrumentationsasync_instrumentationsosenvironwarningswarnDeprecationWarningr&r r/isdir ValueError)selfrrrrrrrr r!r"r#r$r%r&pmdr)r)r0__init__sFV       z(PrometheusFastApiInstrumentator.__init__g{Gz?g?g?g333333?皙?g??g?g?g@g @rg@g@ <rCrDrEappmetric_namespacemetric_subsystem!should_only_respect_2xx_for_highrlatency_highr_bucketslatency_lowr_bucketscCs|jr |s |S|jtfid|jd|jd|jd|jd|jd|jd|j d|j d |j d |j d |j d |jd |jd|jd|jd|d|d|d|d|d|j|S)aPerforms the instrumentation by adding middleware. The middleware iterates through all `instrumentations` and executes them. Args: app: Starlette app instance. Note that every FastAPI app is a Starlette app. Raises: e: Only raised if app itself throws an exception. Returns: self: Instrumentator. Builder Pattern. rrrrrrrr"r#r$r%r5r6r r!rNrOrPrQrRr&)r_should_instrumentateadd_middlewarerrrrrrrr"r#r$r%r5r6r r!r&)r>rMrNrOrPrQrRr)r)r0 instruments`.     z*PrometheusFastApiInstrumentator.instrument/metrics should_gzipendpointinclude_in_schematagskwargsc  sjr s Sdtdtffdd }d}tjdr:ddlm} t || r:|} | j |f||d ||d }|sD|j |||d S) aExposes endpoint for metrics. Args: app: App instance. Endpoint will be added to this app. This can be a Starlette app or a FastAPI app. If it is a Starlette app, `tags` `kwargs` will be ignored. should_gzip: Should the endpoint return compressed data? It will also check for `gzip` in the `Accept-Encoding` header. Compression consumes more CPU cycles. In most cases it's best to just leave this option off since network bandwidth is usually cheaper than CPU cycles. Defaults to `False`. endpoint: Endpoint on which metrics should be exposed. include_in_schema: Should the endpoint show up in the documentation? tags (List[str], optional): If you manage your routes with tags. Defaults to None. Only passed to FastAPI app. kwargs: Will be passed to app. Only passed to FastAPI app. Returns: self: Instrumentator. Builder Pattern. requestr'cs~j}dtjvrt}t|r1d|jddvr1tt t |d}t |jd<d|jd<|Stt |d}t |jd<|S)z(Endpoint that serves Prometheus metrics.r4gzipzAccept-EncodingrA)contentz Content-TypezContent-Encoding) r&r7r8r rMultiProcessCollectorheadersgetrr]compressrr )r\ephemeral_registryrespr>rWr)r0rs      z7PrometheusFastApiInstrumentator.expose..metricsFfastapir)FastAPI)rYrZT)r/routerY) rrSrr importlibutil find_specrfrg isinstancera add_route) r>rMrWrXrYrZr[rroute_configuredrg fastapi_appr)rer0exposes.#   z&PrometheusFastApiInstrumentator.exposeinstrumentation_functioncGs^|D]*}|r,t|r|jtttjgtdf|q|j tttjgdf|q|S)avAdds function to list of instrumentations. Args: instrumentation_function: Function that will be executed during every request handler call (if not excluded). See above for detailed information on the interface of the function. Returns: self: Instrumentator. Builder Pattern. N) asyncioiscoroutinefunctionr6appendr rrInforr5)r>rqfuncr)r)r0add3s z#PrometheusFastApiInstrumentator.addcCst|jddvS)z?Checks if instrumentation should be performed based on env var.False)true1)r7getenvr#lower)r>r)r)r0rSUsz5PrometheusFastApiInstrumentator._should_instrumentate)rArAFrBrL)FrVTN)__name__ __module__ __qualname__boolrstrintr r r@rrfloatrUrrrrprrrurrwrSr)r)r)r0rs        N K "r)#rrr]importlib.utilrir7r+r9enumrtypingrrrrrrr r prometheus_clientr r r rrstarlette.applicationsrstarlette.requestsrstarlette.responsesr!prometheus_fastapi_instrumentatorr,prometheus_fastapi_instrumentator.middlewarerrr)r)r)r0s (