Mh`kddlZddlmZddlZddlZddlmZmZmZm Z m Z m Z m Z m Z mZmZmZmZddlZddlmZddlmZmZmZddlmZddlmZmZmZdd lm Z m!Z!dd l"m#Z#m$Z$dd l%m&Z&m'Z'm(Z(ed d Z)ededefZ*dZ+de,fdZ-e-a.dZ/dZ0Gdd eZ1Gdde1Z2Gdde1Z3Gdde1Z4Gdde1Z5Gdd e1Z6Gd!d"e1Z7dS)#N)Lock) AnyCallableDictIterableListLiteralOptionalSequenceTupleTypeTypeVarUnion)values)ExceptionCounterInprogressTrackerTimer)Metric) CollectorCollectorRegistryREGISTRY)ExemplarSample)floatToGoStringINF)_validate_exemplar_validate_labelnames_validate_metric_nameTMetricWrapperBase)boundF.c|stdd}|r||dzz }|r||dzz }||z }|dkr|dr |dd}|r |d|zs|d|zz }|r|dvrtd|z|S) NzMetric name should not be empty_counter_totali)infostatesetz2Metric name is of a type that cannot have a unit: ) ValueErrorendswith) metric_typename namespace subsystemunit full_names Y/var/www/html/test/jupyter/venv/lib/python3.11/site-packages/prometheus_client/metrics.py_build_full_namer4s <:;;;I%Y_$ %Y_$  IiI$6$6x$@$@crcN   I&&sTz22 S4Z  [ 333MPYYZZZ returncjtjdddvS)N!PROMETHEUS_DISABLE_CREATED_SERIESFalse)true1t)osenvirongetlowerr5r3_get_use_createdrB,s+ :>>=w G G M M O OWi iir5c dadS)zJDisable exporting _created metrics on counters, histograms, and summaries.FN _use_createdrAr5r3disable_created_metricsrF3s LLLr5c dadS)zIEnable exporting _created metrics on counters, histograms, and summaries.TNrDrAr5r3enable_created_metricsrH9s LLLr5ceZdZUdZeeed<dZeeed<dZ dZ dZ dZ d e efd Zd e efd Zd efd Zd efd Zddddedfdededede ededededeedeeed dfdZdededed efdZded dfdZd"dZd e efdZd e efdZd e efd Zd!ZdS)#r!N_typerA_reserved_labelnamesc.|j p |jo|jSN _labelnames _labelvaluesselfs r3_is_observablez MetricWrapperBase._is_observableCs ##O(8(NT=NOr5cv|s$tdt|jzdS)Nz!%s metric is missing label values)rSr+strrJrQs r3_raise_if_not_observablez*MetricWrapperBase._raise_if_not_observableIsA""$$ T@3tz??RSS S T Tr5c |jo|j SrMrNrQs r3 _is_parentzMetricWrapperBase._is_parentPs9(9$99r5cNt|j|j|j|jSrM)r_name_documentationrJ_unitrQs r3 _get_metriczMetricWrapperBase._get_metricSsdj$"5tz4:NNNr5r6c,|gSrM)r]rQs r3describezMetricWrapperBase.describeVs  ""##r5c |}|D]+\}}}}}}||j|z|||||,|gSrM)r]_samples add_samplerZ)rRmetricsuffixlabelsvalue timestampexemplarnative_histogram_values r3collectzMetricWrapperBase.collectYsn!!##RVR_R_RaRa o o NFFE9h8N   dj6165)XWm n n n nxr5c$|jd|jS)N:)rJrZrQs r3__str__zMetricWrapperBase.__str___s*++tz+++r5cTt|}|jd|jd|jdS)N.())type __module____name__rZ)rRr-s r3__repr__zMetricWrapperBase.__repr__bs44jj (OO;+?OO$*OOOOr5r%rRr. documentation labelnamesr/r0r1registryrPc t|j|||||_t|||_t |pd|_i|_||_||_ t|j| rt|_ i|_|r||js|r||dSdSdS)NrA)r4rJrZrrOtuplerP_kwargsr[r\rrXr_lock_metricsrS _metric_initregister) rRr.rvrwr/r0r1rxrPs r3__init__zMetricWrapperBase.__init__fs&dj$ 9dSS /jAA!,"4"55') + dj))) ??   7DJ46DM            ( (!!$''''' ( ( ( (r5 labelvalues labelkwargsc |jstd|z|jrHtd|t t |j|j|rrtdrUt t |jkrtdtfd|jD}nMt|t|jkrtdtd|D}|j 5||j vr4|j |j f|j |j|j|d|j|j |<|j |cd d d S#1swxYwYd S) arReturn the child for the given labelset. All metrics can have labels, allowing grouping of related time series. Taking a counter as an example: from prometheus_client import Counter c = Counter('my_requests_total', 'HTTP Failures', ['method', 'endpoint']) c.labels('get', '/').inc() c.labels('post', '/submit').inc() Labels can also be provided as keyword arguments: from prometheus_client import Counter c = Counter('my_requests_total', 'HTTP Failures', ['method', 'endpoint']) c.labels(method='get', endpoint='/').inc() c.labels(method='post', endpoint='/submit').inc() See the best practices on [naming](http://prometheus.io/docs/practices/naming/) and [labels](http://prometheus.io/docs/practices/instrumentation/#use-labels). ,No label names were set when constructing %sz@{} already has labels set ({}); can not chain calls to .labels()z"Can't pass both *args and **kwargszIncorrect label namesc3BK|]}t|VdSrMrU).0lrs r3 z+MetricWrapperBase.labels..s/NNKN 3 3NNNNNNr5zIncorrect label countc34K|]}t|VdSrMrrrs r3rz+MetricWrapperBase.labels..s(<<1A<<<<<>   C; CABB B  =k""fT-=&>&>>> !8999NNNNT=MNNNNNKK;3t'7#8#888 !8999<< <<<<.s(88qCFF888888r5) r=r>warningswarn UserWarningrOr+rrzr|r})rRrs r3removezMetricWrapperBase.removes@ % 3 37QUWU_7_7_ MX    TKdRSS S8 {  s4#344 4 4JcRVRbNcNcepMqqrr r88K88888 Z / /dm++M+. / / / / / / / / / / / / / / / / / /s<CC"Ccdtjvsdtjvrtjdt|j5i|_ddddS#1swxYwYdS)z$Remove all labelsets from the metricrrzBClearing labels has not been implemented in multi-process mode yetN)r=r>rrrr|r}rQs r3clearzMetricWrapperBase.clears % 3 37QUWU_7_7_ MT   Z  DM                  sAAAcz|r|S|SrM)rX_multi_samples_child_samplesrQs r3razMetricWrapperBase._sampless8 ??   )&&(( (&&(( (r5c #K|j5|j}dddn #1swxYwY|D]\}}t t |j|}|D]N\}}}}} } t|t|t |z||| | VOdSrM) r|r}copyitemslistrrOrarr) rRmetricsrerc series_labelsrd sample_labelsrfrgrhris r3rz MetricWrapperBase._multi_samplessF Z + +m((**G + + + + + + + + + + + + + + +%mmoo L LNFF T%5v!>!>??M]c]l]l]n]n L LY uiCYVT-$}?R?R?T?T:U:U*U%V%VX]_hjruKLLLLLL L L Ls 044c&td|z)Nz*_child_samples() must be implemented by %rNotImplementedErrorrQs r3rz MetricWrapperBase._child_sampless!"NQU"UVVVr5c&td|z)z Initialize the metric object as a child, i.e. when it has labels (if any) set. This is factored as a separate function to allow for deferred initialization. z(_metric_init() must be implemented by %rrrQs r3r~zMetricWrapperBase._metric_inits ""Lt"STTTr5r6N) rtrs __qualname__rJr rU__annotations__rKr rSrVrXr]rrr_rjrmrurr rrrrerrrrarrr~rAr5r3r!r!?sE8C=*,(3-,,,PPP TTT:::OOO$(6*$$$$&) ,,,,,P#PPPP.0"$"$9A9=((q(( #(&c]( (  (  ($$56( ( 6(((((@5.Q5.c5.#5.!5.5.5.5.n/3/4////")(6*)))) L 0LLLLW 0WWWWUUUUUr5ceZdZdZdZddZddedeee e fddfd Z dd Z e fd e eeeeed ffdefd ZdeefdZdS)CounteraA Counter tracks counts of events or running totals. Example use cases for Counters: - Number of requests processed - Number of items that were inserted into a queue - Total amount of data that a system has processed Counters can only go up (and be reset when the process restarts). If your use case can go down, you should use a Gauge instead. An example for a Counter: from prometheus_client import Counter c = Counter('my_failures_total', 'Description of counter') c.inc() # Increment by 1 c.inc(1.6) # Increment by given value There are utilities to count exceptions raised: @c.count_exceptions() def f(): pass with c.count_exceptions(): pass # Count only one type of exception with c.count_exceptions(ValueError): pass You can also reset the counter to zero in case your logical "process" restarts without restarting the actual python process. c.reset() r'r6Nctj|j|j|jdz|j|j|j|_tj|_ dS)Nr() r ValueClassrJrZrOrPr[_valuetime_createdrQs r3r~zCounter._metric_initsK' DJ X@UW[Wg(,(94;NPP   r5ramountrhc&||dkrtd|j||rKt ||jt ||tjdSdS)z&Increment counter by the given amount.rz9Counters can only be incremented by non-negative amounts.N)rVr+rincr set_exemplarrr)rRrrhs r3rz Counter.incs %%''' A::XYY Y   N x ( ( ( K $ $Xh %L%L M M M M M N Nr5cj|jdtj|_dS)zqReset the counter to zero. Use this when a logical process restarts without restarting the actual python process.rN)rsetrrrQs r3resetz Counter.reset(s'   r5 exception.cJ|t||S)zCount exceptions in a block of code or function. Can be used as a function decorator or context manager. Increments the counter when an exception of the given type is raised up out of the code. )rVr)rRrs r3count_exceptionszCounter.count_exceptions-s& %%'''i000r5ctdi|jd|j}tr|tdi|jddfS|fS)Nr(r)rrr? get_exemplarrEr)rRsamples r3rzCounter._child_samples7se"dkoo&7&7t{?W?W?Y?YZZ  z2t}dDAA yr5r)rN)rtrsr__doc__rJr~floatr rrUrr Exceptionrr BaseExceptionr rrrrrrAr5r3rrs$$J E$$$$ NN%NxS#X/GNSWNNNN$$$$ ir11%]0CU4P]K^`cKcEd0d*e1wG1111 0r5rcXeZdZdZdZedZedZddddeddfd e d e d e e d e d e de de e de e e dedffd Zd!dZd"deddfdZd"deddfdZdeddfdZd!dZdefdZdefdZdegefddfdZde efd ZxZS)#GaugeaGauge metric, to report instantaneous values. Examples of Gauges include: - Inprogress requests - Number of items in a queue - Free memory - Total memory - Temperature Gauges can go both up and down. from prometheus_client import Gauge g = Gauge('my_inprogress_requests', 'Description of gauge') g.inc() # Increment by 1 g.dec(10) # Decrement by given value g.set(4.2) # Set to a given value There are utilities for common use cases: g.set_to_current_time() # Set to current unixtime # Increment when entered, decrement when exited. @g.track_inprogress() def f(): pass with g.track_inprogress(): pass A Gauge can also take its value from a callback: d = Gauge('data_objects', 'Number of objects') my_dict = {} d.set_function(lambda: len(my_dict)) gauge) allliveallminliveminmaxlivemaxsumlivesum mostrecentlivemostrecent)rrrAr%Nrr.rvrwr/r0r1rxrPmultiprocess_modec | |_| |jvrtd| zt|||||||||j|jd<|j|jv|_dS)NzInvalid multiprocess mode: r.rvrwr/r0r1rxrPr)_multiprocess_mode_MULTIPROC_MODESr+superrr{_MOST_RECENT_MODES_is_most_recent) rRr.rvrwr/r0r1rxrPrrs r3rzGauge.__init__js#4 D$9 9 9:=NNOO O '!%  -1,C ()#6$:QQr5r6c tj|j|j|j|j|j|j|j|_dS)N)r) rrrJrZrOrPr[rrrQs r3r~zGauge._metric_initsA' J DJ0@$BS  43J    r5rrc|jrtd||j|dS)z$Increment gauge by the given amount.z-inc must not be used with the mostrecent modeNr RuntimeErrorrVrrrRrs r3rz Gauge.incsI   PNOO O %%''' r5c|jrtd||j| dS)z$Decrement gauge by the given amount.z-dec must not be used with the mostrecent modeNrrs r3decz Gauge.decsK   PNOO O %%'''      r5rfc||jr<|jt |t jdS|jt |dS)zSet gauge to the given value.)rgN)rVrrrrr)rRrfs r3rz Gauge.setsi %%'''   * KOOE%LLDIKKO @ @ @ @ @ KOOE%LL ) ) ) ) )r5cR|tjdS)z"Set gauge to the current unixtime.N)rrrQs r3set_to_current_timezGauge.set_to_current_times  r5cH|t|S)zTrack inprogress blocks of code or functions. Can be used as a function decorator or context manager. Increments the gauge when the code is entered, and decrements when it is exited. )rVrrQs r3track_inprogresszGauge.track_inprogresss$ %%''' &&&r5c"t|dS)zTime a block of code or function, and set the duration in seconds. Can be used as a function decorator or context manager. rrrQs r3rz Gauge.times T5!!!r5fc|dtdttffd }t j|||_dS)zCall the provided function to return the Gauge value. The function must return a float, and may be called from multiple threads. All other methods of the Gauge become NOOPs. r&r6cVtditddfSNr%)rr)r&rs r3samplesz#Gauge.set_function..sampless(2r5::tT::< hr5y1 >d > > > >@ 0@@@@@@@@r5rcXeZdZdZdZdgZd dZdeddfdZde fd Z de e fd Z dS) SummaryaA Summary tracks the size and number of events. Example use cases for Summaries: - Response latency - Request size Example for a Summary: from prometheus_client import Summary s = Summary('request_size_bytes', 'Request size (bytes)') s.observe(512) # Observe 512 (bytes) Example for a Summary using time: from prometheus_client import Summary REQUEST_TIME = Summary('response_latency_seconds', 'Response latency (seconds)') @REQUEST_TIME.time() def create_response(request): '''A dummy function''' time.sleep(1) Example for using the same Summary object as a context manager: with REQUEST_TIME.time(): pass # Logic to be timed summaryquantiler6Nc2tj|j|j|jdz|j|j|j|_tj|j|j|jdz|j|j|j|_tj |_ dS)N_count_sum) rrrJrZrOrPr[rrrrrQs r3r~zSummary._metric_inits' DJ X@UW[Wg(,(94;NPP %dj$*dj6>QSWSceievx|yLMM   r5rc||jd|j|dSafObserve the given amount. The amount is usually positive or zero. Negative values are accepted but prevent current versions of Prometheus from properly detecting counter resets in the sum of observations. See https://prometheus.io/docs/practices/histograms/#count-and-sum-of-observations for details. rN)rVrrrrs r3observezSummary.observesD %%'''  fr5c"t|dSzTime a block of code or function, and observe the duration in seconds. Can be used as a function decorator or context manager. rrrQs r3rz Summary.time T9%%%r5c ,tdi|jddtdi|jddg}tr+|tdi|jddt|S)Nrrr)rrr?rrEappendrrz)rRrs r3rzSummary._child_sampless 8R!2!2D$ ? ? 62ty}}d ; ;   N NN6*b$-tLL M M MW~~r5r)rtrsrrrJrKr~rrrrrrrrAr5r3rrs: E&<$$$$ e     &e&&&& 0r5rcZeZdZdZdZdgZdddddd d d d d ddddefZddddedefde de de e de de de de e de e e de eee fffd Zde eee fd dfd!Zd(d"Zd)d#ed$e ee e fd dfd%Zd efd&Zd e efd'ZxZS)* HistogramaA Histogram tracks the size and number of events in buckets. You can use Histograms for aggregatable calculation of quantiles. Example use cases: - Response latency - Request size Example for a Histogram: from prometheus_client import Histogram h = Histogram('request_size_bytes', 'Request size (bytes)') h.observe(512) # Observe 512 (bytes) Example for a Histogram using time: from prometheus_client import Histogram REQUEST_TIME = Histogram('response_latency_seconds', 'Response latency (seconds)') @REQUEST_TIME.time() def create_response(request): '''A dummy function''' time.sleep(1) Example of using the same Histogram object as a context manager: with REQUEST_TIME.time(): pass # Logic to be timed The default buckets are intended to cover a typical web/rpc request from milliseconds to seconds. They can be overridden by passing `buckets` keyword argument to `Histogram`. histogramleg{Gzt?g{Gz?g?g?g333333?g?g?g?g??g@g@g@g$@rAr%Nr.rvrwr/r0r1rxrPbucketsc || t||||||||| |jd<dS)Nrr)_prepare_bucketsrrr{) rRr.rvrwr/r0r1rxrPrrs r3rzHistogram.__init__5sf g&&& '!%  #* Yr5source_bucketsr6cd|D}|t|krtd|r+|dtkr|tt |dkrtd||_dS)Nc,g|]}t|SrA)r)rbs r3 z.Histogram._prepare_buckets..Ns444588444r5zBuckets not in sorted orderzMust have at least two buckets)rr+rrr _upper_bounds)rRr rs r3r zHistogram._prepare_bucketsMs44^444 fWoo % %:;; ;  wr{c)) NN3    w<> >$r5c g|_tj|_|jdz}t j|j|j|jdz|j|j|j |_ |j D]`}|j t j|j|j|jdz||jt|fz|j adS)N)rr_bucket)_bucketsrrrOrrrJrZrPr[rrrr)rRbucket_labelnamesrs r3r~zHistogram._metric_initYs13    ,w6%dj$*dj6>QSWSceievx|yLMM #  A M !2   Y&!!_Q%7%7$99# "%"%      r5rrhc ||j|t|jD]\}}||krt|j|d|rOt ||j|t||tj dSdSr) rVrr enumeraterrrrrr)rRrrhir"s r3rzHistogram.observehs %%''' f!$"455  HAu a $$Q'''[&x000M!$11(8VTY[[2Y2YZZZ   r5c"t|dSrrrQs r3rzHistogram.time|rr5c g}d}t|jD]y\}}||j|z }|t ddt |i|d|j|z|t di|dd|jddkr=|t di|jddtr+|t di|j ddt|S)Ngrrrrrr) rrrr?rrrrrrErrz)rRraccrr"s r3rzHistogram._child_sampless,!$"455 z zHAu 4=#'')) )C NN6)dOE4J4J-KSRVX\XefgXhXuXuXwXwxx y y y yvhCt<<===  a A % % NN6&"dimmootTJJ K K K  N NN6*b$-tLL M M MW~~r5rrM)rtrsrrrJrKrDEFAULT_BUCKETSrrUrr rr rrrr r~rrrrrrrrs@r3rrs!!D E 6S$T2sBS#sTWY]_bcO .0"$"$9A9=8G*** #*&c]* *  *  *$$56* ( 6*#5#45******0 %xeSj8I/J %t % % % %    exS#X/GSW(&e&&&&  0        r5rcTeZdZdZdZdZdeeefddfdZde e fdZ dS) InfoaInfo metric, key-value pairs. Examples of Info include: - Build information - Version information - Potential target metadata Example usage: from prometheus_client import Info i = Info('my_build', 'Description of info') i.info({'version': '1.2.3', 'buildhost': 'foo@bar'}) Info metrics do not work in multiprocess mode. r)clt|j|_t|_i|_dSrM)rrO_labelname_setrr|rrQs r3r~zInfo._metric_inits+!$"233VV  r5valr6Nc|j|r(td|j|t d|Drtd|j5t||_ ddddS#1swxYwYdS)zSet info metric.z8Overlapping labels for Info metric, metric: {} child: {}c3K|]}|duV dSrMrA)rrs r3rzInfo.info..s&//QqDy//////r5zLabel value cannot be NoneN) r! intersectionkeysr+rrOanyrr|rr)rRr"s r3r)z Info.infos   + +CHHJJ 7 7 (W^^ #''(( ( //#**,,/// / / ;9:: : Z $ $s))DK $ $ $ $ $ $ $ $ $ $ $ $ $ $ $ $ $ $sB88B<?B<cv|j5td|jdddfcdddS#1swxYwYdS)N_infor)r|rrrQs r3rzInfo._child_sampless Z D D7DKdDAAC D D D D D D D D D D D D D D D D D Ds .22) rtrsrrrJr~rrUr)rrrrAr5r3rrs E $S#X$4$$$$D 0DDDDDDr5rceZdZdZdZddddeddfdededeed ed ed ed ee d eeedeeeffd Z ddZ deddfdZ de efdZxZS)Enuma`Enum metric, which of a set of states is true. Example usage: from prometheus_client import Enum e = Enum('task_state', 'Description of enum', states=['starting', 'running', 'stopped']) e.state('running') The first listed state will be the default. Enum metrics do not work in multiprocess mode. r*rAr%Nr.rvrwr/r0r1rxrPstatesc t||||||||||vrtd|| std|| x|jd<|_dS)Nrz$Overlapping labels for Enum metric: z$No states provided for Enum metric: r,)rrr+r{_states) rRr.rvrwr/r0r1rxrPr,rs r3rz Enum.__init__s '!%   :  JDJJKK K LJDJJKK K066 Xr5r6c:d|_t|_dS)Nr)rrr|rQs r3r~zEnum._metric_inits VV r5statec||j5|j||_ddddS#1swxYwYdS)zSet enum metric state.N)rVr|r.indexr)rRr0s r3r0z Enum.states %%''' Z 4 4,,,U33DK 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4s A  A A cj5fdtjDcdddS#1swxYwYdS)Nc dg|],\}}tdj|i|jkrdnddd-S)r%rrN)rrZr)rrsrRs r3rz'Enum._child_samples..sTAqrDJ?dk1A1AAAq$PTUUr5)r|rr.rQs`r3rzEnum._child_sampless Z  T\**                  s 6::r)rtrsrrrJrrUr r rrr~r0rrrrrs@r3r+r+s2   E .0"$"$9A9=37777 #7&c]7 7  7  7$$567 ( 67"(3-0777777643444444  0r5r+)8r= threadingrrrtypingrrrrrr r r r r rrrr%rcontext_managersrrr metrics_corerrxrrrrrrutilsrr validationrrrr r#r4boolrBrErFrHr!rrrrrr+rAr5r3r=s  HHHHHHHHHH <<<<<<<<<<%%%%%%%%'''''''' GC*+++ GCxS)***&j$jjjj !!   oUoUoUoUoU oUoUoUdMMMMMMMM`D@D@D@D@D@ D@D@D@NCCCCCCCCL@@@@@!@@@F#D#D#D#D#D #D#D#DL::::: :::::r5