File: //usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyo
�
d�bc @ s� d d l Z d d l Z d d l Z d d l Z d d l Z d d l m Z d d l j j Z d d l
m Z d d l m
Z
m Z d d l m Z m Z m Z m Z m Z m Z m Z m Z m Z m Z d d l m Z m Z d d l m Z d d l m Z d d l! m" Z" m# Z# m$ Z$ m% Z% d d
l& m' Z' d d l( m) Z) d d l* m+ Z+ d
� Z, d e- f d � � YZ. d e+ f d � � YZ/ d e+ f d � � YZ0 d e f d � � YZ1 d S( i����N( t defaultdict( t conf( t get_supported_feature_by_namet SupportedFeatureNames(
t EVENTS_DIRECTORYt TELEMETRY_LOG_EVENT_IDt TELEMETRY_LOG_PROVIDER_IDt add_eventt WALAEventOperationt
add_log_eventt get_event_loggert CollectOrReportEventDebugInfot EVENT_FILE_REGEXt parse_event( t InvalidExtensionEventErrort ServiceStoppedError( t ustr( t ThreadHandlerInterface( t TelemetryEventt TelemetryEventParamt GuestAgentGenericLogsSchemat GuestAgentExtensionEventsSchema( t textutil( t HANDLER_NAME_PATTERN( t PeriodicOperationc C s
t | � S( N( t CollectTelemetryEventsHandler( t send_telemetry_events_handler( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyt$ get_collect_telemetry_events_handler* s t ExtensionEventSchemac B s> e Z d Z d Z d Z d Z d Z d Z d Z d Z d Z
RS( sD
Class for defining the schema for Extension Events.
Sample Extension Event Example:
{
"Version":"1.0.0.23",
"Timestamp":"2018-01-02T22:08:12.510696Z" //(time in UTC (ISO-8601 standard),
"TaskName":"TestRun" //Open for publishers,
"EventLevel":"Critical/Error/Warning/Verbose/Informational/LogAlways",
"Message": "Successful test" //(max 3K, 3072 characters),
"EventPid":"1",
"EventTid":"2",
"OperationId":"Guid (str)"
}
t Versiont Timestampt TaskNamet
EventLevelt Messaget EventPidt EventTidt OperationId( t __name__t
__module__t __doc__R R R R R! R" R# R$ ( ( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyR . s t _ProcessExtensionEventsc B s
e Z d Z e j d e j � � Z e j d e j
� Z d Z d Z
d Z d Z g e e � D]8 Z e e e e � � r^ e j d � r^ e j � ^ q^ Z d � Z d
� Z e d � � Z d � Z d
� Z e d � � Z d � Z d � Z d � Z! e d � � Z" RS( s
Periodic operation for collecting extension telemetry events and enqueueing them for the SendTelemetryHandler thread.
t secondss
^(\d+)\.json$i, i i i i t __c C s& t t | � j t j � | | _ d S( N( t superR( t __init__t" _EXTENSION_EVENT_COLLECTION_PERIODt _send_telemetry_events_handler( t selfR ( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyR, Y s c C s% | j j � r2 t j d j | j j � � � d St } g } z� ye | j t j � � } | sp t j
d � d Sx2 | D]* } | d } | d } | j | | � qw WWn] t k
r� t
} nG t k
r} d j t j | � � } t d t j d | d t
� n XWd | r | j | � n Xd S( Ns6 {0} service is not running, skipping current iterations# No Extension events directory existi i sB Unknown error occurred when trying to collect extension events:{0}t opt messaget
is_success( R. t stoppedt loggert warnt formatt get_thread_namet Truet+ _get_extension_events_dir_with_handler_nameR t get_ext_log_dirt verboset _capture_extension_eventsR t Falset ExceptionR t format_exceptionR R t! ExtensionTelemetryEventProcessingt$ _ensure_all_events_directories_empty( R/ t delete_all_event_filest! extension_handler_with_event_dirst extension_handler_with_event_dirt handler_namet handler_event_dir_patht errort msg( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyt
_operation] s0
$c C s� g } x� t j | � D]� } t j j t j j | | � � s t j t | � d k r\ q n t j j | | t � } t j j
| � r | j | | f � q q W| S( s�
Get the full path to events directory for all extension handlers that have one
:param extension_log_dir: Base log directory for all extensions
:return: A list of full paths of existing events directory for all handlers
N( t ost listdirt patht isdirt joint ret matchR t NoneR t existst append( t extension_log_dirRC t ext_handler_namet extension_event_dir( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyR9 � s "c C s� t j | � j } | | j k r~ d � } d j | | | � | | j � � } t j | � t d t j j d | d t
� t St
S( Nc S s d | d S( Ng �?i� i@B ( ( t x( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyt <lambda>� s sJ Skipping file: {0} as its size is {1:.2f} Mb > Max size allowed {2:.1f} Mbt levelR1 t forced( RJ t statt st_sizet _EXTENSION_EVENT_FILE_MAX_SIZER6 R4 R5 R t LogLevelt WARNINGR8 R= ( R/ t event_file_patht event_file_sizet
convert_to_mbRH ( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyt _event_file_size_allowed� s
c C sN g t j | � D]' } t j | j | � d k r | ^ q } | j d t � d } t t � } zDx=| D]5} t j
j | | � } z y� t j
d | � | j | � s� wi n | j | | | | � } | | j k rd j | | j � } t j | � t d t j j d | d t � Pn Wnm t k
r2� nZ t k
r�} d j | t j | � � } t j | � t d t j j d | d t � n XWd t j | � Xqi WWd | r!d
j | d j g | j � D] \ }
} d j |
| � ^ q�� � } t j | � t d t j j d | d t � n | d k rIt j d
j | | � � n Xd S( s
Capture Extension events and add them to the events_list
:param handler_name: Complete Handler Name. Eg: Microsoft.CPlat.Core.RunCommandLinux
:param handler_event_dir_path: Full path. Eg: '/var/log/azure/Microsoft.CPlat.Core.RunCommandLinux/events'
t reversei s Processing event file: {0}sL Reached max count for the extension: {0}; Max Limit: {1}. Skipping the rest.RY R1 RZ s$ Failed to process event file {0}:{1}Ns0 Dropped events for Extension: {0}; Details:
{1}s
s Reason: {0}; Dropped Count: {1}s' Collected {0} events for extension: {1}( RJ RK RO RP t _EXTENSION_EVENT_FILE_NAME_REGEXRQ t sortR8 R t intRL RN R4 R; Rc t _enqueue_events_and_get_countt. _MAX_NUMBER_OF_EVENTS_PER_EXTENSION_PER_PERIODR6 R5 R R^ R_ R R> R R? t removet itemst info( R/ RE RF t
event_filet event_filest captured_extension_events_countt dropped_events_with_error_countR` RH RG t kt v( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyR< � sJ '
'7
" c C s� | s
d Sx� | D]� } | d } t j j | � s7 d St } xu t j | � D]d } y t j t j j | | � � WqM t k
r� } | r� t j d | t
| � � t } q� qM XqM Wq Wd S( Ni s< Failed to completely clear the {0} directory. Exception: {1}( RJ RL RR R8 RK Rj RN R> R4 RG R R= ( t extension_events_directoriesRD t event_dir_patht log_errt residue_fileRG ( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyRA � s
c
C sO t j j t j j | � � } t | d � � } | j � j d � } Wd QXt j | � } t
| t � su | g } n x� | D]� } y- | j j
| j | | | � � | d 7} Wn� t k
r� }
| t |
� c d 7<nZ t k
r } t j d j t | � � � � n) t k
r3} t j d j | � � n X| | j k r| Pq| q| W| S( Nt rbs utf-8i sV Unable to enqueue events as service stopped: {0}. Stopping collecting extension eventss. Unable to parse and transmit event, error: {0}( t datetimet
fromtimestampRJ RL t getmtimet opent readt decodet jsont loadst
isinstancet listR. t
enqueue_eventt _parse_telemetry_eventR R R R4 RG R6 R> R5 Ri (
R/ RE R` t captured_events_countRp t event_file_timet event_file_descriptort
event_datat eventst eventt
invalid_errort
stopped_errorRG ( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyRh � s.
c C s | j | � } t t t � } d | _ t j | | � i d j | | t j j
� � t j 6| t j
j
� t j 6| t j j
� t j 6| t j j
� t j 6| t j j
� t j 6| t j j
� t j 6| t j j
� t j 6| t j j
� t j 6} | j | | � | S( s�
Parse the Json event file and convert it to TelemetryEvent object with the required data.
:return: Complete TelemetryEvent with all required fields filled up properly. Raises if event breaches contract.
R~ s {0}-{1}( t# _parse_event_and_ensure_it_is_validR R R t file_typeR t$ add_common_params_to_telemetry_eventR6 R R t lowerR t EventNameR t CapabilityUsedR R! t Context1R t Context2R$ t Context3R" R# t _replace_or_add_param_in_event( R/ RE t extension_unparsed_eventR� t extension_eventR� t replace_or_add_params( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyR� # s c s< d � � d } d } t � � f d � | j � D� � } t j j � } | | k rm | | � j | | <n t | j t j t j � � � | | s� t d j t j t j � � � n x � j
D]t } | | k r� t | j t j | � � � n | � j k r t d j t j � j � � � n | t
| | � 7} q� W| S( s�
Parse the Json event from file. Raise InvalidExtensionEventError if the event breaches pre-set contract.
:param extension_event: The json event from file
:return: Verified Json event that qualifies the contract.
c S s | d k r | j � S| S( N( RQ t strip( RW ( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyRX G s i s {0}: {1} not foundc 3 sB | ]8 \ } } | j � � j k r | j � � | � f Vq d S( N( R� t _EXTENSION_EVENT_REQUIRED_FIELDS( t .0Rq Rr ( t clean_stringR/ ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pys <genexpr>N s s {0}: {1} should not be emptys {0}: max event size allowed: {1}( t dictRk R R! R� t _EXTENSION_EVENT_MAX_MSG_LENR R6 t MissingKeyErrort EmptyMessageErrorR� t _EXTENSION_EVENT_MAX_SIZEt OversizeEventErrort len( R/ R� t
event_sizet key_err_msgR� t message_keyt required_key( ( R� R/ sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyR� @ s. %
c C sw x8 | j D]- } | j | k r
| j | j � | _ q
q
W| sE d Sx+ | D]# } | j j t | | | � � qL Wd S( N( t
parameterst namet popt valueRS R ( R� R� t paramt
param_name( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyR� n s
i i @ i i (# R% R& R' Rx t timedeltaR t get_etp_collection_periodR- RO t compilet
IGNORECASERe Ri R] R� R� t dirR t attrt callablet getattrt
startswithR� R� R, RI t staticmethodR9 Rc R< RA Rh R� R� R� ( ( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyR( H s& 8 #
@ * .t _CollectAndEnqueueEventsc B sY e Z d Z e j d d � Z d � Z d � Z d � Z e d � � Z
e d � � Z RS( s�
Periodic operation to collect telemetry events located in the events folder and enqueue them for the
SendTelemetryHandler thread.
t minutesi c C s& t t | � j t j � | | _ d S( N( R+ R� R, t _EVENT_COLLECTION_PERIODR. ( R/ R ( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyR, � s c C s� y@ | j j � r5 t j d j | j j � � � d S| j � WnD t k
r� } d j t | � � } t d t
j d | d t � n Xd S( sK
Periodically send any events located in the events folder
s/ {0} service is not running, skipping iteration.Ns+ Failure in collecting telemetry events: {0}R0 R1 R2 (
R. R3 R4 R5 R6 R7 t process_eventsR> R R R t UnhandledErrorR= ( R/ RG t err_msg( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyRI � s c C s� t j j t j � t � } t j | � } t d t j � } x�| D]�} y&t j
| � } | d k rm wC n t j j | | � } z� t j
d | � t | d � � } | j � j d � } Wd QXt | � } | j d � d k }
|
rLt j j | � } t j j | � } | j � r9t j | � t j | | � qLt j | | � n | j j | � Wd t j | � XWqC t k
r�}
t j d j! t" |
� � � qC t# k
r�} | j$ | � qC t% k
r�} | j& | � qC XqC W| j' � d S( s�
Returns a list of events that need to be sent to the telemetry pipeline and deletes the corresponding files
from the events directory.
t operations Processing event file: {0}Rw s utf-8Nt agent_eventsL Unable to enqueue events as service stopped: {0}, skipping events collection(( RJ RL RN R t get_lib_dirR RK R t
OP_COLLECTR t searchRQ R4 R; R{ R| R} R
t groupRz Rx Ry t is_extension_eventR� t' _trim_legacy_extension_event_parametersR R� t _update_legacy_agent_eventR. R� Rj R RG R6 R t UnicodeErrort update_unicode_errorR> t update_op_errort report_debug_info( R/ t event_directory_full_pathRn t
debug_infoRm RP R` t event_fdR� R� t is_legacy_eventt event_file_creation_time_epocht event_file_creation_timeR� t uni_errRG ( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyR� � sF
c C s� t � } g | _ t j | | � t g | j D] } | j | j f ^ q/ � } t g | j D] } | j | j f ^ q] � } t | j � � j t | j � � � } g } x( | D] } | j
t | | | � � q� W| j j | � d S( N(
R R� R R� R� R� R� t sett keyst
differenceRS R t extend( R� t event_creation_timet new_eventR� t event_paramst new_event_paramst missing_paramst
params_to_addR� ( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyR� � s ..'
c C s| t � j t j t j t j t j t j t j g � } g } x0 | j D]% } | j
| k rF | j | � qF qF W| | _ d S( s�
This method is called for extension events before they are sent out. Per the agreement with extension
publishers, the parameters that belong to extensions and will be reported intact are Name, Version, Operation,
OperationSuccess, Message, and Duration. Since there is nothing preventing extensions to instantiate other
fields (which belong to the agent), we call this method to ensure the rest of the parameters are trimmed since
they will be replaced with values coming from the agent.
:param event: Extension event to trim.
:return: Trimmed extension event; containing only extension-specific parameters.
N( R� t fromkeysR t NameR t Operationt OperationSuccessR! t DurationR� R� RS ( R� t params_to_keept trimmed_paramsR� ( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyR� � s ( R% R& R' Rx R� R� R, RI R� R� R� R� ( ( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyR� } s ;R c B sq e Z d Z d Z d � Z e d � � Z d � Z d � Z d � Z d � Z
d � Z d � Z e d
� � Z
RS( s�
This Handler takes care of fetching the Extension Telemetry events from the {extension_events_dir} and sends it to
Kusto for advanced debuggability.
t TelemetryEventsCollectorc C s t | _ d | _ | | _ d S( N( R8 t
should_runRQ t threadR. ( R/ R ( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyR, s c C s t j S( N( R t _THREAD_NAME( ( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyR7
s c C s t j d � | j � d S( Ns" Start Extension Telemetry service.( R4 Rl t start( R/ ( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyt run s
c C s | j d k o | j j � S( N( R� RQ t is_alive( R/ ( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyR� s c C sO t j d | j � | _ | j j t � | j j t j � � | j j � d S( Nt target(
t threadingt Threadt daemonR� t setDaemonR8 t setNameR R7 R� ( R/ ( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyR� s c C s) t | _ | j � r% | j j � n d S( sO
Stop server communication and join the thread to main thread.
N( R= R� R� R� RN ( R/ ( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyt stop s c C s | j S( N( R� ( R/ ( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyR3 & s c C s� t | j � g } t t j � j } t j d j | � � | rY | j t
| j � � n t j d j | j � � � xp | j � s� zO y x | D] } | j
� q� WWn) t k
r� } t j d t | � � n XWd t j | � Xqx Wd S( Ns) Extension Telemetry pipeline enabled: {0}s# Successfully started the {0} threadsc An error occurred in the Telemetry Extension thread main loop; will skip the current iteration.
{0}( R� R. R R t ExtensionTelemetryPipelinet is_supportedR4 Rl R6 RS R( R7 R3 R� R> R5 R R t sleep_until_next_operation( R/ t periodic_operationst is_etp_enabledt periodic_opRG ( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyR� ) s
c C s t � } | j | | � d S( N( R
t add_common_event_parameters( R� t
event_timet reporter( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyR� @ s ( R% R& R' R� R, R� R7 R� R� R� R� R3 R� R� ( ( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyR s (2 Rx R~ RJ RO R� t collectionsR t azurelinuxagent.common.loggert commonR4 t azurelinuxagent.commonR t. azurelinuxagent.common.agent_supported_featureR R t azurelinuxagent.common.eventR R R R R R R
R R R
t azurelinuxagent.common.exceptionR R t azurelinuxagent.common.futureR t! azurelinuxagent.common.interfacesR t% azurelinuxagent.common.telemetryeventR R R R t azurelinuxagent.common.utilsR t azurelinuxagent.ga.exthandlersR t% azurelinuxagent.ga.periodic_operationR R t objectR R( R� R ( ( ( sO /usr/lib/python2.7/site-packages/azurelinuxagent/ga/collect_telemetry_events.pyt <module> s, F" � 6�