File: //var/opt/nydus/ops/mysql/opentelemetry/sdk/trace/__pycache__/sampling.cpython-39.pyc
a
�,�hpA � @ s� d Z ddlZddlZddlZddlmZ ddlmZ ddlm Z m
Z
ddl m Z ddl
mZmZ ddlmZmZmZ dd lmZ dd
lmZ ee�ZG d d � d ej�ZG d
d� d�Z G dd� dej �Z G dd� de �Z e ej �Z!e ej"�Z#G dd� de �Z$G dd� de �Z%e%e!�Z&e%e#�Z'G dd� de%�Z(G dd� de �Z)G dd � d e �Z*G d d � d e%�Z+G d d � d e%�Z,e#e!e'e&e$e(d!�Z-e d"�d#d$�Z.e d% d"�d&d'�Z/dS )(a�
For general information about sampling, see `the specification <https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/sdk.md#sampling>`_.
OpenTelemetry provides two types of samplers:
- `StaticSampler`
- `TraceIdRatioBased`
A `StaticSampler` always returns the same sampling result regardless of the conditions. Both possible StaticSamplers are already created:
- Always sample spans: ALWAYS_ON
- Never sample spans: ALWAYS_OFF
A `TraceIdRatioBased` sampler makes a random sampling result based on the sampling probability given.
If the span being sampled has a parent, `ParentBased` will respect the parent delegate sampler. Otherwise, it returns the sampling result from the given root sampler.
Currently, sampling results are always made during the creation of the span. However, this might not always be the case in the future (see `OTEP #115 <https://github.com/open-telemetry/oteps/pull/115>`_).
Custom samplers can be created by subclassing `Sampler` and implementing `Sampler.should_sample` as well as `Sampler.get_description`.
Samplers are able to modify the `mysql.opentelemetry.trace.span.TraceState` of the parent of the span being created. For custom samplers, it is suggested to implement `Sampler.should_sample` to utilize the
parent span context's `mysql.opentelemetry.trace.span.TraceState` and pass into the `SamplingResult` instead of the explicit trace_state field passed into the parameter of `Sampler.should_sample`.
To use a sampler, pass it into the tracer provider constructor. For example:
.. code:: python
from opentelemetry import trace
from mysql.opentelemetry.sdk.trace import TracerProvider
from mysql.opentelemetry.sdk.trace.export import (
ConsoleSpanExporter,
SimpleSpanProcessor,
)
from mysql.opentelemetry.sdk.trace.sampling import TraceIdRatioBased
# sample 1 in every 1000 traces
sampler = TraceIdRatioBased(1/1000)
# set the sampler onto the global tracer provider
trace.set_tracer_provider(TracerProvider(sampler=sampler))
# set up an exporter for sampled spans
trace.get_tracer_provider().add_span_processor(
SimpleSpanProcessor(ConsoleSpanExporter())
)
# created spans will now be sampled by the TraceIdRatioBased sampler
with trace.get_tracer(__name__).start_as_current_span("Test Span"):
...
The tracer sampler can also be configured via environment variables ``OTEL_TRACES_SAMPLER`` and ``OTEL_TRACES_SAMPLER_ARG`` (only if applicable).
The list of built-in values for ``OTEL_TRACES_SAMPLER`` are:
* always_on - Sampler that always samples spans, regardless of the parent span's sampling decision.
* always_off - Sampler that never samples spans, regardless of the parent span's sampling decision.
* traceidratio - Sampler that samples probabalistically based on rate.
* parentbased_always_on - (default) Sampler that respects its parent span's sampling decision, but otherwise always samples.
* parentbased_always_off - Sampler that respects its parent span's sampling decision, but otherwise never samples.
* parentbased_traceidratio - Sampler that respects its parent span's sampling decision, but otherwise samples probabalistically based on rate.
Sampling probability can be set with ``OTEL_TRACES_SAMPLER_ARG`` if the sampler is traceidratio or parentbased_traceidratio. Rate must be in the range [0.0,1.0]. When not provided rate will be set to
1.0 (maximum rate possible).
Prev example but with environment variables. Please make sure to set the env ``OTEL_TRACES_SAMPLER=traceidratio`` and ``OTEL_TRACES_SAMPLER_ARG=0.001``.
.. code:: python
from opentelemetry import trace
from mysql.opentelemetry.sdk.trace import TracerProvider
from mysql.opentelemetry.sdk.trace.export import (
ConsoleSpanExporter,
SimpleSpanProcessor,
)
trace.set_tracer_provider(TracerProvider())
# set up an exporter for sampled spans
trace.get_tracer_provider().add_span_processor(
SimpleSpanProcessor(ConsoleSpanExporter())
)
# created spans will now be sampled by the TraceIdRatioBased sampler with rate 1/1000.
with trace.get_tracer(__name__).start_as_current_span("Test Span"):
...
When utilizing a configurator, you can configure a custom sampler. In order to create a configurable custom sampler, create an entry point for the custom sampler
factory method or function under the entry point group, ``opentelemetry_traces_sampler``. The custom sampler factory method must be of type ``Callable[[str], Sampler]``, taking a single string argument and
returning a Sampler object. The single input will come from the string value of the ``OTEL_TRACES_SAMPLER_ARG`` environment variable. If ``OTEL_TRACES_SAMPLER_ARG`` is not configured, the input will
be an empty string. For example:
.. code:: python
setup(
...
entry_points={
...
"opentelemetry_traces_sampler": [
"custom_sampler_name = path.to.sampler.factory.method:CustomSamplerFactory.get_sampler"
]
}
)
# ...
class CustomRatioSampler(Sampler):
def __init__(rate):
# ...
# ...
class CustomSamplerFactory:
@staticmethod
get_sampler(sampler_argument):
try:
rate = float(sampler_argument)
return CustomSampler(rate)
except ValueError: # In case argument is empty string.
return CustomSampler(0.5)
In order to configure you application with a custom sampler's entry point, set the ``OTEL_TRACES_SAMPLER`` environment variable to the key name of the entry point. For example, to configured the
above sampler, set ``OTEL_TRACES_SAMPLER=custom_sampler_name`` and ``OTEL_TRACES_SAMPLER_ARG=0.5``.
� N)� getLogger)�MappingProxyType)�Optional�Sequence)�Context)�OTEL_TRACES_SAMPLER�OTEL_TRACES_SAMPLER_ARG)�Link�SpanKind�get_current_span)�
TraceState)�
Attributesc @ s( e Zd ZdZdZdZdd� Zdd� ZdS ) �Decisionr � � c C s | t jt jfv S �N)r � RECORD_ONLY�RECORD_AND_SAMPLE��self� r �Y/opt/nydus/tmp/pip-target-wkfpz8uv/lib64/python/mysql/opentelemetry/sdk/trace/sampling.py� is_recording� s zDecision.is_recordingc C s
| t ju S r )r r r r r r �
is_sampled� s zDecision.is_sampledN)�__name__�
__module__� __qualname__�DROPr r r r r r r r r � s
r c @ s4 e Zd ZdZed�dd�Zd edddd�d d
�ZdS ) �SamplingResulta� A sampling result as applied to a newly-created Span.
Args:
decision: A sampling decision based off of whether the span is recorded
and the sampled flag in trace flags in the span context.
attributes: Attributes to add to the `mysql.opentelemetry.trace.Span`.
trace_state: The tracestate used for the `mysql.opentelemetry.trace.Span`.
Could possibly have been modified by the sampler.
��returnc C s( t | �j� dt| j�� dt| j�� d�S )N�(z
, attributes=�))�typer �str�decision�
attributesr r r r �__repr__� s zSamplingResult.__repr__Nr
r )r% r& � trace_stater c C s. || _ |d u rti �| _n
t|�| _|| _d S r )r% r r& r( )r r% r& r( r r r �__init__� s
zSamplingResult.__init__)NN)r r r �__doc__r$ r' r r) r r r r r � s
��r c @ sL e Zd Zejd ed eeee e
d ddd�dd��Z ejed �d
d ��Z dS )
�SamplerNr r r r ��parent_context�trace_id�name�kindr& �linksr( r c C s d S r r �r r- r. r/ r0 r& r1 r( r r r �
should_sample� s zSampler.should_sampler c C s d S r r r r r r �get_description� s zSampler.get_description)NNNN)
r r r �abc�abstractmethodr �intr$ r
r
r r3 r4 r r r r r+ � s" �� r+ c
@ sR e Zd ZdZdd�dd�Zded eeee e
d d d
d �d d
�Z ed�dd�Z dS )�
StaticSamplerz.Sampler that always returns the same decision.r )r% c C s
|| _ d S r )� _decision)r r% r r r r) � s zStaticSampler.__init__Nr r r r r, c C s" | j tju rd }t| j |t|��S r )r9 r r r �_get_parent_trace_stater2 r r r r3 � s
�zStaticSampler.should_sampler c C s | j tju rdS dS )NZAlwaysOffSamplerZAlwaysOnSampler)r9 r r r r r r r4 � s z StaticSampler.get_description)NNNN)
r r r r* r) r r7 r$ r
r
r r3 r4 r r r r r8 � s" �� r8 c
@ s� e Zd ZdZed�dd�ZdZeeed�dd��Z e
ed �d
d ��Z e
ed �d d
��Z de
d eeeeed ddd�dd�Zed �dd�ZdS )�TraceIdRatioBasedz�
Sampler that makes sampling decisions probabilistically based on `rate`.
Args:
rate: Probability (between 0 and 1) that a span will be sampled
��ratec C s0 |dk s|dkrt d��|| _| �| j�| _d S )Ng � �?z(Probability must be in range [0.0, 1.0].)�
ValueError�_rate�get_bound_for_rate�_bound)r r= r r r r) s zTraceIdRatioBased.__init__l ���� )r= r c C s t || jd �S )Nr )�round�TRACE_ID_LIMIT)�clsr= r r r rA s z$TraceIdRatioBased.get_bound_for_rater c C s | j S r �r@ r r r r r= s zTraceIdRatioBased.ratec C s | j S r )rB r r r r �bound s zTraceIdRatioBased.boundNr r r r r, c C s: t j}|| j@ | jk r t j}|t ju r*d }t||t|��S r )r r rD rG r r r: ) r r- r. r/ r0 r& r1 r( r% r r r r3 s
�z TraceIdRatioBased.should_samplec C s d| j � d�S )NzTraceIdRatioBased{�}rF r r r r r4 1 s z!TraceIdRatioBased.get_description)NNNN)r r r r* �floatr) rD � classmethodr7 rA �propertyr= rG r r$ r
r
r r3 r4 r r r r r; � s0 �� r; c
@ s^ e Zd ZdZeeeefeeeeed�dd�Zded e e
e e e
d dd d
�d d �Zd
d� ZdS )� ParentBasedaE
If a parent is set, applies the respective delegate sampler.
Otherwise, uses the root provided at initialization to make a
decision.
Args:
root: Sampler called for spans with no parent (root spans).
remote_parent_sampled: Sampler called for a remote sampled parent.
remote_parent_not_sampled: Sampler called for a remote parent that is
not sampled.
local_parent_sampled: Sampler called for a local sampled parent.
local_parent_not_sampled: Sampler called for a local parent that is
not sampled.
)�root�remote_parent_sampled�remote_parent_not_sampled�local_parent_sampled�local_parent_not_sampledc C s" || _ || _|| _|| _|| _d S r )�_root�_remote_parent_sampled�_remote_parent_not_sampled�_local_parent_sampled�_local_parent_not_sampled)r rM rN rO rP rQ r r r r) E s
zParentBased.__init__Nr r r r r, c
C sj t |��� }| j} |d urT|jrT|jr>|jjr6| j} qT| j} n|jjrN| j } n| j
} | j ||||||d�S )N)r- r. r/ r0 r& r1 ) r �get_span_contextrR �is_validZ is_remoteZ trace_flagsZsampledrS rT rU rV r3 )
r r- r. r/ r0 r& r1 r( �parent_span_contextZsamplerr r r r3 S s$
�zParentBased.should_samplec C sB d| j �� � d| j�� � d| j�� � d| j�� � d| j�� � d� S )NzParentBased{root:z,remoteParentSampled:z,remoteParentNotSampled:z,localParentSampled:z,localParentNotSampled:rH )rR r4 rS rT rU rV r r r r r4 v s zParentBased.get_description)NNNN)r r r r* � ALWAYS_ON�
ALWAYS_OFFr+ r) r r7 r$ r
r
r r3 r4 r r r r rL 5 s6 �� �� #rL c s& e Zd ZdZed�� fdd� Z� ZS )�ParentBasedTraceIdRatioz�
Sampler that respects its parent span's sampling decision, but otherwise
samples probabalistically based on `rate`.
r< c s t |d�}t� j|d� d S )Nr< )rM )r; �superr) )r r= rM �� __class__r r r) � s
z ParentBasedTraceIdRatio.__init__)r r r r* rI r) �
__classcell__r r r^ r r\ � s r\ c s e Zd Z� fdd�Z� ZS )�
_AlwaysOffc s t � �tj� d S r )r] r) r r �r �_r^ r r r) � s z_AlwaysOff.__init__�r r r r) r` r r r^ r ra � s ra c s e Zd Z� fdd�Z� ZS )� _AlwaysOnc s t � �tj� d S r )r] r) r r rb r^ r r r) � s z_AlwaysOn.__init__rd r r r^ r re � s re c s e Zd Z� fdd�Z� ZS )�_ParentBasedAlwaysOffc s t � �t� d S r )r] r) r[ rb r^ r r r) � s z _ParentBasedAlwaysOff.__init__rd r r r^ r rf � s rf c s e Zd Z� fdd�Z� ZS )�_ParentBasedAlwaysOnc s t � �t� d S r )r] r) rZ rb r^ r r r) � s z _ParentBasedAlwaysOn.__init__rd r r r^ r rg � s rg )Z always_onZ
always_off�parentbased_always_onZparentbased_always_off� traceidratio�parentbased_traceidratior c C s| t �td��� } | tvr(t�d| � d} | dv rtztt �t��}W n$ t t
fyf t�d� d}Y n0 t| |�S t| S )Nrh z Couldn't recognize sampler %s.)ri rj z.Could not convert TRACES_SAMPLER_ARG to float.r> ) �os�getenvr �lower�_KNOWN_SAMPLERS�_logger�warningrI r r? � TypeError)Z
trace_samplerr= r r r �_get_from_env_or_default� s
rr r c C s$ t | ��� }|d u s|js d S |jS r )r rW rX r( )r- rY r r r r: � s r: )0r* r5 �enumrk �loggingr �typesr �typingr r Zmysql.opentelemetry.contextr Z-mysql.opentelemetry.sdk.environment_variablesr r Zmysql.opentelemetry.tracer r
r Z mysql.opentelemetry.trace.spanr Z mysql.opentelemetry.util.typesr
r ro �Enumr r �ABCr+ r8 r r[ r rZ r; rL Z DEFAULT_OFFZ
DEFAULT_ONr\ ra re rf rg rn rr r: r r r r �<module> sH w
7E �