Skip to content

MetricsManager

faststream.prometheus.manager.MetricsManager #

MetricsManager(container, *, app_name='faststream')
Source code in faststream/prometheus/manager.py 
 8
 9
10
def __init__(self, container: MetricsContainer, *, app_name: str = "faststream"):
    self._container = container
    self._app_name = app_name

add_received_message #

add_received_message(broker, handler, amount=1)
Source code in faststream/prometheus/manager.py 
12
13
14
15
16
17
def add_received_message(self, broker: str, handler: str, amount: int = 1) -> None:
    self._container.received_messages_total.labels(
        app_name=self._app_name,
        broker=broker,
        handler=handler,
    ).inc(amount)

observe_received_messages_size #

observe_received_messages_size(broker, handler, size)
Source code in faststream/prometheus/manager.py 
19
20
21
22
23
24
25
26
27
28
29
def observe_received_messages_size(
    self,
    broker: str,
    handler: str,
    size: int,
) -> None:
    self._container.received_messages_size_bytes.labels(
        app_name=self._app_name,
        broker=broker,
        handler=handler,
    ).observe(size)

add_received_message_in_process #

add_received_message_in_process(broker, handler, amount=1)
Source code in faststream/prometheus/manager.py 
31
32
33
34
35
36
37
38
39
40
41
def add_received_message_in_process(
    self,
    broker: str,
    handler: str,
    amount: int = 1,
) -> None:
    self._container.received_messages_in_process.labels(
        app_name=self._app_name,
        broker=broker,
        handler=handler,
    ).inc(amount)

remove_received_message_in_process #

remove_received_message_in_process(broker, handler, amount=1)
Source code in faststream/prometheus/manager.py 
43
44
45
46
47
48
49
50
51
52
53
def remove_received_message_in_process(
    self,
    broker: str,
    handler: str,
    amount: int = 1,
) -> None:
    self._container.received_messages_in_process.labels(
        app_name=self._app_name,
        broker=broker,
        handler=handler,
    ).dec(amount)

add_received_processed_message #

add_received_processed_message(broker, handler, status, amount=1)
Source code in faststream/prometheus/manager.py 
55
56
57
58
59
60
61
62
63
64
65
66
67
def add_received_processed_message(
    self,
    broker: str,
    handler: str,
    status: ProcessingStatus,
    amount: int = 1,
) -> None:
    self._container.received_processed_messages_total.labels(
        app_name=self._app_name,
        broker=broker,
        handler=handler,
        status=status.value,
    ).inc(amount)

observe_received_processed_message_duration #

observe_received_processed_message_duration(duration, broker, handler)
Source code in faststream/prometheus/manager.py 
69
70
71
72
73
74
75
76
77
78
79
def observe_received_processed_message_duration(
    self,
    duration: float,
    broker: str,
    handler: str,
) -> None:
    self._container.received_processed_messages_duration_seconds.labels(
        app_name=self._app_name,
        broker=broker,
        handler=handler,
    ).observe(duration)

add_received_processed_message_exception #

add_received_processed_message_exception(broker, handler, exception_type)
Source code in faststream/prometheus/manager.py 
81
82
83
84
85
86
87
88
89
90
91
92
def add_received_processed_message_exception(
    self,
    broker: str,
    handler: str,
    exception_type: str,
) -> None:
    self._container.received_processed_messages_exceptions_total.labels(
        app_name=self._app_name,
        broker=broker,
        handler=handler,
        exception_type=exception_type,
    ).inc()

add_published_message #

add_published_message(broker, destination, status, amount=1)
Source code in faststream/prometheus/manager.py 
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
def add_published_message(
    self,
    broker: str,
    destination: str,
    status: PublishingStatus,
    amount: int = 1,
) -> None:
    self._container.published_messages_total.labels(
        app_name=self._app_name,
        broker=broker,
        destination=destination,
        status=status.value,
    ).inc(amount)

observe_published_message_duration #

observe_published_message_duration(duration, broker, destination)
Source code in faststream/prometheus/manager.py 
108
109
110
111
112
113
114
115
116
117
118
def observe_published_message_duration(
    self,
    duration: float,
    broker: str,
    destination: str,
) -> None:
    self._container.published_messages_duration_seconds.labels(
        app_name=self._app_name,
        broker=broker,
        destination=destination,
    ).observe(duration)

add_published_message_exception #

add_published_message_exception(broker, destination, exception_type)
Source code in faststream/prometheus/manager.py 
120
121
122
123
124
125
126
127
128
129
130
131
def add_published_message_exception(
    self,
    broker: str,
    destination: str,
    exception_type: str,
) -> None:
    self._container.published_messages_exceptions_total.labels(
        app_name=self._app_name,
        broker=broker,
        destination=destination,
        exception_type=exception_type,
    ).inc()