Upgrading prometheus-fastapi-instrumentator 4 to 5
Unknown4.0.0 → 5.11.2
Fetching 24 releases from GitHub…0 / 24
UnknownUpgrade verdict
DepDelta is still reading the notes for this range, so breaking changes can't be ruled out yet.
In plain terms
- DepDelta is still reading the release notes in this range, so it can't rule out breaking changes yet.
- This page updates as the notes come in.
Must act Still reading release notes
DepDelta is still reading the release notes in this range. This updates as they come in.
Python requirement changed in 5.8.0: >=3.6,<4.0 → >=3.7.0,<4.0.0.
API changes
Generated by DepDelta from published Python source. Not mixed with prose notes.
- removed:
export instrumentation - removed:
variable PrometheusFastApiInstrumentator - added:
export PrometheusFastApiInstrumentator
- changed:
constructor PrometheusFastApiInstrumentator(should_group_status_codes: bool=…, should_ignore_untemplated: bool=…, should_group_untemplated: bool=…, should_round_latency_decimals: bool=…, should_respect_env_var: bool=…, excluded_handlers: list=…, round_latency_decimals: int=…, env_var_name: str=…) → constructor PrometheusFastApiInstrumentator(should_group_status_codes: bool=…, should_ignore_untemplated: bool=…, should_group_untemplated: bool=…, should_round_latency_decimals: bool=…, should_respect_env_var: bool=…, should_instrument_requests_inprogress: bool=…, excluded_handlers: List[str]=…, round_latency_decimals: int=…, env_var_name: str=…, inprogress_name: str=…, inprogress_labels: bool=…… - changed:
method PrometheusFastApiInstrumentator.add(instrumentation_function: Callable[[metrics.Info], None]) -> self → method PrometheusFastApiInstrumentator.add(*instrumentation_function: Optional[Callable[[metrics.Info], Union[None, Awaitable[None]]]]) -> PrometheusFastApiInstrumentator - changed:
method PrometheusFastApiInstrumentator.expose(app: FastAPI, endpoint: str=…, include_in_schema: bool=…) -> self → method PrometheusFastApiInstrumentator.expose(app: FastAPI, should_gzip: bool=…, endpoint: str=…, include_in_schema: bool=…, tags: Optional[List[Union[str, Enum]]]=…, **kwargs: Any) -> PrometheusFastApiInstrumentator - changed:
method PrometheusFastApiInstrumentator.instrument(app: FastAPI) -> self → method PrometheusFastApiInstrumentator.instrument(app: FastAPI, metric_namespace: str=…, metric_subsystem: str=…, should_only_respect_2xx_for_highr: bool=…, latency_highr_buckets: Sequence[Union[float, str]]=…, latency_lowr_buckets: Sequence[Union[float, str]]=…) -> PrometheusFastApiInstrumentator
- removed:
function full(latency_highr_buckets: tuple=…, latency_lowr_buckets: tuple=…) -> Callable[[Info], None] - changed:
constructor Info(request: Request, response: Response or None, method: str, modified_handler: str, modified_status: str, modified_duration: float) → constructor Info(request: Request, response: Optional[Response], method: str, modified_handler: str, modified_status: str, modified_duration: float) - changed:
function combined_size(metric_name: str=…, metric_doc: str=…, should_include_handler: bool=…, should_include_method: bool=…, should_include_status: bool=…) -> Callable[[Info], None] → function combined_size(metric_name: str=…, metric_doc: str=…, metric_namespace: str=…, metric_subsystem: str=…, should_include_handler: bool=…, should_include_method: bool=…, should_include_status: bool=…, registry: CollectorRegistry=…) -> Optional[Callable[[Info], None]] - changed:
function latency(metric_name: str=…, metric_doc: str=…, should_include_handler: bool=…, should_include_method: bool=…, should_include_status: bool=…, buckets: tuple=…) -> Callable[[Info], None] → function latency(metric_name: str=…, metric_doc: str=…, metric_namespace: str=…, metric_subsystem: str=…, should_include_handler: bool=…, should_include_method: bool=…, should_include_status: bool=…, buckets: Sequence[Union[float, str]]=…, registry: CollectorRegistry=…) -> Optional[Callable[[Info], None]] - changed:
function request_size(metric_name: str=…, metric_doc: str=…, should_include_handler: bool=…, should_include_method: bool=…, should_include_status: bool=…) -> Callable[[Info], None] → function request_size(metric_name: str=…, metric_doc: str=…, metric_namespace: str=…, metric_subsystem: str=…, should_include_handler: bool=…, should_include_method: bool=…, should_include_status: bool=…, registry: CollectorRegistry=…) -> Optional[Callable[[Info], None]] - changed:
function response_size(metric_name: str=…, metric_doc: str=…, should_include_handler: bool=…, should_include_method: bool=…, should_include_status: bool=…) -> Callable[[Info], None] → function response_size(metric_name: str=…, metric_doc: str=…, metric_namespace: str=…, metric_subsystem: str=…, should_include_handler: bool=…, should_include_method: bool=…, should_include_status: bool=…, registry: CollectorRegistry=…) -> Optional[Callable[[Info], None]] - added:
function default(metric_namespace: str=…, metric_subsystem: str=…, should_only_respect_2xx_for_highr: bool=…, latency_highr_buckets: Sequence[Union[float, str]]=…, latency_lowr_buckets: Sequence[Union[float, str]]=…, registry: CollectorRegistry=…) -> Optional[Callable[[Info], None]] - added:
function requests(metric_name: str=…, metric_doc: str=…, metric_namespace: str=…, metric_subsystem: str=…, should_include_handler: bool=…, should_include_method: bool=…, should_include_status: bool=…, registry: CollectorRegistry=…) -> Optional[Callable[[Info], None]]
- added:
class PrometheusInstrumentatorMiddleware - added:
constructor PrometheusInstrumentatorMiddleware(app: FastAPI, *, should_group_status_codes: bool=…, should_ignore_untemplated: bool=…, should_group_untemplated: bool=…, should_round_latency_decimals: bool=…, should_respect_env_var: bool=…, should_instrument_requests_inprogress: bool=…, excluded_handlers: Sequence[str]=…, round_latency_decimals: int=…, env_var_name: str=…, inprogress_name: str=…, i…
- added:
function get_route_name(request: Request) -> Optional[str]