2ix v%SrSSKrSSKJrJr SSKJr SSKJr SSK J r SSK J r SSK JrJrJrJrJrJr SS KJr SS KJrJrJrJrJrJrJrJrJrJ r J!r!J"r"J#r#J$r$J%r%J&r&J'r'J(r(J)r)J*r*J+r+J,r,J-r- SS K.J/r/ SS K0J1r1 SS K2J3r3 \"\45r5\\'\)\(\*\+\,\-4r6"SS\5r7"SS\75r8"SS\75r9\"SS55r:"SS\5r;"SS\;5r<"SS\;5r=\/"5r>Sq?\\7\@S'\9"5rAS(S\BS\BS\\7S \\BS!\\3S"S4 S#jjrCS\7S$\DS"S4S%jrES\7S"S4S&jrFS"\74S'jrGg))a The OpenTelemetry metrics API describes the classes used to generate metrics. The :class:`.MeterProvider` provides users access to the :class:`.Meter` which in turn is used to create :class:`.Instrument` objects. The :class:`.Instrument` objects are used to record measurements. This module provides abstract (i.e. unimplemented) classes required for metrics, and a concrete no-op implementation :class:`.NoOpMeter` that allows applications to use the API package alone without a supporting implementation. To get a meter, you need to provide the package name from which you are calling the meter APIs to OpenTelemetry by calling `MeterProvider.get_meter` with the calling instrumentation name and the version of your package. The following code shows how to obtain a meter using the global :class:`.MeterProvider`:: from opentelemetry.metrics import get_meter meter = get_meter("example-meter") counter = meter.create_counter("example-counter") .. versionadded:: 1.10.0 N)ABCabstractmethod) dataclass) getLogger)environ)Lock)DictListOptionalSequenceUnioncast)OTEL_PYTHON_METER_PROVIDER) CallbackTCounterGauge Histogram NoOpCounter NoOpGauge NoOpHistogramNoOpObservableCounterNoOpObservableGaugeNoOpObservableUpDownCounterNoOpUpDownCounterObservableCounterObservableGaugeObservableUpDownCounter UpDownCounter_MetricsHistogramAdvisory _ProxyCounter _ProxyGauge_ProxyHistogram_ProxyObservableCounter_ProxyObservableGauge_ProxyObservableUpDownCounter_ProxyUpDownCounter)Once)_load_provider) Attributesc \\rSrSrSr\S S\S\\S\\S\\SS 4 S jj5r S r g) MeterProviderbzW MeterProvider is the entry point of the API. It provides access to `Meter` instances. Nnameversion schema_url attributesreturnMetercg)aReturns a `Meter` for use by the given instrumentation library. For any two calls it is undefined whether the same or different `Meter` instances are returned, even for different library names. This function may return different `Meter` types (e.g. a no-op meter vs. a functional meter). Args: name: The name of the instrumenting module. ``__name__`` may not be used as this can result in different meter names if the meters are in different files. It is better to use a fixed string that can be imported where needed and used consistently as the name of the meter. This should *not* be the name of the module that is instrumented but the name of the module doing the instrumentation. E.g., instead of ``"requests"``, use ``"opentelemetry.instrumentation.requests"``. version: Optional. The version string of the instrumenting library. Usually this should be the same as ``importlib.metadata.version(instrumenting_library_name)``. schema_url: Optional. Specifies the Schema URL of the emitted telemetry. attributes: Optional. Attributes that are associated with the emitted telemetry. Nselfr-r.r/r0s b/home/james-whalen/.local/lib/python3.13/site-packages/opentelemetry/metrics/_internal/__init__.py get_meterMeterProvider.get_metergr4NNN) __name__ __module__ __qualname____firstlineno____doc__rstrr r)r8__static_attributes__r4r;r7r+r+bsc"&$(+/ ! ! #! SM ! Z( !  ! ! r;r+c R\rSrSrSrS S\S\\S\\S\\SS 4 S jjrS r g) NoOpMeterProviderzQThe default MeterProvider used when no MeterProvider implementation is available.Nr-r.r/r0r1r2c[XUS9$)zReturns a NoOpMeter.r.r/) NoOpMeterr5s r7r8NoOpMeterProvider.get_meters:FFr;r4r<) r=r>r?r@rArBr r)r8rCr4r;r7rErEs^[ "&$(+/ GG#GSM G Z( G  GGr;rEc j\rSrSrSSjrSS\S\\S\\S\\SS 4 S jjrS \ SS4S jr S r g)_ProxyMeterProviderr1Nc>[5Ul/UlSUlgN)r_lock_meters_real_meter_providerr6s r7__init___ProxyMeterProvider.__init__sV *, =A!r;r-r.r/r0r2cUR URb%URRXU5sSSS5 $[XUS9nURR U5 UsSSS5 $!,(df  g=fNrH)rPrRr8 _ProxyMeterrQappend)r6r-r.r/r0meters r7r8_ProxyMeterProvider.get_metersdZZ((400:::Z  *ME LL   &ZZs)A0&A00 A>meter_providercUR XlURHnURU5 M SSS5 g!,(df  g=frO)rPrRrQon_set_meter_provider)r6r\rZs r7r^)_ProxyMeterProvider.on_set_meter_providers5 ZZ(6 %++N;&ZZs +A A)rPrQrRr1Nr<) r=r>r?r@rTrBr r)r8r+r^rCr4r;r7rLrLshB"&$(+/ #SM  Z(   "r?r@rB__annotations__boolr rrCr4r;r7rbrbsN899r;rbc z^\rSrSrSrSS\S\\S\\SS4U4Sjjjr\S\4S j5r \S\\4S j5r \S\\4S j5r S S\S \ S \S\S\\ S\4 Sjjr\S\S\S \S\S\SS4 Sj5r\S!S\S \S\S\4Sjj5r\S!S\S \S\S\4Sjj5r\S"S\S\\\S \S\S\4 Sjj5r\S!SS.S\S \S\S\\\S\4 Sjjj5rS!S\S \S\S\4Sjjr\S"S\S\\\S \S\S\ 4 Sjj5r!\S"S\S\\\S \S\S\"4 Sjj5r#Sr$U=r%$)#r2zHandles instrument creation. This class provides methods for creating instruments which are then used to produce measurements. Nr-r.r/r1cr>[TU]5 XlX lX0l0Ul[ 5UlgrO)superrT_name_version _schema_url_instrument_idsr_instrument_ids_lockr6r-r.r/ __class__s r7rTMeter.__init__s9   %  %)F!r;cUR$)z' The name of the instrumenting module. )rnrSs r7r- Meter.names zzr;cUR$)z2 The version string of the instrumenting library. )rorSs r7r. Meter.versions }}r;cUR$)z3 Specifies the Schema URL of the emitted telemetry )rprSs r7r/Meter.schema_urls r;type_unit descriptionadvisorycTSRUR5R5URX4/5nSnSnSn UR X`R ;nU(aUR Un X:gnOXPR U'SSS5 [ UUUU S9$!,(df  N=f)a Register an instrument with the name, type, unit and description as identifying keys and the advisory as value. Returns a tuple. The first value is the instrument id. The second value is an `_InstrumentRegistrationStatus` where `already_registered` is `True` if the instrument has been registered already. If `conflict` is set to True the `current_advisory` attribute contains the registered instrument advisory. ,FN)rdrerfrg)joinstriplowerr=rrrqrb) r6r-r|r}r~rrdrerfrgs r7_register_instrumentMeter._register_instruments( ZZ\   !5>>4 E #  & &!.2F2F!F !#'#7#7 #F +76>$$]3'-'1-   ' &s 8B B'instrumentation_typestatuscL[RSUUUUUR5 g)NzAn instrument with name %s, type %s, unit %s and description %s has been created already with a different advisory value %s and will be used instead.)_loggerwarningrg)r-rr}r~rs r7%_log_instrument_registration_conflict+Meter._log_instrument_registration_conflicts-  D     # # r;cg)a"Creates a `Counter` instrument Args: name: The name of the instrument to be created unit: The unit for observations this instrument reports. For example, ``By`` for bytes. UCUM units are recommended. description: A description for this instrument and what it measures. Nr4r6r-r}r~s r7create_counterMeter.create_counter*r:r;cg)a)Creates an `UpDownCounter` instrument Args: name: The name of the instrument to be created unit: The unit for observations this instrument reports. For example, ``By`` for bytes. UCUM units are recommended. description: A description for this instrument and what it measures. Nr4rs r7create_up_down_counterMeter.create_up_down_counter:r:r; callbackscg)a9Creates an `ObservableCounter` instrument An observable counter observes a monotonically increasing count by calling provided callbacks which accept a :class:`~opentelemetry.metrics.CallbackOptions` and return multiple :class:`~opentelemetry.metrics.Observation`. For example, an observable counter could be used to report system CPU time periodically. Here is a basic implementation:: def cpu_time_callback(options: CallbackOptions) -> Iterable[Observation]: observations = [] with open("/proc/stat") as procstat: procstat.readline() # skip the first line for line in procstat: if not line.startswith("cpu"): break cpu, *states = line.split() observations.append(Observation(int(states[0]) // 100, {"cpu": cpu, "state": "user"})) observations.append(Observation(int(states[1]) // 100, {"cpu": cpu, "state": "nice"})) observations.append(Observation(int(states[2]) // 100, {"cpu": cpu, "state": "system"})) # ... other states return observations meter.create_observable_counter( "system.cpu.time", callbacks=[cpu_time_callback], unit="s", description="CPU time" ) To reduce memory usage, you can use generator callbacks instead of building the full list:: def cpu_time_callback(options: CallbackOptions) -> Iterable[Observation]: with open("/proc/stat") as procstat: procstat.readline() # skip the first line for line in procstat: if not line.startswith("cpu"): break cpu, *states = line.split() yield Observation(int(states[0]) // 100, {"cpu": cpu, "state": "user"}) yield Observation(int(states[1]) // 100, {"cpu": cpu, "state": "nice"}) # ... other states Alternatively, you can pass a sequence of generators directly instead of a sequence of callbacks, which each should return iterables of :class:`~opentelemetry.metrics.Observation`:: def cpu_time_callback(states_to_include: set[str]) -> Iterable[Iterable[Observation]]: # accept options sent in from OpenTelemetry options = yield while True: observations = [] with open("/proc/stat") as procstat: procstat.readline() # skip the first line for line in procstat: if not line.startswith("cpu"): break cpu, *states = line.split() if "user" in states_to_include: observations.append(Observation(int(states[0]) // 100, {"cpu": cpu, "state": "user"})) if "nice" in states_to_include: observations.append(Observation(int(states[1]) // 100, {"cpu": cpu, "state": "nice"})) # ... other states # yield the observations and receive the options for next iteration options = yield observations meter.create_observable_counter( "system.cpu.time", callbacks=[cpu_time_callback({"user", "system"})], unit="s", description="CPU time" ) The :class:`~opentelemetry.metrics.CallbackOptions` contain a timeout which the callback should respect. For example if the callback does asynchronous work, like making HTTP requests, it should respect the timeout:: def scrape_http_callback(options: CallbackOptions) -> Iterable[Observation]: r = requests.get('http://scrapethis.com', timeout=options.timeout_millis / 10**3) for value in r.json(): yield Observation(value) Args: name: The name of the instrument to be created callbacks: A sequence of callbacks that return an iterable of :class:`~opentelemetry.metrics.Observation`. Alternatively, can be a sequence of generators that each yields iterables of :class:`~opentelemetry.metrics.Observation`. unit: The unit for observations this instrument reports. For example, ``By`` for bytes. UCUM units are recommended. description: A description for this instrument and what it measures. Nr4r6r-rr}r~s r7create_observable_counterMeter.create_observable_counterJr:r;#explicit_bucket_boundaries_advisoryrcg)aBCreates a :class:`~opentelemetry.metrics.Histogram` instrument Args: name: The name of the instrument to be created unit: The unit for observations this instrument reports. For example, ``By`` for bytes. UCUM units are recommended. description: A description for this instrument and what it measures. Nr4)r6r-r}r~rs r7create_histogramMeter.create_histogramr:r;c0[R"S5 g)a"Creates a ``Gauge`` instrument Args: name: The name of the instrument to be created unit: The unit for observations this instrument reports. For example, ``By`` for bytes. UCUM units are recommended. description: A description for this instrument and what it measures. z5create_gauge() is not implemented and will be a no-opN)warningswarnrs r7 create_gaugeMeter.create_gauges  MNr;cg)aCreates an `ObservableGauge` instrument Args: name: The name of the instrument to be created callbacks: A sequence of callbacks that return an iterable of :class:`~opentelemetry.metrics.Observation`. Alternatively, can be a generator that yields iterables of :class:`~opentelemetry.metrics.Observation`. unit: The unit for observations this instrument reports. For example, ``By`` for bytes. UCUM units are recommended. description: A description for this instrument and what it measures. Nr4rs r7create_observable_gaugeMeter.create_observable_gauger:r;cg)aCreates an `ObservableUpDownCounter` instrument Args: name: The name of the instrument to be created callbacks: A sequence of callbacks that return an iterable of :class:`~opentelemetry.metrics.Observation`. Alternatively, can be a generator that yields iterables of :class:`~opentelemetry.metrics.Observation`. unit: The unit for observations this instrument reports. For example, ``By`` for bytes. UCUM units are recommended. description: A description for this instrument and what it measures. Nr4rs r7!create_observable_up_down_counter'Meter.create_observable_up_down_counterr:r;)rqrrrnrproNNrOrNrr)&r=r>r?r@rArBr rTpropertyr-r.r/typerrbr staticmethodrrrrrrr rrrfloatrrrrrrrrrC __classcell__rts@r7r2r2sh"&$( + +# +SM +  + +c #  HSM  9= * * *  *  * 45 *  '* X  !    .     $                        48 ^ ^ HY/0^  ^  ^  ^ ^ @  JN      .6huo-F     ( OOO O  O 48   HY/0        &48   HY/0     !   r;r2c ^\rSrSrSS\S\\S\\SS4U4SjjjrS\SS4S jrSS\S \S \S\ 4S jjr SS\S \S \S\ 4S jjr SS\S\\ \S \S \S\4 SjjrSSS.S\S \S \S\\ \S\4 SjjjrSS\S \S \S\4SjjrSS\S\\ \S \S \S\4 SjjrSS\S\\ \S \S \S\4 SjjrSrU=r$)rXiNr-r.r/r1c\>[TU]XUS9 [5Ul/UlSUlgrW)rmrTrrP _instruments _real_meterrss r7rT_ProxyMeter.__init__s0 :FV 57,0r;r\cURURURUR5nUR X lUR HnURU5 M SSS5 g!,(df  g=f)zCalled when a real meter provider is set on the creating _ProxyMeterProvider Creates a real backing meter for this instance and notifies all created instruments so they can create real backing instruments. N)r8rnrorprPrr on_meter_set)r6r\ real_meter instruments r7r^!_ProxyMeter.on_set_meter_providersb $-- JJ t'7'7 ZZ) #// '' 30 ZZs +A22 Br}r~cUR UR(a%URRXU5sSSS5 $[XU5nURR U5 UsSSS5 $!,(df  g=frO)rPrrr rrYr6r-r}r~proxys r7r_ProxyMeter.create_counters` ZZ''66t;OZ"$k:E    $ $U + ZZ-A6(A66 BcUR UR(a%URRXU5sSSS5 $[XU5nURR U5 UsSSS5 $!,(df  g=frO)rPrrr&rrYrs r7r"_ProxyMeter.create_up_down_counter sc ZZ''>> Z (K@E    $ $U +ZZrrc UR UR(a%URRXX45sSSS5 $[XX4S9nURR U5 UsSSS5 $!,(df  g=fNr}r~)rPrrr#rrYr6r-rr}r~rs r7r%_ProxyMeter.create_observable_counter/shZZ''AATZ ,dE    $ $U +ZZ-A4&A44 BrrcUR UR(a%URRUUUUS9sSSS5 $[XX45nURR U5 UsSSS5 $!,(df  g=f)Nr)rPrrr"rrY)r6r-r}r~rrs r7r_ProxyMeter.create_histogramAstZZ''888[ 9Z$KE    $ $U +ZZrcUR UR(a%URRXU5sSSS5 $[XU5nURR U5 UsSSS5 $!,(df  g=frO)rPrrr!rrYrs r7r_ProxyMeter.create_gaugeWs` ZZ''44TMZ K8E    $ $U + ZZrc UR UR(a%URRXX45sSSS5 $[XX4S9nURR U5 UsSSS5 $!,(df  g=fr)rPrrr$rrYrs r7r#_ProxyMeter.create_observable_gaugedshZZ''??TZ *dE    $ $U +ZZrcUR UR(a'URRUUUU5sSSS5 $[XX4S9nURR U5 UsSSS5 $!,(df  g=fr)rPrrr%rrYrs r7r-_ProxyMeter.create_observable_up_down_countervsoZZ''II Z2dE    $ $U +ZZs/A6&A66 B)rrPrrrr)r=r>r?r@rBr rTr+r^rrrrr rrrrrrrrrrrrrCrrs@r7rXrXs$"&$( 1 1# 1SM 1  1 14M4d4(             $48 HY/0     *  JN   .6huo-F  2       48 HY/0     *48 HY/0    ! r;rXc T\rSrSrSrSS\S\S\S\4SjjrSS\S\S\S\4Sjjr SS\S\S\S\ 4S jjr SS\S \ \ \S\S\S\4 S jjrSS S .S\S\S\S\ \ \S\4 SjjjrSS\S \ \ \S\S\S\4 SjjrSS\S \ \ \S\S\S\4 SjjrSrg )rIiz]The default Meter used when no Meter implementation is available. All operations are no-op. r-r}r~r1cURU[X#5nUR(a#URU[R UUU5 [XUS9$)zReturns a no-op Counter.r)rrrfrrr=r6r-r}r~rs r7rNoOpMeter.create_countersV** +t  ??  6 6    4 DDr;cURU[X#5nUR(a#URU[R UUU5 [XUS9$)zReturns a no-op Gauge.r)rrrfrrr=rs r7rNoOpMeter.create_gaugesO**4DN ??  6 6  kBBr;cURU[X#5nUR(a#URU[R UUU5 [XUS9$)zReturns a no-op UpDownCounter.r)rrrfrrr=rs r7r NoOpMeter.create_up_down_countersW** #T  ??  6 6&&  !kJJr;NrcURU[X45nUR(a#URU[R UUU5 [UUUUS9$)z"Returns a no-op ObservableCounter.r)rrrfrrr=r6r-rr}r~rs r7r#NoOpMeter.create_observable_countersc** '  ??  6 6!**  %  #   r;rrc URU[UU[US95nUR(a#UR U[ R UUU5 [UUUUS9$)zReturns a no-op Histogram.)explicit_bucket_boundaries)r}r~r)rrrrfrrr=)r6r-r}r~rrs r7rNoOpMeter.create_histogramsr**     %+N    ??  6 6""   #0S   r;cURU[X45nUR(a#URU[R UUU5 [UUUUS9$)z Returns a no-op ObservableGauge.r)rrrfrrr=rs r7r!NoOpMeter.create_observable_gaugesc** %t  ??  6 6((  #  #   r;cURU[X45nUR(a#URU[R UUU5 [UUUUS9$)z(Returns a no-op ObservableUpDownCounter.r)rrrfrrr=rs r7r+NoOpMeter.create_observable_up_down_counter"sc** -t  ??  6 6'00  +  #   r;r4rr)r=r>r?r@rArBrrrrrrr r rrrrrrrrrrrCr4r;r7rIrIs EEE E  E0 CCC C  C* KKK K  K.48   HY/0       :  JN      .6huo-F    H48   HY/0       :48   HY/0     !   r;rI_METER_PROVIDERr-r.r\r/r0r1c@Uc [5nURXX45$)zReturns a `Meter` for use by the given instrumentation library. This function is a convenience wrapper for `opentelemetry.metrics.MeterProvider.get_meter`. If meter_provider is omitted the current configured one is used. )get_meter_providerr8)r-r.r\r/r0s r7r8r8Bs%+-  # #D: JJr;logc^SU4Sjjn[RU5nU(aU(d[RS5 ggg)Nc4>Tq[RT5 grO)r_PROXY_METER_PROVIDERr^r\sr7set_mp#_set_meter_provider..set_mpVs( 33NCr;z2Overriding of current MeterProvider is not allowedr`)_METER_PROVIDER_SET_ONCEdo_oncerr)r\rrdid_sets` r7_set_meter_providerrUs4D'..v6G 7LMsr;c[USS9 g)zSets the current global :class:`~.MeterProvider` object. This can only be done once, a warning will be logged if any further attempt is made. TrN)rrs r7set_meter_providerrcs D1r;c[c.[[;a[$[ [S5n[ USS9 [ S[5$)z8Gets the current global :class:`~.MeterProvider` object.r\Frr+)rrrrr(rrrs r7rrlsC %W 4( ((6 &(8)  N6  11r;)rNNN)HrArabcrr dataclassesrloggingrosr threadingrtypingr r r r r r#opentelemetry.environment_variablesr*opentelemetry.metrics._internal.instrumentrrrrrrrrrrrrrrrrr r!r"r#r$r%r&opentelemetry.util._oncer'opentelemetry.util._providersr(opentelemetry.util.typesr)r=r_ProxyInstrumentTr+rErLrbr2rXrIrrrhrrBr8rirrrr4r;r7rs"4#!>>J2*8 H ! ' C' T G G<-<< :: :s Cs l S%Sln n b 6+/-(/+- .2 $'+ K K K]+K K $ K  K& N ND NT N2}22 2M 2r;