gAbdZddlZddlZddlZddlmZddlmZddlm Z m Z ddl m Z ddl mZmZddlmZmZmZdd lmZdd lmZeeZGd d ej4ZGd dZGddej:ZGddeZeej@Z! eejDZ# GddeZ$GddeZ%e%e!Z& e%e#Z' Gdde%Z(GddeZ)GddeZ*Gdde%Z+Gdd e%Z,e#e!e'e&e$e(d!Z-d"efd#Z.d$e e d"e d%fd&Z/y)'a For general information about sampling, see `the specification `_. 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 `_). 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 `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 `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 opentelemetry.sdk.trace import TracerProvider from opentelemetry.sdk.trace.export import ( ConsoleSpanExporter, SimpleSpanProcessor, ) from 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 probabilistically 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 probabilistically 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 opentelemetry.sdk.trace import TracerProvider from 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 def 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)OptionalSequence)Context)OTEL_TRACES_SAMPLEROTEL_TRACES_SAMPLER_ARG)LinkSpanKindget_current_span) TraceState) Attributesc$eZdZdZdZdZdZdZy)DecisionrcF|tjtjfvSN)r RECORD_ONLYRECORD_AND_SAMPLEselfs U/var/www/openai/venv/lib/python3.12/site-packages/opentelemetry/sdk/trace/sampling.py is_recordingzDecision.is_recordings,,h.H.HIIIc&|tjuSr)rrrs r is_sampledzDecision.is_sampledsx1111rN)__name__ __module__ __qualname__DROPrrrrrrrrs DKJ2rrc @eZdZdZdefdZ d deddded ddfd Zy) SamplingResultaA 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 `opentelemetry.trace.Span`. trace_state: The tracestate used for the `opentelemetry.trace.Span`. Could possibly have been modified by the sampler. returnct|jdt|jdt|jdS)N(z , attributes=))typerstrdecision attributesrs r__repr__zSamplingResult.__repr__s;t*%%&aDMM(:';=T__I]H^^_``rNr+r,r trace_stater ct||_|ti|_||_yt||_||_yr)r+rr,r.)rr+r,r.s r__init__zSamplingResult.__init__s= !  .r2DO'/z:DO&r)NN) rrr __doc__r*r-rrr0r"rrr$r$sMa#a $(.2 ' '! 'l+ '  'rr$ceZdZej ddeddededeede dee d d ed d d fdZ ejd efdZ y)SamplerNparent_contextrtrace_idnamekindr,linksr r.r r%r$cyrr"rr4r5r6r7r,r8r.s r should_samplezSampler.should_samples rcyrr"rs rget_descriptionzSampler.get_descriptions rNNNN) rrr abcabstractmethodrintr*r rrr;r=r"rrr3r3s $(!%,0.2   +      x    ()  l+           rr3cteZdZdZddZ ddeddeded eed e d ee d d edddfdZ defdZ y) StaticSamplerz.Sampler that always returns the same decision.r%Nc||_yr) _decision)rr+s rr0zStaticSampler.__init__s !rr4rr5r6r7r,r8r r.r r$c~|jtjurd}t|j|t |Sr)rErr!r$_get_parent_trace_stater:s rr;zStaticSampler.should_samples8 >>X]] *J NN  #N 3  rc>|jtjuryy)NAlwaysOffSamplerAlwaysOnSampler)rErr!rs rr=zStaticSampler.get_descriptions >>X]] *% r)r+rr%Nr>) rrr r1r0rrAr*r rrr;r=r"rrrCrCs8"$(!%,0.2  +    x    () l+   $!!rrCceZdZdZdefdZdZededefdZ e defdZ e defdZ dd e d d ed ede edede edde dddfdZdefdZy )TraceIdRatioBasedz Sampler that makes sampling decisions probabilistically based on `rate`. Args: rate: Probability (between 0 and 1) that a span will be sampled ratec||dks|dkDr td||_|j|j|_y)Ng?z(Probability must be in range [0.0, 1.0].) ValueError_rateget_bound_for_rate_bound)rrMs rr0zTraceIdRatioBased.__init__s8 #:GH H --djj9 rlr%c8t||jdzzS)Nr)roundTRACE_ID_LIMIT)clsrMs rrRz$TraceIdRatioBased.get_bound_for_ratesTS//!3455rc|jSrrQrs rrMzTraceIdRatioBased.rates zzrc|jSr)rSrs rboundzTraceIdRatioBased.bounds {{rNr4rr5r6r7r,r8r r.r r$ctj}||jz|jkrtj}|tjurd}t ||t |Sr)rr!rVr[rr$rG) rr4r5r6r7r,r8r.r+s rr;zTraceIdRatioBased.should_samples[== d)) )DJJ 611H x}} $J   #N 3  rc"d|jdS)NzTraceIdRatioBased{}rYrs rr=z!TraceIdRatioBased.get_description1s$TZZL33rr>)rrr r1floatr0rV classmethodrArRpropertyrMr[rr*r rrr;r=r"rrrLrLs:U:#N6e666es$(!%,0.2  +    x    () l+   *44rrLceZdZdZeeeefdededededef dZ dd ed d e d e d ee de dee ddedddfdZdZy) 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. rootremote_parent_sampledremote_parent_not_sampledlocal_parent_sampledlocal_parent_not_sampledcJ||_||_||_||_||_yr)_root_remote_parent_sampled_remote_parent_not_sampled_local_parent_sampled_local_parent_not_sampled)rrdrerfrgrhs rr0zParentBased.__init__Es+ &;#*C'%9")A&rNr4rr5r6r7r,r8r r.r r%r$clt|j}|j} |w|jrk|jr0|j j r |j} n<|j} n/|j j r |j} n |j} | j||||||S)N)r4r5r6r7r,r8) r get_span_contextrjis_valid is_remote trace_flagssampledrkrlrmrnr;) rr4r5r6r7r,r8r.parent_span_contextsamplers rr;zParentBased.should_sampleSs/     **  */B/K/K",,&22::"99G"==G&22::"88G"<$>$@#AAVW[WrWrXCXCXEWFF^_c_~_~_N_N_P^QQefjf@f@fPfPfReSSjkokIkIkYkYk[j\\^_ _rr>)rrr r1 ALWAYS_ON ALWAYS_OFFr3r0rrAr*r rrr;r=r"rrrcrc5s $*3-7(1,6 B B ' B$+ B & B #* B&$(!%,0.2#  +# #  # x #  # ()# l+#  # J_rrcc(eZdZdZdeffd ZxZS)ParentBasedTraceIdRatioz Sampler that respects its parent span's sampling decision, but otherwise samples probabilistically based on `rate`. rMc>t|}t| |y)N)rM)rd)rLsuperr0)rrMrd __class__s rr0z ParentBasedTraceIdRatio.__init__s d+ d#r)rrr r1r_r0 __classcell__r~s@rr{r{s $U$$rr{ceZdZfdZxZS) _AlwaysOffc@t|tjyr)r}r0rr!r_r~s rr0z_AlwaysOff.__init__s 'rrrr r0rrs@rrrs ((rrceZdZfdZxZS) _AlwaysOnc@t|tjyr)r}r0rrrs rr0z_AlwaysOn.__init__s 334rrrs@rrrs 55rrceZdZfdZxZS)_ParentBasedAlwaysOffc,t|tyr)r}r0ryrs rr0z_ParentBasedAlwaysOff.__init__s $rrrs@rrrs %%rrceZdZfdZxZS)_ParentBasedAlwaysOnc,t|tyr)r}r0rxrs rr0z_ParentBasedAlwaysOn.__init__s #rrrs@rrrs $$rr) always_on always_offparentbased_always_onparentbased_always_off traceidratioparentbased_traceidratior%cftjtdj}|tvrt j d|d}|dvr1 ttjt}t ||St|S#ttf$rt j dd}Y?wxYw)NrzCouldn't recognize sampler %s.)rrz.Could not convert TRACES_SAMPLER_ARG to float.rO) osgetenvrlower_KNOWN_SAMPLERS_loggerwarningr_r rP TypeError) trace_samplerrMs r_get_from_env_or_defaultrsII4 egO+8-H/ DD #:;:KKM"*=*F*F  * **r)0r1r?enumrloggingrtypesrtypingrropentelemetry.contextr'opentelemetry.sdk.environment_variablesrr opentelemetry.tracer r r opentelemetry.trace.spanr opentelemetry.util.typesrrrEnumrr$ABCr3rCr!ryrrxrLrc DEFAULT_OFF DEFAULT_ONr{rrrrrrrGr"rrrs[vp "%*A@// H  2tyy 2''8 cgg &!G!<8== ) Z (44 5 [4444nD_'D_N*% ]  # ^$k$(( 5 5 %K% $;$ ')% 7 *'*&+W%+ l+r