multiproc

Util function to set env variable for Prometheus multiprocessing mode

Functions:

• check_multiproc_mode –

  Function to check multiproc mode

• clean_multiproc_mode_folder –

  Function to clean up Prometheus metrics folder

• handle_builtin_metrics –

  Function to enable/disable built-in metrics collector

• set_prometheus_multiproc_mode –

  Function to set Prometheus multiprocessing mode

check_multiproc_mode

check_multiproc_mode() -> bool

Function to check multiproc mode

Returns:

• bool –

  True if multiproc mode is set, False otherwise

clean_multiproc_mode_folder

clean_multiproc_mode_folder(folder: Path | None = None) -> bool

Function to clean up Prometheus metrics folder

Parameters:

• folder

  (Path | None, default: None ) –

  Folder to store metrics

Returns:

• bool –

  True if cleaning was successful, False otherwise

handle_builtin_metrics

handle_builtin_metrics(reg: CollectorRegistry | None = None, enable: bool = False) -> None

Function to enable/disable built-in metrics collector

Parameters:

• reg

  (CollectorRegistry | None, default: None ) –

  Registry to enable/disable built-in metrics collector

• enable

  (bool, default: False ) –

  True if built-in metrics collector have to be enabled, False otherwise

Returns:

• None –

  Nothing

set_prometheus_multiproc_mode

set_prometheus_multiproc_mode(metrics_folder: Path | str | None = None, clean: bool = True) -> bool

Function to set Prometheus multiprocessing mode

Parameters:

• metrics_folder

  (Path | str | None, default: None ) –

  Folder to store metrics

• clean

  (bool, default: True ) –

  Clean up prometheus metrics folder (True by default)

Returns:

• bool –

  True if multiproc mode is set, False otherwise