o ie5@sndZddlmZddlmZmZmZmZmZddl Z er4ddl m Z ddl m Z ddlmZddlmZd Zd Zd Zd Zd ZdZdZdZdZdZdZdZdZdZdZ dZ!dZ"dZ#dZ$dZ%dZ&dZ'dZ(d Z)d!Z*d"Z+d#Z,d$Z-d%Z.d&Z/d'Z0Gd(d)d)eZ1Gd*d+d+eZ2Gd,d-d-eZ3Gd.d/d/eZ4Gd0d1d1eZ5Gd2d3d3Z6d4ed5d6e7fd7d8Z8d9ed:fd;d<Z9dS)=a OpenTelemetry semantic convention attributes for Redis. This module provides constants and helper functions for building OTel attributes according to the semantic conventions for database clients. Reference: https://opentelemetry.io/docs/specs/semconv/database/redis/ )Enum) TYPE_CHECKINGAnyDictOptionalUnionN)ConnectionPool) AsyncDatabase)ConnectionPoolInterface) SyncDatabasez db.systemz db.namespacezdb.operation.namezdb.response.status_codezdb.stored_procedure.namez error.typeznetwork.peer.addressznetwork.peer.portzserver.addressz server.portzdb.client.connection.pool.namezdb.client.connection.statezdb.client.connection.namezdb.client.geofailover.fail_fromzdb.client.geofailover.fail_tozdb.client.geofailover.reasonzredis.client.libraryzredis.client.connection.pubsubz$redis.client.connection.close.reasonz$redis.client.connection.notificationz%redis.client.operation.retry_attemptszredis.client.operation.blockingz%redis.client.pubsub.message.directionzredis.client.pubsub.channelzredis.client.pubsub.shardedzredis.client.errors.internalzredis.client.errors.categoryzredis.client.stream.namezredis.client.consumer_groupzredis.client.csc.resultzredis.client.csc.reasonc@eZdZdZdZdS)ConnectionStateidleusedN)__name__ __module__ __qualname__IDLEUSEDrrR/home/ubuntu/.local/lib/python3.10/site-packages/redis/observability/attributes.pyr Cr c@r )PubSubDirectionpublishreceiveN)rrrPUBLISHRECEIVErrrrrHrrc@r ) CSCResulthitmissN)rrrHITMISSrrrrrMrrc@r ) CSCReasonfull invalidationN)rrrFULL INVALIDATIONrrrrr"Rrr"c@r )GeoFailoverReason automaticmanualN)rrr AUTOMATICMANUALrrrrr'Wrr'c@s eZdZdZe   d2deedeedeedeee ffddZ e       d3d ee ee fd eed eed eed eedeedee deee ffddZe    d4deedeedeedee deee ff ddZe  d5deedee deee ffddZe  d5dedeedee deee ffdd Ze   d2d!eed"eed#eedeee ffd$d%Ze   d2deed&eed'eedeee ffd(d)Zed*e d+d,e d+d'edeee ffd-d.Ze /d6dedededefd0d1ZdS)7AttributeBuilderzY Helper class to build OTel semantic convention attributes for Redis operations. Nserver_address server_port db_namespacereturncCsLtdtdtji}|dur||t<|dur||t<|dur$t||t<|S)a* Build base attributes common to all Redis operations. Args: server_address: Redis server address (FQDN or IP) server_port: Redis server port db_namespace: Redis database index Returns: Dictionary of base attributes redisz redis-py:vN) DB_SYSTEMREDIS_CLIENT_LIBRARYr1 __version__SERVER_ADDRESS SERVER_PORTstr DB_NAMESPACE)r-r.r/attrsrrrbuild_base_attributesas  z&AttributeBuilder.build_base_attributes command_name batch_sizenetwork_peer_addressnetwork_peer_portstored_procedure_nameretry_attempts is_blockingcCsi}|durt|tr|jddd}||t<|dur ||t<|dur(||t<|dur0||t<|dur<|dkr<||t<|durD||t <|S)aw Build attributes for a Redis operation (command execution). Args: command_name: Redis command name (e.g., 'GET', 'SET', 'MULTI'), can be str or bytes batch_size: Number of commands in batch (for pipelines/transactions) network_peer_address: Resolved peer address network_peer_port: Peer port number stored_procedure_name: Lua script name or SHA1 digest retry_attempts: Number of retry attempts made is_blocking: Whether the operation is a blocking command Returns: Dictionary of operation attributes Nzutf-8replace)errorsr) isinstancebytesdecodeupperDB_OPERATION_NAMENETWORK_PEER_ADDRESSNETWORK_PEER_PORTDB_STORED_PROCEDURE_NAME%REDIS_CLIENT_OPERATION_RETRY_ATTEMPTSREDIS_CLIENT_OPERATION_BLOCKING)r;r<r=r>r?r@rAr9rrrbuild_operation_attributess   z+AttributeBuilder.build_operation_attributes pool_nameconnection_stateconnection_name is_pubsubcCsNt}|dur ||t<|dur|j|t<|dur||t<|dur%||t<|S)ay Build attributes for connection pool metrics. Args: pool_name: Unique connection pool name connection_state: Connection state ('idle' or 'used') is_pubsub: Whether this is a PubSub connection connection_name: Unique connection name Returns: Dictionary of connection pool attributes N)r,r:DB_CLIENT_CONNECTION_POOL_NAMEvalueDB_CLIENT_CONNECTION_STATEREDIS_CLIENT_CONNECTION_PUBSUBDB_CLIENT_CONNECTION_NAME)rOrPrQrRr9rrrbuild_connection_attributess z,AttributeBuilder.build_connection_attributes error_type is_internalcCs~i}|dur5|jj|t<t|dr|jdur|j|t<nd|t<t|dr1|jdur1|jj|t<nd|t<|dur=||t <|S)z Build error attributes. Args: is_internal: Whether the error is internal (e.g., timeout, network error) error_type: The exception that occurred Returns: Dictionary of error attributes N status_codeerrorrYother) __class__r ERROR_TYPEhasattrr[DB_RESPONSE_STATUS_CODErYrTREDIS_CLIENT_ERROR_CATEGORYREDIS_CLIENT_ERROR_INTERNAL)rYrZr9rrrbuild_error_attributess   z'AttributeBuilder.build_error_attributes directionchannelshardedcCs6t}|j|t<|dur||t<|dur||t<|S)a. Build attributes for a PubSub message. Args: direction: Message direction ('publish' or 'receive') channel: Pub/Sub channel name sharded: True if sharded Pub/Sub channel Returns: Dictionary of PubSub message attributes N)r,r:rT%REDIS_CLIENT_PUBSUB_MESSAGE_DIRECTIONREDIS_CLIENT_PUBSUB_CHANNELREDIS_CLIENT_PUBSUB_SHARDED)rerfrgr9rrrbuild_pubsub_message_attributess z0AttributeBuilder.build_pubsub_message_attributes stream_nameconsumer_group consumer_namecCs,t}|dur ||t<|dur||t<|S)a  Build attributes for a streaming operation. Args: stream_name: Name of the stream consumer_group: Name of the consumer group consumer_name: Name of the consumer Returns: Dictionary of streaming attributes N)r,r:REDIS_CLIENT_STREAM_NAMEREDIS_CLIENT_CONSUMER_GROUP)rlrmrnr9rrrbuild_streaming_attributess z+AttributeBuilder.build_streaming_attributesresultreasoncCs@t}|dur ||t<|dur|j|t<|dur|j|t<|S)a\ Build attributes for a Client Side Caching (CSC) operation. Args: pool_name: Connection pool name (used only for csc_items metric) result: CSC result ('hit' or 'miss') reason: Reason for CSC eviction ('full' or 'invalidation') Returns: Dictionary of CSC attributes N)r,r:rSrTREDIS_CLIENT_CSC_RESULTREDIS_CLIENT_CSC_REASON)rOrrrsr9rrrbuild_csc_attributes4s  z%AttributeBuilder.build_csc_attributes fail_fromr r fail_tocCs.t}t||t<t||t<|j|t<|S)a  Build attributes for a geo failover. Args: fail_from: Database failed from fail_to: Database failed to reason: Reason for the failover Returns: Dictionary of geo failover attributes )r,r: get_db_nameDB_CLIENT_GEOFAILOVER_FAIL_FROMDB_CLIENT_GEOFAILOVER_FAIL_TOrTDB_CLIENT_GEOFAILOVER_REASON)rwryrsr9rrrbuild_geo_failover_attributesRs    z.AttributeBuilder.build_geo_failover_attributesrcCs|d|d|S)a Build a unique connection pool name. Args: server_address: Redis server address server_port: Redis server port db_namespace: Redis database index Returns: Unique pool name in format "address:port/db" :/r)r-r.r/rrrbuild_pool_nameksz AttributeBuilder.build_pool_name)NNN)NNNNNNN)NNNN)NN)r)rrr__doc__ staticmethodrr7intrrr:rrEboolrNr rX Exceptionrdrrkrqrr"rvr'r~rrrrrr,\s     1  "  %        r,pool)r rr0cCsN|jdd}|jdd}t|dd}|r |d|d|S|d|S) a Get a short string representation of a connection pool for observability. This provides a concise pool identifier suitable for use as a metric attribute, in the format: host:port_uniqueID (matching go-redis format) Args: pool: Connection pool instance Returns: Short pool name in format "host:port_uniqueID" Example: >>> pool = ConnectionPool(host='localhost', port=6379, db=0) >>> get_pool_name(pool) 'localhost:6379_a1b2c3d4' hostunknownporti_pool_idr_)connection_kwargsgetgetattr)rrrpool_idrrr get_pool_names  rdatabaserxcCs6|jd}|jd}|j}|d|d|S)z Get a short string representation of a database for observability. Args: database: Database instance Returns: Short database name in format "{host}:{port}/{weight}" rrrr)clientget_connection_kwargsweight)rrrrrrrrzs rz):renumrtypingrrrrrr1redis.asyncio.connectionrredis.asyncio.multidb.databaser redis.connectionr redis.multidb.databaser r2r8rHrarKr_rIrJr5r6rSrUrWr{r|r}r3rV$REDIS_CLIENT_CONNECTION_CLOSE_REASON$REDIS_CLIENT_CONNECTION_NOTIFICATIONrLrMrhrirjrcrbrorprtrur rrr"r'r,r7rrzrrrrsd     %