Configuration¶
All configuration is composed from frozen, immutable dataclasses.
RabbitConfig (top-level)¶
RabbitConfig
dataclass
¶
Top-level config — composes focused config objects.
Frozen + slots (per project convention). Brokers that need to apply
per-route overrides (e.g. prefetch) hold a private dataclasses.replace
copy rather than mutating the caller's object.
Only connection/broker defaults. Throughput/batching configs are accepted by their respective components directly.
Source code in src/rabbitkit/core/config.py
ConnectionConfig¶
ConnectionConfig
dataclass
¶
Core connection parameters.
Source code in src/rabbitkit/core/config.py
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 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 | |
Attributes¶
url: str
property
¶
Build AMQP URL from config fields.
Username, password and vhost are URL-encoded so credentials containing
reserved characters (@:/# etc.) cannot corrupt the host/port parse
(mirrors the encoding done in async_/connection.py).
SECURITY (L2): this embeds the plaintext password (user:pass@host)
— never log or repr it. Use :attr:safe_url for logging/display.
safe_url: str
property
¶
Like :attr:url but with the password masked (L2) — safe to log.
Methods:¶
resolve_credentials() -> tuple[str, str]
¶
Return (username, password) — from credentials_provider if
set (M13: called at each (re)connect so rotated secrets are picked up
without a redeploy), else the static username/password fields.
Source code in src/rabbitkit/core/config.py
cluster_endpoints() -> list[tuple[str, int]]
¶
Primary host:port plus any failover nodes, in connect-attempt order.
Source code in src/rabbitkit/core/config.py
from_url(url: str) -> ConnectionConfig
classmethod
¶
Parse an AMQP URL into a ConnectionConfig.
Supports: amqp://user:pass@host:port/vhost?heartbeat=30&connection_timeout=10
Source code in src/rabbitkit/core/config.py
ConsumerConfig¶
ConsumerConfig
dataclass
¶
Consumer behavior tuning.
Attributes:
| Name | Type | Description |
|---|---|---|
prefetch_count |
int
|
AMQP QoS per consumer channel. On the async broker
this is also the handler concurrency per queue unless a
|
graceful_timeout |
float
|
shutdown drain budget in seconds ( |
reject_transient_on_redelivery |
bool
|
bound the transient-failure loop on
routes without retry (default True). A transient error
( |
manual_settle_on_error |
bool
|
under |
processing_timeout |
float | None
|
per-delivery handler deadline in seconds
( |
max_body_bytes |
int | None
|
raw-body cap for deliveries, in bytes ( |
Source code in src/rabbitkit/core/config.py
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 | |
PublisherConfig¶
PublisherConfig
dataclass
¶
Publisher behavior tuning.
Source code in src/rabbitkit/core/config.py
PoolConfig¶
PoolConfig
dataclass
¶
Connection and channel pool sizing.
channel_pool_size (publisher channel pool) and channel_acquire_timeout
are active. publisher_connections / consumer_connections are
reserved and ignored (setting them changes nothing): the transport
currently uses one connection per role, because multiple connections
sharing a single event loop showed no throughput benefit in benchmarks
(the loop is the bound). Scale throughput by running more processes/pods,
not more connections per process.
Attributes:
| Name | Type | Description |
|---|---|---|
channel_pool_size |
int
|
Maximum publisher channels per pool (>= 1). On the async broker every confirmed publish holds one channel until its confirm arrives, so this is also the in-flight confirmed-publish cap. |
channel_acquire_timeout |
float
|
Admission bound in seconds (> 0). A publish
that cannot get a channel (pool exhausted) within it returns
|
prewarm_channels |
bool
|
Pre-create all pool channels on |
Source code in src/rabbitkit/core/config.py
RetryConfig¶
RetryConfig
dataclass
¶
Retry with delay queues configuration.
Accepted by RetryMiddleware. Can be set as broker default (RabbitConfig.retry) or per-route override (route.retry_override).
delays must have at least max_retries entries. Extra retries
beyond the length of delays would silently reuse the last delay,
which is almost always a misconfiguration.
Durability knobs (plan §5.1) — all default to the legacy topology so an upgrade never re-declares an existing queue with different arguments:
delay_queue_type:"classic"(legacy default),"quorum", or"inherit"(match the source queue). Quorum delay queues make the retry chain replicated end-to-end for critical work; note that a quorum SOURCE does not by itself secure a classic delay queue.dlq_queue_type:"inherit"(legacy default — quorum when the source is quorum),"classic", or"quorum".error_detail: what goes intox-rabbitkit-error-message—"sanitized"(default: redacted + capped),"omit", or"raw"(legacy). See :mod:rabbitkit.core.sanitizer.handoff: bounded behavior when the retry publish itself fails.
Retry policy:
max_retries/delays— the ladder (delays in whole seconds, one fixed-TTL delay queue per tier). :meth:exponentialbuildsdelaysfrominitial_delay/multiplier/max_delay.max_retry_age(seconds,None= unbounded) — a transient failure more than this long after the message's FIRST failure (x-rabbitkit-first-failed-at) is terminal (categoryretry-age-exceeded) even with retries left.terminal_action— :class:~rabbitkit.core.types.TerminalAction:"dead_letter"(default) publishes a confirmed, metadata-stamped copy to<queue>.dlqbefore acking;"reject"is the legacy broker dead-letter path.- Jitter:
jitter_factoronly takes effect withjitter_mode="sharded". Per-message TTL jitter is deliberately not offered: a classic queue expires messages only at its head, so a message with a long TTL blocks every shorter one behind it.
Trust model: the retry count, first-failure timestamp and original-*
headers travel on the message and are client-controlled. rabbitkit
never lowers them on its own republish, takes the larger of the header
count and the broker's x-death history for this queue's delay
tiers, and clamps to max_retries; a producer that strips every
header restarts the budget — max_retry_age and a quorum source's
x-delivery-limit bound that case. A producer that sets the header
HIGH skips retries; trust_retry_header=False closes that by counting
only the x-death entries the broker adds when a copy expires out of
a <queue>.retry.<n> delay queue (the header is then informational).
Leave it True for TestBroker suites that simulate later attempts
by setting the header, since the in-memory broker writes no x-death.
Source code in src/rabbitkit/core/config.py
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 | |
Methods:¶
exponential(*, max_retries: int = 4, initial_delay: float = 5.0, multiplier: float = 2.0, max_delay: float = 600.0, **kwargs: Any) -> RetryConfig
classmethod
¶
Build a RetryConfig whose delays follow a capped exponential.
delays[i] = min(max_delay, initial_delay * multiplier ** i),
rounded to whole seconds (minimum 1) because each tier is a delay
queue with a fixed x-message-ttl. Every other field is passed
through kwargs.
Source code in src/rabbitkit/core/config.py
RetryHandoffConfig¶
RetryHandoffConfig
dataclass
¶
Bounded behavior when the RETRY PUBLISH itself fails (plan §5.2).
A handler failure and a failure to hand the message to its delay queue
are different events. When the delay-queue publish is returned,
nacked, times out, or the connection drops, RetryMiddleware never
acks the source (it nack-requeues it) — but without a brake that is a
hot redelivery loop against a broken destination. This config bounds
that loop:
backoff_initial/backoff_max/jittershape a capped exponential delay applied per consecutive handoff failure (async handlersawait asyncio.sleep; the sync path never sleeps on the I/O thread — it reports the backoff through theon_handoff_failurehook so the broker/worker can pause admission instead).max_consecutive_failuresandrecovery_deadlinedefine when the tracker reportsexhaustedso an owner can stop the consumer and let the broker redeliver instead of spinning.
Source code in src/rabbitkit/core/config.py
BulkPublishOptions¶
BulkPublishOptions
dataclass
¶
Bounds for one publish_many / iter_publish operation.
Every bound is explicit; none is a tuning recommendation. The defaults are conservative starting points — measure before changing them.
Attributes:
| Name | Type | Description |
|---|---|---|
max_in_flight |
int
|
Maximum envelopes submitted to the transport but not
yet settled (async broker). Without an |
max_buffer_bytes |
int
|
Maximum sum of in-flight body bytes. An envelope
larger than this can never be admitted and is reported
|
admission_timeout |
float
|
Seconds to wait for an in-flight/byte slot before
reporting an item |
confirm_timeout |
float | None
|
Per-item confirm wait override (async broker). A
timeout reports |
overall_timeout |
float | None
|
Whole-operation deadline. On expiry admission stops;
never-submitted items are |
drain_grace |
float
|
Seconds to wait for in-flight items after the overall
deadline before classifying them |
max_items |
int
|
Upper bound on |
Source code in src/rabbitkit/core/bulk.py
CompressionConfig¶
CompressionConfig
dataclass
¶
Compression configuration.
Accepted by CompressionMiddleware.
Source code in src/rabbitkit/core/config.py
SocketConfig¶
SocketConfig
dataclass
¶
Low-level TCP tuning.
Applied best-effort — not all options are universally guaranteed depending on OS and backend internals.
Sync-only. SyncBroker applies these via pika's tcp_options;
AsyncBroker emits a RuntimeWarning and ignores a non-default
value — aio-pika/aiormq exposes no socket-tuning hooks, and per-socket
tuning would be silently lost on every automatic reconnect. Tune the
async side via ConnectionConfig (heartbeat, timeouts) or at the
OS level.
Source code in src/rabbitkit/core/config.py
SSLConfig¶
SSLConfig
dataclass
¶
TLS/SSL configuration.
Source code in src/rabbitkit/core/config.py
SecurityConfig¶
SecurityConfig
dataclass
¶
SASL + authentication configuration.
Only mechanism="PLAIN" is implemented (username/password). EXTERNAL
(x509 client-cert auth) is not wired into either transport, so accepting
it silently would be "config that lies" — it is rejected at construction
(M2). mTLS is still supported for transport encryption via
SSLConfig(certfile=..., keyfile=...); it just isn't an auth mechanism.
Source code in src/rabbitkit/core/config.py
WorkerConfig¶
WorkerConfig
dataclass
¶
Consumer concurrency configuration.
Accepted by broker.start(), NOT part of RabbitConfig. Added in 0.2.0.
Concurrency semantics, per queue:
worker_count >= 2: a worker pool of that size runs the handlers; prefetch isworker_count * prefetch_per_workerwhenprefetch_per_workeris set.worker_count == 1(the default) creates NO pool, andprefetch_per_workeris ignored. On the async broker every delivery then runs as its own task, so up toprefetch_counthandlers of one queue run concurrently --worker_count=1does not serialize async handlers. Useprefetch_count=1(or a lock in the handler) for one-at-a-time processing. On the sync broker handlers run inline on the I/O thread, one at a time (withConsumerConfig.processing_timeoutset: one at a time on one dedicated handler thread, so the I/O thread can enforce the deadline).
stop_timeout (H12): a FALLBACK drain deadline for the worker pool's
stop() — consulted only when no explicit timeout is passed. On the
standard shutdown path (broker.stop()) the pool drain budget is
ConsumerConfig.graceful_timeout, NOT this field — tune THAT (and
keep terminationGracePeriodSeconds a few seconds above it) for
Kubernetes; setting only stop_timeout there has no effect
(architect review M2 — the old text here said the opposite).
stop_timeout matters when you drive a worker pool directly. A
handler still running past this deadline is abandoned, not killed:
the sync pool's daemon thread keeps running in the background (it is
never forcibly stopped — Python cannot interrupt an arbitrary thread),
and the async pool cancels the task (which does not guarantee the
handler reaches its own ack/nack — CancelledError is a
BaseException and is not caught by the pipeline's exception
handling). Either way the abandoned delivery is logged by delivery
tag/message id, and — for the async pool — nacked for redelivery
immediately rather than relying on the implicit requeue that happens
when the connection eventually closes. Because the original handler may
still complete its side effects after abandonment, handlers must be
idempotent under at-least-once delivery regardless of stop_timeout.
Source code in src/rabbitkit/core/config.py
1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 | |
BackpressureConfig¶
BackpressureConfig
dataclass
¶
Backpressure configuration. Active.
Source code in src/rabbitkit/core/config.py
BatchPublishConfig¶
BatchPublishConfig
dataclass
¶
Batch publish configuration. Active.
Source code in src/rabbitkit/core/config.py
BatchAckConfig¶
BatchAckConfig
dataclass
¶
Batch ack configuration. Active.
mode (plan §4.1):
"individual"(default, SAFE) — every buffered tag is acked with its ownmultiple=Falseframe. Out-of-order completion can never settle a delivery that was not submitted."cumulative"— legacyack(max_tag, multiple=True). RabbitMQ settles EVERY outstanding tag up tomax_tagon the channel, so a still-running sibling delivery gets acked early unless this helper is the only thing that ever acks on that channel AND completions are submitted in tag order. Requiresordered_exclusive_owner=Trueas an explicit attestation; otherwise construction fails. For safe coalescing with arbitrary completion order use :class:rabbitkit.highload.batch.CoalescingAckerinstead.
Source code in src/rabbitkit/core/config.py
DeduplicationConfig¶
DeduplicationConfig
dataclass
¶
Deduplication configuration. Active.
mark_policy accepts a :class:~rabbitkit.core.types.DeduplicationMarkPolicy
member or its string value:
"on_success"(default) — crash-safe; concurrent duplicates may both run."on_start"— blocks concurrent duplicates but a crash mid-handler LOSES the message. Advanced/dangerous."claim"— in-flight claim (processing_timeout) before the handler, "completed" (ttl) after success. Blocks concurrent duplicates and survives crashes;processing_timeoutmust comfortably exceed the worst-case handler duration or a duplicate can start while the original is still running.
Source code in src/rabbitkit/core/config.py
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 | |
HealthCheckConfig¶
HealthCheckConfig
dataclass
¶
MetricsConfig¶
MetricsConfig
dataclass
¶
Metrics naming configuration.
namespace sets the metric name prefix (default "rabbitkit").
Individual name fields override the derived default when non-empty.
Source code in src/rabbitkit/core/config.py
876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 | |
Attributes¶
settlement_outcome_unknown_total: str
property
¶
Incremented (labeled by queue) when a handler succeeded but its
ack raised: the ack may or may not have reached the broker, so the
message may be redelivered and processed again.
dedup_fallback_total: str
property
¶
M9: incremented every time DeduplicationMiddleware falls back to
processing a message despite a Redis error (idempotency is not
enforced for that message) — see
DeduplicationConfig.fallback_on_redis_error.
rate_limit_dropped_total: str
property
¶
L5: incremented every time RateLimitMiddleware settles a message
without calling the handler — nack/drop policy, or the "wait" policy's
deadline elapsing with no token acquired. Labeled by reason
(nack/drop/wait_deadline_exceeded).
messages_redelivered_total: str
property
¶
Incremented (labeled by queue) for every consumed message the
broker flagged redelivered=True — the broker-redelivery-rate
signal. A sustained rise means handlers are dying/timing out before
acking (crash loops, heartbeat kills, connection churn), which the
success/error consume counters alone can't distinguish from ordinary
traffic.
reconnects_total: str
property
¶
Incremented on every transport re-connection after the first successful connect — the connection-churn signal. Reconnects were previously logged but never counted, so a flapping broker/network was invisible to metrics-based alerting.
channels_opened_total: str
property
¶
Incremented every time either transport actually creates a new
low-level channel — the publisher/topology channel, a per-queue
consumer channel, an async channel-pool slot, or a dedicated
fast/mandatory/reply-to channel. A steady climb with no matching
traffic growth signals a channel leak (a "cache" of channels that
never shrinks) — previously invisible, since only the connection
churn (reconnects_total) was counted.
channel_rebuilds_total: str
property
¶
Incremented when a channel is created to REPLACE one that died —
a reconnect-driven per-queue consumer channel recreate (sync), a
406-drift publisher channel reopen (sync), or a mandatory/fast
channel recycle after a timeout or closed-channel discovery (async).
Unlike channels_opened_total (every creation, including ordinary
pool growth and first-ever opens), this isolates the subset that
indicates something upstream actually failed.
bulk_publish_items_total: str
property
¶
Incremented per publish_many/iter_publish item, labeled by
status (confirmed/unroutable/nacked/invalid/not_sent/unknown)
and reason (bounded reason code). A sustained unknown rate is
the "reconcile me" signal.
bulk_publish_batch_size: str
property
¶
Histogram of publish_many input sizes (items).
bulk_publish_admission_wait_seconds: str
property
¶
Histogram of time an item waited for an in-flight/byte slot.
settlement_items_total: str
property
¶
Incremented per ack_many/nack_many item, labeled by
action and status (dispatched/already_settled/duplicate/
invalid/stale/not_attempted/failed).
settlement_pending: str
property
¶
Gauge: deliveries registered with a SettlementCoordinator but
not yet settled. Unbounded growth means a stuck handler is holding
the ack frontier back.
settlement_ack_ready: str
property
¶
Gauge: deliveries approved for an ack but not yet emitted.
settlement_frontier: str
property
¶
Gauge: highest delivery tag a cumulative ack could currently cover.
Flat while settlement_ack_ready climbs = a straggler is blocking.
settlement_gap_count: str
property
¶
Gauge: blocking deliveries sitting below an ack-ready one — the stragglers stranding otherwise-settleable work.
settlement_oldest_pending_age_seconds: str
property
¶
Gauge: age of the oldest unsettled delivery. The clearest "a handler is stuck" signal; alert on it.
settlement_coalescing_ratio: str
property
¶
Gauge: deliveries settled per AMQP frame sent. 1.0 = no coalescing happening (often because the frontier is blocked).
settlement_coalesced_total: str
property
¶
Tags settled through a cumulative (multiple=True) ack by a
CoalescingAcker — the coalescing-ratio numerator.
retry_handoff_failures_total: str
property
¶
Incremented when the RETRY PUBLISH (delay-queue handoff) fails —
returned, nacked, timed out, or errored — labeled by queue.
Distinct from messages_retried_total (handler attempts).
retry_handoff_paused: str
property
¶
Gauge: 1 while a route's retry-handoff tracker is in backoff/
exhausted state, labeled by queue.
queue_messages_ready: str
property
¶
Messages ready for delivery (backlog depth).
queue_messages_unacked: str
property
¶
Messages delivered but not yet acked (in-flight at consumers).
queue_messages_total: str
property
¶
Total messages in the queue (ready + unacked).
queue_consumers: str
property
¶
Number of consumers attached to the queue (0 = nothing draining).
queue_quorum_members: str
property
¶
Quorum queues only: Raft members the queue is configured with.
queue_quorum_online: str
property
¶
Quorum queues only: members currently online. The queue is available while more than half of its members are online.
messages_failed_total: str
property
¶
Handler failures labeled by queue and category (one of the
six ErrorCategory values).
publish_in_flight: str
property
¶
Gauge: async publishes between admission and their outcome (sampled).
publish_in_flight_bytes: str
property
¶
Gauge: body bytes held by the max_in_flight_bytes budget (sampled;
only emitted when that budget is configured).
publish_channels_in_use: str
property
¶
Gauge: publisher channels checked out of the async pools (sampled).
publish_routing_failures_total: str
property
¶
Publishes the broker could not route, labeled by exchange and
reason (returned / exchange_not_found). Counts every
transport publish, including retry and dead-letter copies.
connection_up: str
property
¶
Gauge: 1 while the connection of role is up, else 0.
connections_active: str
property
¶
Gauge: connections currently up.
channels_active: str
property
¶
Gauge: channels the transport currently holds open (sampled).
connection_failures_total: str
property
¶
Connection failures labeled by role and a bounded reason:
a live connection lost, a failed reconnect attempt, or a terminal
give-up (its TerminalConnectionError.reason).
reconnect_attempts_total: str
property
¶
FAILED reconnect attempts labeled by role. A successful
reconnect increments reconnects_total instead.
connection_blocked: str
property
¶
Gauge: 1 while RabbitMQ has the connection blocked
(connection.blocked: a memory or disk alarm), else 0.
connection_blocked_reason: str
property
¶
Gauge per bounded reason (disk / memory / other): 1
while the connection is blocked and the broker's connection.blocked
reason names that alarm, else 0. The client-side form of the broker's
disk and memory alarms; needs no broker plugin.
consumer_cancelled_total: str
property
¶
Consumers the BROKER cancelled (basic.cancel), labeled by queue.
route_consuming: str
property
¶
Gauge per queue: 1 while the route's consumer is subscribed, 0
while it is not (stopped, or cancelled by the broker).
RetryDisabled / RETRY_DISABLED¶
RetryDisabled
¶
Typed singleton — explicitly disables retry on a route.
Distinct from RetryConfig(max_retries=0) which means 'retry-owned terminal semantics with zero retry attempts (immediate DLQ on any classified error).'