File: //usr/libexec/oracle-cloud-agent/plugins/osms/grpc/_observability.pyc
a
K��f�- � @ sR U d dl mZ d dlZd dlZd dlZd dlZd dlmZmZm Z m
Z
m Z m Z d dl
mZ d dlmZ e�e�ZeZe d�Ze d�Ze�� Zded < dad
ed < d d
gZ ded< G dd� d�Z G dd� de eef ej d�Z ej dd�dd��Z!ddd�d d �Z"ddd�d d �Z#dd�d d!�Z$d"dd#�d$d%�Z%d&dd'�d(d)�Z&d*d+d,�d-d.�Z'dS )/� )� annotationsN)�Any� Generator�Generic�List�Optional�TypeVar)�cygrpc)�ChannelArgumentType�ClientCallTracerCapsule� ServerCallTracerFactoryCapsulezthreading.RLock� _plugin_lockz Optional['ObservabilityPlugin']�_OBSERVABILITY_PLUGINs" google.monitoring.v3.MetricServices* google.devtools.cloudtrace.v2.TraceServicez List[bytes]�_SERVICES_TO_EXCLUDEc @ s e Zd ZdZdd� Zdd� ZdS )�ServerCallTracerFactoryz�An encapsulation of a ServerCallTracerFactory.
Instances of this class can be passed to a Channel as values for the
grpc.experimental.server_call_tracer_factory option
c C s
|| _ d S �N��_address)�self�address� r �w/sparta/input/_build_configuration/image_build+validate/lib/bmcenv/lib64/python3.9/site-packages/grpc/_observability.py�__init__/ s z ServerCallTracerFactory.__init__c C s | j S r r �r r r r �__int__2 s z ServerCallTracerFactory.__int__N)�__name__�
__module__� __qualname__�__doc__r r r r r r r ( s r c @ s e Zd ZU dZdZded< dZded< ejdddd�d d
��Z ejdd d �d
d��Z
ejdddd d�dd��Z ejdd�ddd�dd��Z ejddddd d�dd ��Z
dd d �d d �Zdd d �d d!�Zdd d"�d#d$�Zedd%�d&d'��Zedd%�d(d)��Zedd%�d*d+��Zd,S )-�ObservabilityPlugina� Abstract base class for observability plugin.
*This is a semi-private class that was intended for the exclusive use of
the gRPC team.*
The ClientCallTracerCapsule and ClientCallTracerCapsule created by this
plugin should be inject to gRPC core using observability_init at the
start of a program, before any channels/servers are built.
Any future methods added to this interface cannot have the
@abc.abstractmethod annotation.
Attributes:
_stats_enabled: A bool indicates whether tracing is enabled.
_tracing_enabled: A bool indicates whether stats(metrics) is enabled.
_registered_methods: A set which stores the registered method names in
bytes.
F�bool�_tracing_enabled�_stats_enabled�bytesr )� method_name�target�returnc C s
t � �dS )a� Creates a ClientCallTracerCapsule.
After register the plugin, if tracing or stats is enabled, this method
will be called after a call was created, the ClientCallTracer created
by this method will be saved to call context.
The ClientCallTracer is an object which implements `grpc_core::ClientCallTracer`
interface and wrapped in a PyCapsule using `client_call_tracer` as name.
Args:
method_name: The method name of the call in byte format.
target: The channel target of the call in byte format.
registered_method: Wether this method is pre-registered.
Returns:
A PyCapsule which stores a ClientCallTracer object.
N��NotImplementedError)r r$ r% r r r �create_client_call_tracerP s z-ObservabilityPlugin.create_client_call_tracer�None)�client_call_tracerr& c C s
t � �dS )a� Deletes the ClientCallTracer stored in ClientCallTracerCapsule.
After register the plugin, if tracing or stats is enabled, this method
will be called at the end of the call to destroy the ClientCallTracer.
The ClientCallTracer is an object which implements `grpc_core::ClientCallTracer`
interface and wrapped in a PyCapsule using `client_call_tracer` as name.
Args:
client_call_tracer: A PyCapsule which stores a ClientCallTracer object.
Nr' )r r+ r r r �delete_client_call_tracerg s z-ObservabilityPlugin.delete_client_call_tracer�str)�trace_id�span_id�
is_sampledr& c C s
t � �dS )a� Saves the trace_id and span_id related to the current span.
After register the plugin, if tracing is enabled, this method will be
called after the server finished sending response.
This method can be used to propagate census context.
Args:
trace_id: The identifier for the trace associated with the span as a
32-character hexadecimal encoded string,
e.g. 26ed0036f2eff2b7317bccce3e28d01f
span_id: The identifier for the span as a 16-character hexadecimal encoded
string. e.g. 113ec879e62583bc
is_sampled: A bool indicates whether the span is sampled.
Nr' )r r. r/ r0 r r r �save_trace_contextx s z&ObservabilityPlugin.save_trace_context)�xdsz(Optional[ServerCallTracerFactoryCapsule]�r2 r& c C s
t � �dS )ap Creates a ServerCallTracerFactoryCapsule.
This method will be called at server initialization time to create a
ServerCallTracerFactory, which will be registered to gRPC core.
The ServerCallTracerFactory is an object which implements
`grpc_core::ServerCallTracerFactory` interface and wrapped in a PyCapsule
using `server_call_tracer_factory` as name.
Args:
xds: Whether the server is xds server.
Returns:
A PyCapsule which stores a ServerCallTracerFactory object. Or None if
plugin decides not to create ServerCallTracerFactory.
Nr' )r r2 r r r �!create_server_call_tracer_factory� s z5ObservabilityPlugin.create_server_call_tracer_factory�floatr )�methodr% � rpc_latency� status_coder& c C s
t � �dS )aa Record the latency of the RPC.
After register the plugin, if stats is enabled, this method will be
called at the end of each RPC.
Args:
method: The fully-qualified name of the RPC method being invoked.
target: The target name of the RPC method being invoked.
rpc_latency: The latency for the RPC in seconds, equals to the time between
when the client invokes the RPC and when the client receives the status.
status_code: An element of grpc.StatusCode in string format representing the
final status for the RPC.
Nr' )r r6 r% r7 r8 r r r �record_rpc_latency� s z&ObservabilityPlugin.record_rpc_latency)�enabler& c C s
|| _ dS )zxEnable or disable tracing.
Args:
enable: A bool indicates whether tracing should be enabled.
N�r! �r r: r r r � set_tracing� s z ObservabilityPlugin.set_tracingc C s
|| _ dS )z}Enable or disable stats(metrics).
Args:
enable: A bool indicates whether stats should be enabled.
N�r" r< r r r � set_stats� s z ObservabilityPlugin.set_stats)r$ r& c C s
t � �dS )z�Saves the method name to registered_method list.
When exporting metrics, method name for unregistered methods will be replaced
with 'other' by default.
Args:
method_name: The method name in bytes.
Nr' )r r$ r r r �save_registered_method� s z*ObservabilityPlugin.save_registered_method�r& c C s | j S r r; r r r r �tracing_enabled� s z#ObservabilityPlugin.tracing_enabledc C s | j S r r> r r r r �
stats_enabled� s z!ObservabilityPlugin.stats_enabledc C s | j p
| jS r )rB rC r r r r �observability_enabled� s z)ObservabilityPlugin.observability_enabledN)r r r r r! �__annotations__r" �abc�abstractmethodr) r, r1 r4 r9 r= r? r@ �propertyrB rC rD r r r r r 6 s.
� r )� metaclassz4Generator[Optional[ObservabilityPlugin], None, None]rA c c s. t � tV W d � n1 s 0 Y dS )z�Get the ObservabilityPlugin in _observability module.
Returns:
The ObservabilityPlugin currently registered with the _observability
module. Or None if no plugin exists at the time of calling this method.
N)r
r r r r r �
get_plugin� s rJ z Optional[ObservabilityPlugin]r* )�observability_pluginr& c C s< t �$ | rtrtd��| aW d � n1 s.0 Y dS )z�Save ObservabilityPlugin to _observability module.
Args:
observability_plugin: The ObservabilityPlugin to save.
Raises:
ValueError: If an ObservabilityPlugin was already registered at the
time of calling this method.
z%observability_plugin was already set!N)r
r �
ValueError�rK r r r �
set_plugin� s rN c C s t | � dS )ah Initialize observability with provided ObservabilityPlugin.
This method have to be called at the start of a program, before any
channels/servers are built.
Args:
observability_plugin: The ObservabilityPlugin to use.
Raises:
ValueError: If an ObservabilityPlugin was already registered at the
time of calling this method.
N)rN rM r r r �observability_init� s
rO c C s t d� t�� dS )z�Clear the observability context, including ObservabilityPlugin and
ServerCallTracerFactory
This method have to be called after exit observability context so that
it's possible to re-initialize again.
N)rN �_cygrpc� clear_server_call_tracer_factoryr r r r �observability_deinit s rR r )�client_call_tracer_capsuler& c C s> t � �$}|r |jr |�| � W d � n1 s00 Y dS )a� Deletes the ClientCallTracer stored in ClientCallTracerCapsule.
This method will be called at the end of the call to destroy the ClientCallTracer.
The ClientCallTracer is an object which implements `grpc_core::ClientCallTracer`
interface and wrapped in a PyCapsule using `client_call_tracer` as the name.
Args:
client_call_tracer_capsule: A PyCapsule which stores a ClientCallTracer object.
N)rJ rD r, )rS �pluginr r r �delete_call_tracer s
rU z'_channel._RPCState')�stater& c C s~ t D ]}|| j�d�v r dS qt� �D}|r\|jr\| j| j }|d }|�| j| j|| j � W d � n1 sp0 Y dS )z�Record the latency of the RPC, if the plugin is registered and stats is enabled.
This method will be called at the end of each RPC.
Args:
state: a grpc._channel._RPCState object which contains the stats related to the
RPC.
�utf8Ni� )
r r6 �encoderJ rC � rpc_end_time�rpc_start_timer9 r% �code)rV �exclude_prefixrT �
rpc_latency_s�rpc_latency_msr r r �maybe_record_rpc_latency' s
�r_ r r
r3 c C sb t � �H}|r>|jr>t�|| �}|r>dt|�ffW d � S W d � dS 1 sT0 Y d S )Nz,grpc.experimental.server_call_tracer_factoryr )rJ rC rP �&get_server_call_tracer_factory_addressr )r2 rT �"server_call_tracer_factory_addressr r r �(create_server_call_tracer_factory_option= s
����rb )(�
__future__r rF �
contextlib�logging� threading�typingr r r r r r � grpc._cythonr rP � grpc._typingr
� getLoggerr �_LOGGER�_channelr r �RLockr
rE r r r �ABCMetar �contextmanagerrJ rN rO rR rU r_ rb r r r r �<module> s<
�
� *