ng\jdt%SrSSKJr SSKJrJrJrJr SSKJrJ r J r J r J r J r SSKJrJr SSKJr SSKJr SSKJrJrJr \(aSS KJr SS KJr SS KJr S q\\\ S 'Sr!Sr"\"S/SSS9SXS\#S\$S\\#S\\%S\\#S\\&S\\'S\\%S\\%SS 4Sjj5r(SSS\$SS 4S jr)SYS!\#S"\ S#\%SS 4S$jjr*\"S%S&S'9SZS(j5r+\"S%S&S'9S)\SSS 4S*j5r,S!\#SS 4S+jr-S!\#S\$SS 4S,jr.S[S-\\S.\\&SS 4S/jjr/S0\#S1\#S2\'SS 4S3jr0S!\#SS 4S4jr1S\S\\#S\\%S5\\#S6\\%S.\\&S\\%S7\'SS 4S8jjr2S[S9\ S:\\#S;\\'SS 4S<jjr3\"S=/S>SS9S]S?\$S@\\#SA\\#S=\\#SS 4 SBjj5r4\"S=/S>SS9S[SA\\#S=\\#SS 4SCjj5r5S\#S\%S5\#S6\%S1\#SS 4 SDjr6S^SE\\ 4SFjjr7SZSGjr8S^SH\S!\\#SS 4SIjjr9S^SJ\%SK\\ SS 4SLjjr:SM\%SS 4SNjr;SOSPSQSPSK\ SS 4SRjrSZSVjr?S\'4SWjr@g )_aT Simple, clean API for recording observability metrics. This module provides a straightforward interface for Redis core code to record metrics without needing to know about OpenTelemetry internals. Usage in Redis core code: from redis.observability.recorder import record_operation_duration start_time = time.monotonic() # ... execute Redis command ... record_operation_duration( command_name='SET', duration_seconds=time.monotonic() - start_time, server_address='localhost', server_port=6379, db_namespace='0', error=None ) )datetime) TYPE_CHECKINGCallableListOptional)AttributeBuilderConnectionState CSCReason CSCResultGeoFailoverReasonPubSubDirection) CloseReasonRedisMetricsCollector)get_observability_instance)!get_observables_registry_instance)deprecated_argsdeprecated_function str_if_bytes)ConnectionPoolInterface) SyncDatabase) OTelConfigN_metrics_collector csc_itemsconnection_count batch_sizezXThe batch_size argument is no longer used and will be removed in the next major version.z7.2.1) args_to_warnreasonversion command_nameduration_secondsserver_address server_port db_namespaceerror is_blockingretry_attemptsreturnc [c[5q[cg[RUUUUUUUUUUS9 g![a gf=f)aF Record a Redis command execution duration. This is a simple, clean API that Redis core code can call directly. If observability is not enabled, this returns immediately with zero overhead. Args: command_name: Redis command name (e.g., 'GET', 'SET') duration_seconds: Command execution time in seconds server_address: Redis server address server_port: Redis server port db_namespace: Redis database index error: Exception if command failed, None if successful is_blocking: Whether the operation is a blocking command batch_size: Number of commands in batch (for pipelines/transactions) retry_attempts: Number of retry attempts made Example: >>> start = time.monotonic() >>> # ... execute command ... >>> record_operation_duration('SET', time.monotonic() - start, 'localhost', 6379, '0') N) rr r!r"r# error_typenetwork_peer_addressnetwork_peer_portr%r&)r_get_or_create_collectorrecord_operation_duration Exception) rr r!r"r#r$r%rr&s W/home/edenadmin/noVNC/venv/lib/python3.13/site-packages/redis/observability/recorder.pyr-r-2sgR!57  %  44%-)#%!/)#) 5     s8 AAconnection_poolrc[c[5q[cg[RUUS9 g![a gf=f)aO Record connection creation time. Args: connection_pool: Connection pool implementation duration_seconds: Time taken to create connection in seconds Example: >>> start = time.monotonic() >>> # ... create connection ... >>> record_connection_create_time('ConnectionPool', time.monotonic() - start) Nr0r )rr,record_connection_create_timer.r2s r/r3r3tsN&!57  %  88+- 9     0 == pool_nameconnection_statecounterc[c[5q[cg[RUUUS9 g![a gf=f)a< Record a connection count change for a single state. Args: pool_name: Connection pool identifier connection_state: State to update (IDLE or USED) counter: Number to add (positive) or subtract (negative) Example: # New connection created (goes to IDLE first) >>> record_connection_count('pool_abc123', ConnectionState.IDLE, 1) # Acquire from pool (transition) >>> record_connection_count('pool_abc123', ConnectionState.IDLE, -1) >>> record_connection_count('pool_abc123', ConnectionState.USED, 1) # Release to pool (transition) >>> record_connection_count('pool_abc123', ConnectionState.USED, -1) >>> record_connection_count('pool_abc123', ConnectionState.IDLE, 1) # Pool disconnect 5 idle connections >>> record_connection_count('pool_abc123', ConnectionState.IDLE, -5) Nr5r6r7)rr,record_connection_countr.r9s r/r:r:sQ<!57  %  22- 3    1 >>z{Connection count is now tracked via record_connection_count(). This functionality will be removed in the next major versionz7.4.0)rrcf[5nUcgSnURUS9 g![a gf=f)z: Initialize observable gauge for connection count metric. Nc[5nUR[5n/nUHnURU"55 M U$N)rgetCONNECTION_COUNT_REGISTRY_KEYextend__observables_registry callbacks observationscallbacks r/observable_callback2init_connection_count..observable_callbacksC@B(,,-JK  !H    +"rG)r,init_connection_countr.) collectorrHs r/rLrLsI)*I ''( (     s # 00connection_poolsc^^[5nUcgSSKJm UU4Sjn[5nUR [ U5 g![ a gf=f)z? Add connection pools to connection count observable registry. Nr Observationc z>/nTH1nUR5Hup#URT"X#S95 M M3 U$)N attributes)get_connection_countappend)rFr0countrTrQrNs r/connection_count_callbackBregister_pools_connection_count..connection_count_callbacksDL#3)8)M)M)O%E '' E(QR*P$4 rJ)r,opentelemetry.metricsrQrregisterr@r.)rNrMrXrDrQs` @r/register_pools_connection_countr\sW)*I 5  AB%% )+D     s-A A  A c~[c[5q[cg[RUS9 g![a gf=f)z Record a connection timeout event. Args: pool_name: Connection pool identifier Example: >>> record_connection_timeout('ConnectionPool') Nr5)rr,record_connection_timeoutr.r^s r/r_r_K!57  %  44 5     / <<c[c[5q[cg[RUUS9 g![a gf=f)aP Record time taken to obtain a connection from the pool. Args: pool_name: Connection pool identifier duration_seconds: Wait time in seconds Example: >>> start = time.monotonic() >>> # ... wait for connection from pool ... >>> record_connection_wait_time('ConnectionPool', time.monotonic() - start) Nr5r )rr,record_connection_wait_timer.rcs r/rdrdsN$!57  %  66- 7     r4 close_reasonr)c[c[5q[cg[RUUS9 g![a gf=f)a Record a connection closed event. Args: close_reason: Reason for closing (e.g. 'error', 'application_close') error_type: Error type if closed due to error Example: >>> record_connection_closed('ConnectionPool', 'idle_timeout') Nrer))rr,record_connection_closedr.rgs r/rhrh>sN !57  %  33%! 4     r4connection_namemaint_notificationrelaxedc[c[5q[cg[RUUUS9 g![a gf=f)a? Record a connection timeout relaxation event. Args: connection_name: Connection identifier maint_notification: Maintenance notification type relaxed: True to count up (relaxed), False to count down (unrelaxed) Example: >>> record_connection_relaxed_timeout('localhost:6379_a1b2c3d4', 'MOVING', True) Nrirjrk)rr,!record_connection_relaxed_timeoutr.rms r/rnrn\sQ$!57  %  <<+1 =    r;c~[c[5q[cg[RUS9 g![a gf=f)z Record a connection handoff event (e.g., after MOVING notification). Args: pool_name: Connection pool identifier Example: >>> record_connection_handoff('ConnectionPool') Nr^)rr,record_connection_handoffr.r^s r/rprp}r`rar*r+ is_internalc [c[5q[cg[RUUUUUUUS9 g![a gf=f)a Record error count. Args: server_address: Server address server_port: Server port network_peer_address: Network peer address network_peer_port: Network peer port error_type: Error type (Exception) retry_attempts: Retry attempts is_internal: Whether the error is internal (e.g., timeout, network error) Example: >>> record_error_count('localhost', 6379, 'localhost', 6379, ConnectionError(), 3) Nr!r"r*r+r)r&rq)rr,record_error_countr.rss r/rtrts]4!57  %   --)#!5/!)# .     s5 AA directionchannelshardedc[c[5q[cgUnUb [5nUbUR(aSn[R UUUS9 g![ a gf=f)a Record a PubSub message (published or received). Args: direction: Message direction ('publish' or 'receive') channel: Pub/Sub channel name sharded: True if sharded Pub/Sub channel Example: >>> record_pubsub_message(PubSubDirection.PUBLISH, 'channel', False) N)rurvrw)rr, _get_confighide_pubsub_channel_namesrecord_pubsub_messager.)rurvrweffective_channelconfigs r/r{r{sz$!57  %    &"B"B $  00% 1    A A#"A# consumer_namez[The consumer_name argument is no longer used and will be removed in the next major version. lag_seconds stream_nameconsumer_groupc[c[5q[cgUnUb [5nUbUR(aSn[R UUUS9 g![ a gf=f)z Record the lag of a streaming message. Args: lag_seconds: Lag in seconds stream_name: Stream name consumer_group: Consumer group name consumer_name: Consumer name Nrrr)rr,ryhide_stream_namesrecord_streaming_lagr.)rrrreffective_stream_namer}s r/rrsz,!57  % (  &":":$( ! //#-) 0    r~c >[c[5q[cgU(dg[R"5R 5n[ 5nUSL=(a UR n[U[5(aUR5H}upgU(aSO [U5nUH^n U HUn U up[U 5n U RS5up[SU[U 5S- - 5n[RUUUS9 MW M` M gUHzn[US5nU(aSOUnUSHUn U up[U 5n U RS5up[SU[U 5S- - 5n[RUUUS9 MW M| g![a gf=f)a5 Record streaming lag from XREAD/XREADGROUP response. Parses the response and calculates lag for each message based on message ID timestamp. Args: response: Response from XREAD/XREADGROUP command consumer_group: Consumer group name (for XREADGROUP) consumer_name: Consumer name (for XREADGROUP) N-girr)rr,rnow timestampryr isinstancedictitemsrsplitmaxintrr.)responserrrr}rrstream_messagesrmessagesmessage message_id_rr stream_entrys r/"record_streaming_lag_from_responsers.!57  %  - lln&&("$.K63K3K h % %080@, -D< 3L&!0H#+(/ %1*%= '1'7'7'< &)#sS^d5J/J&K *??(3(=+9@$,!0 1A&!) *<?; 0A{%+AG$+MJ!-j!9J#-#3#3C#8LI"%c3Y$1F+F"GK&;;$/$9'5< / !)    sC*FBF FFc[c[5q[cg[RUUUUUS9 g![a gf=f)a Record a maintenance notification count. Args: server_address: Server address server_port: Server port network_peer_address: Network peer address network_peer_port: Network peer port maint_notification: Maintenance notification type (e.g., 'MOVING', 'MIGRATING') Example: >>> record_maint_notification_count('localhost', 6379, 'localhost', 6379, 'MOVING') Nr!r"r*r+rj)rr,record_maint_notification_countr.rs r/rrhsW,!57  %   ::)#!5/1 ;     s3 AAresultc~[c[5q[cg[RUS9 g![a gf=f)z] Record a Client Side Caching (CSC) request. Args: result: CSC result ('hit' or 'miss') Nr)rr,record_csc_requestr.rs r/rrsK!57  %  -- .     rac[c[5q[cgSn[RUS9 g![a gf=f)z3 Initialize observable gauge for CSC items metric. Nc[5nUR[5n/nUHnURU"55 M U$r>)rr?CSC_ITEMS_REGISTRY_KEYrArBs r/rH+init_csc_items..observable_callbacksC@B(,,-CD  !H    +"rJrK)rr,init_csc_itemsr.)rHs r/rrsP !57  %  ))( *     s 2 ??rGc^^^[c[5q[cgSSKJm UUU4Sjn[ 5nUR [ U5 g![a gf=f)z Adds given callback to CSC items observable registry. Args: callback: Callback function that returns the cache size pool_name: Connection pool name for observability NrrPcB>T"T"5[R"TS9S9/$)Nr^rS)rbuild_csc_attributes)rQrGr5sr/csc_items_callback7register_csc_items_callback..csc_items_callbacks(  +@@9U   rJ)rr,rZrQrr[rr.)rGr5rrDrQs`` @r/register_csc_items_callbackrsY!57  % 2  @B%%&<>PQ    s A AArWrc[c[5q[cg[RUUS9 g![a gf=f)zt Record a Client Side Caching (CSC) eviction. Args: count: Number of evictions reason: Reason for eviction NrWr)rr,record_csc_evictionr.rs r/rrsN!57  %  .. /     r4 bytes_savedc~[c[5q[cg[RUS9 g![a gf=f)zt Record the number of bytes saved by using Client Side Caching (CSC). Args: bytes_saved: Number of bytes saved Nr)rr,record_csc_network_savedr.rs r/rrsK!57  %  33# 4     ra fail_fromrfail_toc[c[5q[cg[RUUUS9 g![a gf=f)z Record a geo failover. Args: fail_from: Database failed from fail_to: Database failed to reason: Reason for the failover Nrrr)rr,record_geo_failoverr.rs r/rrsQ!57  %  .. /    r;cJ[5R5nUbURR(dgUR 5R [ R[ R5n[ XR5$![a g[a gf=f)z Get or create the global metrics collector. Returns: RedisMetricsCollector instance if observability is enabled, None otherwise N) rget_provider_managerr}enabled_telemetryget_meter_provider get_meterr METER_NAME METER_VERSION ImportErrorr.)managermeters r/r,r,9s,.CCE ?'.."B"B**,66 ! , ,.C.Q.Q %UNN;;  s6B AB B" B"!B"rct[5R5nUcgUR$![a gf=f)z Get the OTel configuration from the observability manager. Returns: OTelConfig instance if observability is enabled, None otherwise N)rrr}r.)rs r/ryryTs<,.CCE ?~~ s* * 77cSqg)zE Reset the global collector (used for testing or re-initialization). N)rrJr/reset_collectorrds rJc4[c [5q[SL$)zg Check if observability is enabled. Returns: True if metrics are being collected, False otherwise N)rr,rrJr/ is_enabledrls!57 T ))rJ)NNNNNNN)r)r'N)NN)NNNNNNT)NNNr>)A__doc__rtypingrrrrredis.observability.attributesrr r r r r redis.observability.metricsrrredis.observability.providersrredis.observability.registryr redis.utilsrrrredis.connectionrredis.multidb.databaserredis.observability.configrr__annotations__rr@strfloatrr.boolr-r3r:rLr\r_rdrhrnrprtr{rrrrrrrrrr,ryrrrrJr/rs*::KDJJJ8357;H23:$ 2 e %)!%"&!%"& $$(: : : SM: # : 3- : I  : $:  : SM:  :  : z .    H* * %* *  * Z C     4 C   45     :    6     B+/&* ;' #   <      B    8%)!%*.'+&*$(* SM* #* #3-*  } * # * SM * *  * ^""% % c]% d^%  % P!" h "&$(#' $ $ #$ SM$ C= $  $  $ N!" h %)#'G SMG C=G  G  G T$ $ $ $  $  $  $ P#' Y  0 > $! ! }!  ! L#'  Y    6    0       <(+@"A6 Xl+   *D *rJ