Skip to content

MetricsContainer

faststream.prometheus.container.MetricsContainer #

MetricsContainer(
    registry,
    *,
    metrics_prefix="faststream",
    received_messages_size_buckets=None,
)
Source code in faststream/prometheus/container.py 
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
def __init__(
    self,
    registry: "CollectorRegistry",
    *,
    metrics_prefix: str = "faststream",
    received_messages_size_buckets: Sequence[float] | None = None,
) -> None:
    self._registry = registry
    self._metrics_prefix = metrics_prefix

    received_messages_total_name = f"{metrics_prefix}_received_messages_total"
    self.received_messages_total = cast(
        "Counter",
        self._get_registered_metric(received_messages_total_name),
    ) or Counter(
        name=received_messages_total_name,
        documentation="Count of received messages by broker and handler",
        labelnames=["app_name", "broker", "handler"],
        registry=registry,
    )

    received_messages_size_bytes_name = (
        f"{metrics_prefix}_received_messages_size_bytes"
    )
    self.received_messages_size_bytes = cast(
        "Histogram",
        self._get_registered_metric(received_messages_size_bytes_name),
    ) or Histogram(
        name=received_messages_size_bytes_name,
        documentation="Histogram of received messages size in bytes by broker and handler",
        labelnames=["app_name", "broker", "handler"],
        registry=registry,
        buckets=received_messages_size_buckets or self.DEFAULT_SIZE_BUCKETS,
    )

    received_messages_in_process_name = (
        f"{metrics_prefix}_received_messages_in_process"
    )
    self.received_messages_in_process = cast(
        "Gauge",
        self._get_registered_metric(received_messages_in_process_name),
    ) or Gauge(
        name=received_messages_in_process_name,
        documentation="Gauge of received messages in process by broker and handler",
        labelnames=["app_name", "broker", "handler"],
        registry=registry,
    )

    received_processed_messages_total_name = (
        f"{metrics_prefix}_received_processed_messages_total"
    )
    self.received_processed_messages_total = cast(
        "Counter",
        self._get_registered_metric(received_processed_messages_total_name),
    ) or Counter(
        name=received_processed_messages_total_name,
        documentation="Count of received processed messages by broker, handler and status",
        labelnames=["app_name", "broker", "handler", "status"],
        registry=registry,
    )

    received_processed_messages_duration_seconds_name = (
        f"{metrics_prefix}_received_processed_messages_duration_seconds"
    )
    self.received_processed_messages_duration_seconds = cast(
        "Histogram",
        self._get_registered_metric(
            received_processed_messages_duration_seconds_name,
        ),
    ) or Histogram(
        name=received_processed_messages_duration_seconds_name,
        documentation="Histogram of received processed messages duration in seconds by broker and handler",
        labelnames=["app_name", "broker", "handler"],
        registry=registry,
    )

    received_processed_messages_exceptions_total_name = (
        f"{metrics_prefix}_received_processed_messages_exceptions_total"
    )
    self.received_processed_messages_exceptions_total = cast(
        "Counter",
        self._get_registered_metric(
            received_processed_messages_exceptions_total_name,
        ),
    ) or Counter(
        name=received_processed_messages_exceptions_total_name,
        documentation="Count of received processed messages exceptions by broker, handler and exception_type",
        labelnames=["app_name", "broker", "handler", "exception_type"],
        registry=registry,
    )

    published_messages_total_name = f"{metrics_prefix}_published_messages_total"
    self.published_messages_total = cast(
        "Counter",
        self._get_registered_metric(published_messages_total_name),
    ) or Counter(
        name=published_messages_total_name,
        documentation="Count of published messages by destination and status",
        labelnames=["app_name", "broker", "destination", "status"],
        registry=registry,
    )

    published_messages_duration_seconds_name = (
        f"{metrics_prefix}_published_messages_duration_seconds"
    )
    self.published_messages_duration_seconds = cast(
        "Histogram",
        self._get_registered_metric(published_messages_duration_seconds_name),
    ) or Histogram(
        name=published_messages_duration_seconds_name,
        documentation="Histogram of published messages duration in seconds by broker and destination",
        labelnames=["app_name", "broker", "destination"],
        registry=registry,
    )

    published_messages_exceptions_total_name = (
        f"{metrics_prefix}_published_messages_exceptions_total"
    )
    self.published_messages_exceptions_total = cast(
        "Counter",
        self._get_registered_metric(published_messages_exceptions_total_name),
    ) or Counter(
        name=published_messages_exceptions_total_name,
        documentation="Count of published messages exceptions by broker, destination and exception_type",
        labelnames=["app_name", "broker", "destination", "exception_type"],
        registry=registry,
    )

DEFAULT_SIZE_BUCKETS class-attribute instance-attribute #

DEFAULT_SIZE_BUCKETS = (
    2.0**4,
    2.0**6,
    2.0**8,
    2.0**10,
    2.0**12,
    2.0**14,
    2.0**16,
    2.0**18,
    2.0**20,
    2.0**22,
    2.0**24,
    float("inf"),
)

received_messages_total instance-attribute #

received_messages_total = cast(
    "Counter",
    _get_registered_metric(received_messages_total_name),
) or Counter(
    name=received_messages_total_name,
    documentation="Count of received messages by broker and handler",
    labelnames=["app_name", "broker", "handler"],
    registry=registry,
)

received_messages_size_bytes instance-attribute #

received_messages_size_bytes = cast(
    "Histogram",
    _get_registered_metric(
        received_messages_size_bytes_name
    ),
) or Histogram(
    name=received_messages_size_bytes_name,
    documentation="Histogram of received messages size in bytes by broker and handler",
    labelnames=["app_name", "broker", "handler"],
    registry=registry,
    buckets=received_messages_size_buckets
    or DEFAULT_SIZE_BUCKETS,
)

received_messages_in_process instance-attribute #

received_messages_in_process = cast(
    "Gauge",
    _get_registered_metric(
        received_messages_in_process_name
    ),
) or Gauge(
    name=received_messages_in_process_name,
    documentation="Gauge of received messages in process by broker and handler",
    labelnames=["app_name", "broker", "handler"],
    registry=registry,
)

received_processed_messages_total instance-attribute #

received_processed_messages_total = cast(
    "Counter",
    _get_registered_metric(
        received_processed_messages_total_name
    ),
) or Counter(
    name=received_processed_messages_total_name,
    documentation="Count of received processed messages by broker, handler and status",
    labelnames=["app_name", "broker", "handler", "status"],
    registry=registry,
)

received_processed_messages_duration_seconds instance-attribute #

received_processed_messages_duration_seconds = cast(
    "Histogram",
    _get_registered_metric(
        received_processed_messages_duration_seconds_name
    ),
) or Histogram(
    name=received_processed_messages_duration_seconds_name,
    documentation="Histogram of received processed messages duration in seconds by broker and handler",
    labelnames=["app_name", "broker", "handler"],
    registry=registry,
)

received_processed_messages_exceptions_total instance-attribute #

received_processed_messages_exceptions_total = cast(
    "Counter",
    _get_registered_metric(
        received_processed_messages_exceptions_total_name
    ),
) or Counter(
    name=received_processed_messages_exceptions_total_name,
    documentation="Count of received processed messages exceptions by broker, handler and exception_type",
    labelnames=[
        "app_name",
        "broker",
        "handler",
        "exception_type",
    ],
    registry=registry,
)

published_messages_total instance-attribute #

published_messages_total = cast(
    "Counter",
    _get_registered_metric(published_messages_total_name),
) or Counter(
    name=published_messages_total_name,
    documentation="Count of published messages by destination and status",
    labelnames=[
        "app_name",
        "broker",
        "destination",
        "status",
    ],
    registry=registry,
)

published_messages_duration_seconds instance-attribute #

published_messages_duration_seconds = cast(
    "Histogram",
    _get_registered_metric(
        published_messages_duration_seconds_name
    ),
) or Histogram(
    name=published_messages_duration_seconds_name,
    documentation="Histogram of published messages duration in seconds by broker and destination",
    labelnames=["app_name", "broker", "destination"],
    registry=registry,
)

published_messages_exceptions_total instance-attribute #

published_messages_exceptions_total = cast(
    "Counter",
    _get_registered_metric(
        published_messages_exceptions_total_name
    ),
) or Counter(
    name=published_messages_exceptions_total_name,
    documentation="Count of published messages exceptions by broker, destination and exception_type",
    labelnames=[
        "app_name",
        "broker",
        "destination",
        "exception_type",
    ],
    registry=registry,
)