qidZddlmZmZddlmZmZddlmZm Z m Z m Z m Z m Z ddlmZddlmZddlmZmZddlmZGd d eZGd d eZy )zDebug logging observer for frame activity monitoring. This module provides a debug observer that logs detailed frame activity to the console, making it useful for debugging pipeline behavior and understanding frame flow between processors. )fields is_dataclass)Enumauto)DictOptionalSetTupleTypeUnion)logger)Frame) BaseObserver FramePushed)FrameDirectionc,eZdZdZeZeZy) FrameEndpointzSpecifies which endpoint (source or destination) to filter on. Parameters: SOURCE: Filter on the source component that is pushing the frame. DESTINATION: Filter on the destination component receiving the frame. N)__name__ __module__ __qualname____doc__rSOURCE DESTINATION^/opt/pipecat/venv/lib/python3.12/site-packages/pipecat/observers/loggers/debug_log_observer.pyrrsVF&Krrc eZdZdZ d deeeeedfe eeeeee fffdee e ffd Z dZdZdefd ZxZS) DebugLogObserveramObserver that logs frame activity with detailed content to the console. Automatically extracts and formats data from any frame type, making it useful for debugging pipeline behavior without needing frame-specific observers. Examples: Log all frames from all services:: observers = DebugLogObserver() Log specific frame types from any source/destination:: from pipecat.frames.frames import LLMTextFrame, TranscriptionFrame observers=[ DebugLogObserver(frame_types=(LLMTextFrame,TranscriptionFrame,)), ] Log frames with specific source/destination filters:: from pipecat.frames.frames import InterruptionFrame, UserStartedSpeakingFrame, LLMTextFrame from pipecat.observers.loggers.debug_log_observer import DebugLogObserver, FrameEndpoint from pipecat.transports.base_output import BaseOutputTransport from pipecat.services.stt_service import STTService observers=[ DebugLogObserver( frame_types={ # Only log InterruptionFrame when source is BaseOutputTransport InterruptionFrame: (BaseOutputTransport, FrameEndpoint.SOURCE), # Only log UserStartedSpeakingFrame when destination is STTService UserStartedSpeakingFrame: (STTService, FrameEndpoint.DESTINATION), # Log LLMTextFrame regardless of source or destination type LLMTextFrame: None, } ), ] frame_types.exclude_fieldsc t|di|i|_|.t|tr|Dcic]}|dc}|_n||_|||_yhd|_ycc}w)aInitialize the debug log observer. Args: frame_types: Frame types to log. Can be: - Tuple of frame types to log all instances - Dict mapping frame types to filter configurations - None to log all frames Filter configurations can be None (log all instances) or a tuple of (service_type, endpoint) to filter on specific services. exclude_fields: Field names to exclude from logging. Defaults to excluding binary data fields like 'audio', 'image', 'images'. **kwargs: Additional arguments passed to parent class. N>audioimageimagesr)super__init__ frame_filters isinstancetupler )selfrr kwargs frame_type __class__s rr&zDebugLogObserver.__init__Lsy. "6"   "+u-IT%U:j$&6%U"&1" )    &Vs Ac|yt|tr|St|ttfrIt |dk(ryt|dt rt |dkDrt |dSt|St|t tfrt |dSt|dr>tt|dr)|jjd|jSt|S) zFormat a value for logging.Nonerz[]z itemsz bytesget_messages_for_loggingz with messages: )r(strlistr)lendictbytes bytearrayhasattrcallablegetattrr-rr1)r*values r _format_valuezDebugLogObserver._format_value{s = s #Y  e} -5zQ%(D)c%j1ne*V,,u:  y1 2%j\( ( U6 7H E5 6= oo..//?@^@^@`?ab bu: rc|jsy|jjD]]\}}t||s|y|\}}|tjk(rt||cS|tj k(sQt||cSy)z7Determine if a frame should be logged based on filters.TF)r'itemsr(rrr)r*framesrcdstr, filter_config service_typeendpoints r_should_log_framez"DebugLogObserver._should_log_frames!!*.););)A)A)C 9 %J %, (*7& h}333%c<88!:!::%c<88 9rdatac K|j}|j}|j}|j}|j}|j |||sy|t jk(rdnd}|dz }|jj} g} t|rst|D]e} | j|jvrt|| j} | 5|j| } | j!| jd| g| rdj#| }| d|d|d d }n | d|d d }t%j&|d|d|d|yw) zProcess a frame being pushed into the pipeline. Logs frame details to the console with all relevant fields and values. Args: data: Event data containing the frame, source, destination, direction, and timestamp. Nu→u←iʚ;z: z,  z at z.2fs)source destinationr? direction timestamprEr DOWNSTREAMr-rrrnamer r:r<appendjoinr debug)r*rFr@rAr?rLrMarrowtime_sec class_name frame_detailsfieldr;formatted_valuedetailsmessages r on_push_framezDebugLogObserver.on_push_framesdkk NN NN %%eS#6 #n&?&??U},__--     I::!4!44uzz2="&"4"4U";$$ |2o5F%GH I ii .G# AgYd8C.BG# D#a8G  uAeWAcU"WI67sE E)NN)rrrrrr r r rrrr r2r&r<rErr[ __classcell__)r-s@rrr%s$T -1 -  %U S()4U XeDR_L_F`=a0a+bb c - !S* - ^..08 08rrN)r dataclassesrrenumrrtypingrrr r r r logurur pipecat.frames.framesrpipecat.observers.base_observerrr"pipecat.processors.frame_processorrrrrrrrds>-::'E= D t8|t8r