Ki9_FdZddlZddlZddlmZddlmZmZmZm Z erddl m Z ddl m Z ddlmZddlmZdd lmZmZmZmZmZmZmZmZmZdd lmZmZdd lm Z m!Z!ejDe#Z$ dd l%m&Z&d Z'GddeZ,GddZ-y#e($r dZ'dZ)dZ*dZ&dZ+Y'wxYw)z OpenTelemetry metrics collector for redis-py. This module defines and manages all metric instruments according to OTel semantic conventions for database clients. N)Enum) TYPE_CHECKINGCallableOptionalUnion)ConnectionPool) AsyncDatabase)ConnectionPoolInterface) SyncDatabase) $REDIS_CLIENT_CONNECTION_CLOSE_REASON$REDIS_CLIENT_CONNECTION_NOTIFICATIONAttributeBuilderConnectionState CSCReason CSCResultGeoFailoverReasonPubSubDirection get_pool_name) MetricGroup OTelConfig)deprecated_argsdeprecated_function)MeterTFceZdZdZdZdZdZy) CloseReasona Enum representing the reason why a Redis client connection was closed. Values: APPLICATION_CLOSE: The connection was closed intentionally by the application (for example, during normal shutdown or explicit cleanup). ERROR: The connection was closed due to an unexpected error (for example, network failure or protocol error). HEALTHCHECK_FAILED: The connection was closed because a health check or liveness check for the connection failed. application_closeerrorhealthcheck_failedN)__name__ __module__ __qualname____doc__APPLICATION_CLOSEERRORHEALTHCHECK_FAILEDg/home/jay/workspace/scripts/.codegraph-venv/lib/python3.12/site-packages/redis/observability/metrics.pyrr0s , E-r'rcdeZdZdZdZdZdedefdZdOd Z dOd Z dOd Z dOd Z dOd Z dOdZdOdZ dPdeedeedeedeedeedeedeefdZdededededef dZdeddeddefdZ dQded ed!eddfd"Zed#d$%d&eddfd'Zd&eddfd(Zdeddfd)Z d*ed+d,e!ddfd-Z"ded,e!ddfd.Z#e$d/gd0d12 dRd3ed,e!deedeed4eed/eedeedeedeedeed5eeddfd6Z% dSd7ee&deeddfd8Z'd9eded:eddfd;Z(deddfd<Z) dSd=e*d>eed?eeddfd@Z+e$dAgdBd12 dTdCe!dDeedEeedAeeddf dFZ, dUdGee-ddfdHZ. dUdIedee/ddfdJZ0dKeddfdLZ1e2de!fdMZ3defdNZ4y)VRedisMetricsCollectorap Collects and records OpenTelemetry metrics for Redis operations. This class manages all metric instruments and provides methods to record various Redis operations including connection pool events, command execution, and cluster-specific operations. Args: meter: OpenTelemetry Meter instance config: OTel configuration object zredis-pyz1.0.0meterconfigc~ts td||_||_t |_t j|jjvr|jt j|jjvr|jt j|jjvr|jt j|jjvr|jt j |jjvr|j#t j$|jjvr|j't j(|jjvr|j+t,j/dy)NzROpenTelemetry API is not installed. Install it with: pip install opentelemetry-apiz!RedisMetricsCollector initialized)OTEL_AVAILABLE ImportErrorr+r,r attr_builderr RESILIENCY metric_groups_init_resiliency_metricsCOMMAND_init_command_metricsCONNECTION_BASIC_init_connection_basic_metricsCONNECTION_ADVANCED!_init_connection_advanced_metricsPUBSUB_init_pubsub_metrics STREAMING_init_streaming_metricsCSC_init_csc_metricsloggerinfo)selfr+r,s r(__init__zRedisMetricsCollector.__init__Rs<A    ,.  ! !T[[%>%> >  ) ) +   $++";"; ;  & & (  ' '4;;+D+D D  / / 1  * *dkk.G.G G  2 2 4   !:!: :  % % '  DKK$=$= =  ( ( * ??dkk77 7  " " $ 78r'returnNc|jjddd|_|jjddd|_|jjdd d |_y ) zInitialize resiliency metrics.zredis.client.errorsz{error}z`A counter of all errors (both returned to the user and handled internally in the client library)nameunit descriptionz&redis.client.maintenance.notificationsz{notification}z,Tracks server-side maintenance notificationsz"redis.client.geofailover.failoversz {geofailover}z6Total count of failovers happened using MultiDbClient.N)r+create_counter client_errorsmaintenance_notifications geo_failoversrBs r(r3z.RedisMetricsCollector._init_resiliency_metricsvsv!ZZ66&z7  *.)B)B9!F*C* & "ZZ665 P7 r'cT|jjddd|jj|_|jj ddd|_|jjd d d |_d |_ |jj d dd|_ y )z$Initialize basic connection metrics.z db.client.connection.create_timeszTime to create a new connectionrGrHrI#explicit_bucket_boundaries_advisoryz'redis.client.connection.relaxed_timeoutz {relaxation}z@Counts up for relaxed timeout, counts down for unrelaxed timeoutrFzredis.client.connection.handoffz {handoff}zIConnections that have been handed off (e.g., after a MOVING notification)Nzdb.client.connection.count {connection}z4Number of connections currently in the pool by state) r+create_histogramr,buckets_connection_create_timeconnection_create_timecreate_up_down_counterconnection_relaxed_timeoutrJconnection_handoffconnection_countconnection_count_updownrNs r(r7z4RedisMetricsCollector._init_connection_basic_metricss&*jj&A&A3904 0Z0Z 'B' #+/***K*K:Z+L+ ' #'**";";2c#<# !%(,zz'H'H-N(I( $r'c|jjddd|_|jjddd|jj |_|jjd d d |_y ) z'Initialize advanced connection metrics.zdb.client.connection.timeoutsz {timeout}zaThe number of connection timeouts that have occurred trying to obtain a connection from the pool.rFzdb.client.connection.wait_timerPz/Time to obtain an open connection from the poolrQzredis.client.connection.closedrSz"Total number of closed connectionsN)r+rJconnection_timeoutsrTr,buckets_connection_wait_timeconnection_wait_timeconnection_closedrNs r(r9z7RedisMetricsCollector._init_connection_advanced_metricss#'::#<#<0{$=$  %)JJ$?$?1I04 0X0X %@% !"&!:!:1<";" r'ct|jjddd|jj|_y)z0Initialize command execution metric instruments.zdb.client.operation.durationrPzCommand execution durationrQN)r+rTr,buckets_operation_durationoperation_durationrNs r(r5z+RedisMetricsCollector._init_command_metricss4"&**"="=/404 0V0V #># r'cJ|jjddd|_y)z%Initialize PubSub metric instruments.zredis.client.pubsub.messagesz {message}z&Tracks published and received messagesrFN)r+rJpubsub_messagesrNs r(r;z*RedisMetricsCollector._init_pubsub_metricss'#zz88/@ 9 r'ct|jjddd|jj|_y)z(Initialize Streaming metric instruments.zredis.client.stream.lagrPzkEnd-to-end lag per message, showing how stale are the messages when the application starts processing them.rQN)r+rTr,"buckets_stream_processing_duration stream_lagrNs r(r=z-RedisMetricsCollector._init_streaming_metricss6**55*F04 0^0^ 6 r'c|jjddd|_|jjddd|_|jjdd d |_y ) z8Initialize Client Side Caching (CSC) metric instruments.zredis.client.csc.requestsz {request}z)The total number of requests to the cacherFzredis.client.csc.evictionsz {eviction}z#The total number of cache evictionszredis.client.csc.network_savedByz,The total number of bytes saved by using CSCN)r+rJ csc_requests csc_evictionscsc_network_savedrNs r(r?z'RedisMetricsCollector._init_csc_metricssu JJ55,C6  "ZZ66-=7  "&!:!:1F";" r'server_address server_portnetwork_peer_addressnetwork_peer_port error_typeretry_attempts is_internalcDt|dsy|jj||}|j|jj ||||j|jj |||j jd|y)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 retry_attempts: Retry attempts is_internal: Whether the error is internal (e.g., timeout, network error) rKNrnro)rprqrs)rrrt attributes)hasattrr0build_base_attributesupdatebuild_operation_attributesbuild_error_attributesrKadd) rBrnrorprqrrrsrtattrss r(record_error_countz(RedisMetricsCollector.record_error_counts,t_- !!77)#8      8 8%9"3- 9       4 4%' 5   qU3r'maint_notificationct|dsy|jj||}|j|jj ||||t <|j jd|y)a7 Record 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 rLNrv)rprqrwrx)rzr0r{r|r}r rLr)rBrnrorprqrrs r(record_maint_notification_countz5RedisMetricsCollector.record_maint_notification_counts$t89 !!77)#8      8 8%9"3 9  7I23 &&**1*?r' fail_from)r r fail_toreasonct|dsy|jj|||}|jj d|S)z Record geo failover Args: fail_from: Database failed from fail_to: Database failed to reason: Reason for the failover rMN)rrrrwrx)rzr0build_geo_failover_attributesrMr)rBrrrrs r(record_geo_failoverz)RedisMetricsCollector.record_geo_failoverCsTt_- !!??@  !!%%aE%::r' pool_nameconnection_statecounterct|dsy|jj||}|jj ||y)a Record a connection count change for a single state. Args: pool_name: Connection pool name connection_state: State to update (IDLE or USED) counter: Number to add (positive) or subtract (negative) r[N)rrrx)rzr0build_connection_attributesr[r)rBrrrrs r(record_connection_countz-RedisMetricsCollector.record_connection_count]sNt67 !!==->  $$((U(Cr'z{Connection count is now tracked via record_connection_count(). This functionality will be removed in the next major versionz7.4.0)rversioncallbackctj|jjvry|jj ddd|g|_y)z Initialize observable gauge for connection count metric. Args: callback: Callback function to retrieve connection counts Nz%db.client.connection.count.deprecatedrSzThe number of connections that are currently in state described by the state attribute (deprecated - use db.client.connection.count instead)rGrHrI callbacks)rr6r,r2r+create_observable_gaugerZrBrs r(init_connection_countz+RedisMetricsCollector.init_connection_counttsO  ' 't{{/H/H H  !% B B8ej !C! r'ctj|jjvr |jsy|j j ddd|g|_y)z Initialize observable gauge for CSC items metric. Args: callback: Callback function to retrieve CSC items count Nzredis.client.csc.itemsz{item}z5The total number of cached responses currently storedr)rr>r,r2 csc_itemsr+rrs r(init_csc_itemsz$RedisMetricsCollector.init_csc_itemssL ??$++";"; ;DNN ;;)Oj < r'ct|dsy|jj|}|jj d|y)zo Record a connection timeout event. Args: pool_name: Connection pool name r]Nrrwrx)rzr0rr]rrBrrs r(record_connection_timeoutz/RedisMetricsCollector.record_connection_timeoutsDt23 !!== =R   $$Q5$9r'connection_pool)r rduration_secondsct|dsy|jjt|}|jj ||y)z Record time taken to create a new connection. Args: connection_pool: Connection pool implementation duration_seconds: Creation time in seconds rVNrrx)rzr0rrrVrecord)rBrrrs r(record_connection_create_timez3RedisMetricsCollector.record_connection_create_timesQt56 !!==#O4>  ##**+;*Nr'ct|dsy|jj|}|jj ||y)z Record time taken to obtain a connection from the pool. Args: pool_name: Connection pool name duration_seconds: Wait time in seconds r_Nrrx)rzr0rr_r)rBrrrs r(record_connection_wait_timez1RedisMetricsCollector.record_connection_wait_timesEt34 !!== =R !!(()9e(Lr' batch_sizezXThe batch_size argument is no longer used and will be removed in the next major version.z7.2.1) args_to_warnrr command_name db_namespace is_blockingc t|dsy|jj|sy|jj |||} | j |jj ||| | | | j |jj||jj|| y)a Record command execution duration. Args: command_name: Redis command name (e.g., 'GET', 'SET', 'MULTI') duration_seconds: Execution time in seconds server_address: Redis server address server_port: Redis server port db_namespace: Redis database index batch_size: Number of commands in batch (for pipelines/transactions) error_type: Error type if operation failed network_peer_address: Resolved peer address network_peer_port: Peer port number retry_attempts: Number of retry attempts made is_blocking: Whether the operation is a blocking command rcN)rnror)rrprqrsrrrrx) rzr,should_track_commandr0r{r|r}r~rcr) rBrrrnrorrrrrprqrsrrs r(record_operation_durationz/RedisMetricsCollector.record_operation_durationsFt12 {{// = !!77)#%8      8 8)%9"3-' 9       4 4% 5  &&'7E&Jr' close_reasonc t|dsy|jj}|r|j|t<|j |jj ||jjd|y)z 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 r`Nrrwrx) rzr0rvaluer r|r~r`r)rBrrrrs r(record_connection_closedz.RedisMetricsCollector.record_connection_closeds}t01 !!==? :F:L:LE6 7    4 4% 5  ""1"7r'connection_namerelaxedct|dsy|jj|}||t<|jj |rdnd|y)a  Record a connection timeout relaxation event. Args: connection_name: Connection name maint_notification: Maintenance notification type relaxed: True to count up (relaxed), False to count down (unrelaxed) rXNrrwrx)rzr0rr rXr)rBrrrrs r(!record_connection_relaxed_timeoutz7RedisMetricsCollector.record_connection_relaxed_timeout7sSt9: !!===X6H23 ''++AbU+Sr'ct|dsy|jj|}|jj d|y)z Record a connection handoff event (e.g., after MOVING notification). Args: pool_name: Connection pool name rYNrrwrx)rzr0rrYrrs r(record_connection_handoffz/RedisMetricsCollector.record_connection_handoffLsDt12 !!== =R ##A%#8r' directionchannelshardedct|dsy|jj|||}|jj d|y)z 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 reN)rrrrwrx)rzr0build_pubsub_message_attributesrer)rBrrrrs r(record_pubsub_messagez+RedisMetricsCollector.record_pubsub_message^sRt./ !!AAB    u 5r' consumer_namez[The consumer_name argument is no longer used and will be removed in the next major version. lag_seconds stream_nameconsumer_groupct|dsy|jj||}|jj ||y)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 rhN)rrrx)rzr0build_streaming_attributesrhr)rBrrrrrs r(record_streaming_lagz*RedisMetricsCollector.record_streaming_lagxsK*t\* !!<<#)=  {u=r'resultct|dsy|jj|}|jj d|y)z} Record a Client Side Caching (CSC) request. Args: result: CSC result ('hit' or 'miss') rkN)rrwrx)rzr0build_csc_attributesrkr)rBrrs r(record_csc_requestz(RedisMetricsCollector.record_csc_requestsCt^, !!66f6E aE2r'countct|dsy|jj|}|jj ||y)z Record a Client Side Caching (CSC) eviction. Args: count: Number of evictions reason: Reason for eviction rlN)rrx)rzr0rrlr)rBrrrs r(record_csc_evictionz)RedisMetricsCollector.record_csc_evictionsCt_- !!66f6E u7r' bytes_savedct|dsy|jj}|jj ||y)z Record the number of bytes saved by using Client Side Caching (CSC). Args: bytes_saved: Number of bytes saved rmNrx)rzr0rrmr)rBrrs r(record_csc_network_savedz.RedisMetricsCollector.record_csc_network_saveds?t01 !!668 "";5"Ar'c*tjS)z Get monotonic time for duration measurements. Returns: Current monotonic time in seconds )time monotonicr&r'r(monotonic_timez$RedisMetricsCollector.monotonic_times~~r'c<d|jd|jdS)NzRedisMetricsCollector(meter=z , config=))r+r,rNs r(__repr__zRedisMetricsCollector.__repr__s-djj\4;;-qQQr')rDN)NNNNNNN)rw) NNNNNNNNN)NN)NNN)N)5rr r!r" METER_NAME METER_VERSIONrrrCr3r7r9r5r;r=r?rstrint Exceptionboolrrrrrrrrrrrrfloatrrrrrrrrrrrrrrrr staticmethodrrr&r'r(r*r*Bs JM"9e"9Z"9H (  D *    0)-%).2+/*.(,&*,4  ,4c],4'sm ,4 $C= ,4 Y' ,4! ,4d^,4\"@"@"@" "@  "@  "@H;89;67;" ;< DD*D D  D.G       0    ( :3 :4 :OJKO O  O(MM M  M("^i)-%)&*$(*..2+/(,&*;K;K ;K! ;K c] ;K sm ;KSM;KY';K'sm;K$C=;K! ;Kd^;K ;K  ;K~/3*.8{+8Y'8  86TT T T  T*99 9*"&"& 6"6#6$ 6  64%&l&*(,'+ >>c]>! >  } >  >  >:'+3#3 3&'+88#8  8$BB B$ E  R#Rr'r*).r"loggingrenumrtypingrrrrredis.asyncio.connectionrredis.asyncio.multidb.databaser redis.connectionr redis.multidb.databaser redis.observability.attributesr r rrrrrrrredis.observability.configrr redis.utilsrr getLoggerrr@opentelemetry.metricsrr.r/Counter Histogram UpDownCounterrr*r&r'r(rs ;;7<83   ?<   8 $ +N.$.$U RU R5NGI EM s0BB B