o iX@sdZddlZddlZddlmZddlmZmZmZm Z er6ddl m Z ddl m Z ddlmZddlmZdd lmZmZmZmZmZmZmZmZdd lmZmZdd lmZe e!Z"z dd l#m$Z$d Z%Wne&yzdZ%dZ'dZ(dZ$dZ)YnwGdddeZ*GdddZ+dS)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_NOTIFICATIONAttributeBuilder CSCReason CSCResultGeoFailoverReasonPubSubDirection get_pool_name) MetricGroup OTelConfig)deprecated_args)MeterTFc@seZdZdZdZdZdZdS) 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_FAILEDr"r"O/home/ubuntu/.local/lib/python3.10/site-packages/redis/observability/metrics.pyr/s  rc@s eZdZdZdZdZdedefddZddd d Z ddd d Z ddddZ ddddZ ddddZ ddddZddddZ dedeedeedeedeedeedeedeefdd Zdedededed!ef d"d#Zd$ed%d&ed%d'efd(d)Zd*edd fd+d,Zd*edd fd-d.Zd/edd fd0d1Zd2ed3d4edd fd5d6Zd/ed4edd fd7d8Z e!d9gd:d;d< dfd=ed4edeedeed>eed9eedeedeedeedeed?eedd fd@dAZ" dgdBee#deedd fdCdDZ$dEed!edFedd fdGdHZ%d/edd fdIdJZ& dgdKe'dLeedMeedd fdNdOZ(e!dPgdQd;d< dhdRedSeedTeedPeedd f dUdVZ) didWee*dd fdXdYZ+ didZed'ee,dd fd[d\Z-d]edd fd^d_Z.e/defd`daZ0defdbdcZ1d S)jRedisMetricsCollectorap 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.0meterconfigcCststd||_||_t|_d|_tj|jj vr| tj |jj vr)| tj |jj vr4|tj|jj vr?|tj|jj vrJ|tj|jj vrU|tj|jj vr`|tddS)NzROpenTelemetry API is not installed. Install it with: pip install opentelemetry-apiz!RedisMetricsCollector initialized)OTEL_AVAILABLE ImportErrorr%r&r attr_builderconnection_countr 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&r"r"r#__init__Qs.zRedisMetricsCollector.__init__returnNcC@|jjdddd|_|jjdddd|_|jjdd d d|_d S) 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_failoversr<r"r"r#r-v z.RedisMetricsCollector._init_resiliency_metricscCsF|jjddd|jjd|_|jjdddd|_|jjd d d d|_d S) z$Initialize basic connection metrics.z db.client.connection.create_timeszTime to create a new connectionrArBrC#explicit_bucket_boundaries_advisoryz'redis.client.connection.relaxed_timeoutz {relaxation}z@Counts up for relaxed timeout, counts down for unrelaxed timeoutr@zredis.client.connection.handoffz {handoff}zIConnections that have been handed off (e.g., after a MOVING notification)N) r%create_histogramr&buckets_connection_create_timeconnection_create_timecreate_up_down_counterconnection_relaxed_timeoutrDconnection_handoffrHr"r"r#r1s  z4RedisMetricsCollector._init_connection_basic_metricscCsF|jjdddd|_|jjddd|jjd|_|jjd d d d|_d S) 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.r@zdb.client.connection.wait_timerJz/Time to obtain an open connection from the poolrKzredis.client.connection.closed {connection}z"Total number of closed connectionsN)r%rDconnection_timeoutsrMr&buckets_connection_wait_timeconnection_wait_timeconnection_closedrHr"r"r#r3s  z7RedisMetricsCollector._init_connection_advanced_metricscC|jjddd|jjd|_dS)z0Initialize command execution metric instruments.zdb.client.operation.durationrJzCommand execution durationrKN)r%rMr&buckets_operation_durationoperation_durationrHr"r"r#r/  z+RedisMetricsCollector._init_command_metricscCs|jjdddd|_dS)z%Initialize PubSub metric instruments.zredis.client.pubsub.messagesz {message}z&Tracks published and received messagesr@N)r%rDpubsub_messagesrHr"r"r#r5s  z*RedisMetricsCollector._init_pubsub_metricscCrX)z(Initialize Streaming metric instruments.zredis.client.stream.lagrJzkEnd-to-end lag per message, showing how stale are the messages when the application starts processing them.rKN)r%rMr&"buckets_stream_processing_duration stream_lagrHr"r"r#r7r[z-RedisMetricsCollector._init_streaming_metricscCr?) z8Initialize Client Side Caching (CSC) metric instruments.zredis.client.csc.requestsz {request}z)The total number of requests to the cacher@zredis.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%rD csc_requests csc_evictionscsc_network_savedrHr"r"r#r9rIz'RedisMetricsCollector._init_csc_metricsserver_address server_portnetwork_peer_addressnetwork_peer_port error_typeretry_attempts is_internalc Cs`t|dsdS|jj||d}||jj|||d||jj||d|jjd|ddS)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) rENrcrd)rerfrh)rgri attributes)hasattrr)build_base_attributesupdatebuild_operation_attributesbuild_error_attributesrEadd) r<rcrdrerfrgrhriattrsr"r"r#record_error_counts( z(RedisMetricsCollector.record_error_countmaint_notificationcCsPt|dsdS|jj||d}||jj||d||t<|jjd|ddS)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 rFNrj)rerfrkrl)rnr)rorprqr rFrs)r<rcrdrerfrvrtr"r"r#record_maint_notification_counts z5RedisMetricsCollector.record_maint_notification_count fail_from)r rfail_toreasoncCs0t|dsdS|jj|||d}|jjd|dS)z Record geo failover Args: fail_from: Database failed from fail_to: Database failed to reason: Reason for the failover rGN)rxryrzrkrl)rnr)build_geo_failover_attributesrGrs)r<rxryrzrtr"r"r#record_geo_failover6s z)RedisMetricsCollector.record_geo_failovercallbackcC4tj|jjvr |js dS|jjddd|gd|_dS)z Initialize observable gauge for connection count metric. Args: callback: Callback function to retrieve connection count Nzdb.client.connection.countrSz!Number of connections in the poolrArBrC callbacks)rr0r&r,r*r%create_observable_gauger<r}r"r"r#init_connection_countPs  z+RedisMetricsCollector.init_connection_countcCr~)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)rr8r&r, csc_itemsr%rrr"r"r#init_csc_itemsgs  z$RedisMetricsCollector.init_csc_items pool_namecC0t|dsdS|jj|d}|jjd|ddS)zo Record a connection timeout event. Args: pool_name: Connection pool name rTNrrkrl)rnr)build_connection_attributesrTrsr<rrtr"r"r#record_connection_timeout{s z/RedisMetricsCollector.record_connection_timeoutconnection_pool)r rduration_secondscCs4t|dsdS|jjt|d}|jj||ddS)z Record time taken to create a new connection. Args: connection_pool: Connection pool implementation duration_seconds: Creation time in seconds rONrrl)rnr)rrrOrecord)r<rrrtr"r"r#record_connection_create_times z3RedisMetricsCollector.record_connection_create_timecCs0t|dsdS|jj|d}|jj||ddS)z Record time taken to obtain a connection from the pool. Args: pool_name: Connection pool name duration_seconds: Wait time in seconds rVNrrl)rnr)rrVr)r<rrrtr"r"r#record_connection_wait_time z1RedisMetricsCollector.record_connection_wait_time batch_sizezXThe batch_size argument is no longer used and will be removed in the next major version.z7.2.1) args_to_warnrzversion command_name db_namespace is_blockingc Cstt|dsdS|j|sdS|jj|||d} | |jj||| | | d| |jj|d|jj || ddS)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 rZN)rcrdr)rrerfrhrrgrl) rnr&should_track_commandr)rorprqrrrZr) r<rrrcrdrrrgrerfrhrrtr"r"r#record_operation_durations0 #  z/RedisMetricsCollector.record_operation_duration close_reasoncCsNt|dsdS|j}|r|j|t<||jj|d|jjd|ddS)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 rWNrrkrl) rnr)rvaluer rprrrWrs)r<rrgrtr"r"r#record_connection_closeds   z.RedisMetricsCollector.record_connection_closedconnection_namerelaxedcCs@t|dsdS|jj|d}||t<|jj|rdnd|ddS)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) rQN)rrkrl)rnr)rr rQrs)r<rrvrrtr"r"r#!record_connection_relaxed_timeout s z7RedisMetricsCollector.record_connection_relaxed_timeoutcCr)z Record a connection handoff event (e.g., after MOVING notification). Args: pool_name: Connection pool name rRNrrkrl)rnr)rrRrsrr"r"r#record_connection_handoff$ z/RedisMetricsCollector.record_connection_handoff directionchannelshardedcCs4t|dsdS|jj|||d}|jjd|ddS)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 r\N)rrrrkrl)rnr)build_pubsub_message_attributesr\rs)r<rrrrtr"r"r#record_pubsub_message6s z+RedisMetricsCollector.record_pubsub_message consumer_namez[The consumer_name argument is no longer used and will be removed in the next major version. lag_seconds stream_nameconsumer_groupcCs2t|dsdS|jj||d}|jj||ddS)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 r^N)rrrl)rnr)build_streaming_attributesr^r)r<rrrrrtr"r"r#record_streaming_lagPs z*RedisMetricsCollector.record_streaming_lagresultcCr)z} Record a Client Side Caching (CSC) request. Args: result: CSC result ('hit' or 'miss') r`N)rrkrl)rnr)build_csc_attributesr`rs)r<rrtr"r"r#record_csc_requestprz(RedisMetricsCollector.record_csc_requestcountcCs0t|dsdS|jj|d}|jj||ddS)z Record a Client Side Caching (CSC) eviction. Args: count: Number of evictions reason: Reason for eviction raN)rzrl)rnr)rrars)r<rrzrtr"r"r#record_csc_evictionrz)RedisMetricsCollector.record_csc_eviction bytes_savedcCs,t|dsdS|j}|jj||ddS)z Record the number of bytes saved by using Client Side Caching (CSC). Args: bytes_saved: Number of bytes saved rbNrl)rnr)rrbrs)r<rrtr"r"r#record_csc_network_saveds  z.RedisMetricsCollector.record_csc_network_savedcCstS)z Get monotonic time for duration measurements. Returns: Current monotonic time in seconds )time monotonicr"r"r"r#monotonic_timesz$RedisMetricsCollector.monotonic_timecCsd|jd|jdS)NzRedisMetricsCollector(meter=z , config=))r%r&rHr"r"r#__repr__szRedisMetricsCollector.__repr__)r>N)NNNNNNN) NNNNNNNNN)NN)NNN)N)2rrrr METER_NAME METER_VERSIONrrr=r-r1r3r/r5r7r9rstrint Exceptionboolrurwrrr|rrrrfloatrrrrrrrrrrrrrrrr staticmethodrrr"r"r"r#r$As~  %      . $            ?         r$),rloggingrenumrtypingrrrrredis.asyncio.connectionrredis.asyncio.multidb.databaserredis.connectionr redis.multidb.databaser redis.observability.attributesr r r rrrrrredis.observability.configrr redis.utilsr getLoggerrr:opentelemetry.metricsrr'r(Counter Histogram UpDownCounterrr$r"r"r"r#s4     (