B .l\P@s ddlZddlmZddlZddlZddlmZddlmZm Z m Z ddl m Z m Z mZmZddlmZddlmZmZejd kreZd d Zd d ZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZ GdddeZ!dS)N)Lock)values)ExceptionCounterInprogressTrackerTimer)MetricMETRIC_LABEL_NAME_REMETRIC_NAME_RERESERVED_METRIC_LABEL_NAME_RE)REGISTRY)floatToGoStringINF)cCsd}|r||d7}|r$||d7}||7}|rJ|d|sJ|d|7}|rb|dkrbtd||dkr|dr|dd}|S)N_)infostatesetz2Metric name is of a type that cannot have a unit: counter_totali)endswith ValueError)Z metric_typename namespace subsystemunitZ full_namer8lib/python3.7/site-packages/prometheus_client/metrics.py_build_full_names      rcCs\t|}xN|D]F}t|s(td|t|r>td|||jkrtd|qW|S)NzInvalid label metric name: zReserved label metric name: )tupler matchrr _reserved_labelnames)cls labelnameslrrr_validate_labelnames#s      r%c@seZdZdZdZddZddZddZd d Zd d Z dd d d e dfddZ ddZ ddZ ddZddZddZddZdS)MetricWrapperBaseNrcCs|j p|jo|jS)N) _labelnames _labelvalues)selfrrr_is_observable3sz MetricWrapperBase._is_observablecCs|jo |j S)N)r'r()r)rrr _is_parent9szMetricWrapperBase._is_parentcCst|j|j|j|jS)N)r_name_documentation_type_unit)r)rrr _get_metric<szMetricWrapperBase._get_metriccCs |gS)N)r0)r)rrrdescribe?szMetricWrapperBase.describecCs:|}x*|D]\}}}||j|||qW|gS)N)r0_samplesZ add_sampler,)r)metricsuffixlabelsvaluerrrcollectBszMetricWrapperBase.collectrc Cst|j|||||_t|||_t|p(d|_i|_||_||_ t |jsZt d|j| rpt|_i|_|r||js|r||dS)NrzInvalid metric name: )rr.r,r%r'rr(_kwargsr-r/r r rr+r_lock_metricsr* _metric_initregister) r)r documentationr#rrrregistry labelvaluesrrr__init__Hs   zMetricWrapperBase.__init__c s|jstd||jr6td|tt|j|jf|rFrFtdr~tt|jkrdtdtfdd|jD}n,t|t|jkrtdtdd|D}|jB||j kr|j |j f|j |j|j |d |j|j |<|j |SQRXd 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). z,No label names were set when constructing %sz@%s already has labels set (%s); can not chain calls to .labels()z"Can't pass both *args and **kwargszIncorrect label namesc3s|]}t|VqdS)N)unicode).0r$) labelkwargsrr sz+MetricWrapperBase.labels..zIncorrect label countcss|]}t|VqdS)N)rA)rBr$rrrrDs)r=r#rr?N)r'rr(dictzipsortedrlenr9r: __class__r,r-r/r8)r)r?rCr)rCrr5is2  zMetricWrapperBase.labelsc Gsj|jstd|t|t|jkr:tdt|j|ftdd|D}|j|j|=WdQRXdS)Nz,No label names were set when constructing %sz+Incorrect label count (expected %d, got %s)css|]}t|VqdS)N)rA)rBr$rrrrDsz+MetricWrapperBase.remove..)r'rrHrr9r:)r)r?rrrremoves zMetricWrapperBase.removecCs|r|S|SdS)N)r+_multi_samples_child_samples)r)rrrr2szMetricWrapperBase._samplesc csz|j|j}WdQRXxX|D]L\}}tt|j|}x2|D]&\}}}|t|t||fVqHWq&WdS)N) r9r:copyitemslistrFr'r2rE)r)Zmetricsr5r3Z series_labelsr4Z sample_labelsr6rrrrKs z MetricWrapperBase._multi_samplescCstd|dS)Nz*_child_samples() must be implemented by %r)NotImplementedError)r)rrrrLsz MetricWrapperBase._child_samplescCstd|dS)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 %rN)rP)r)rrrr;szMetricWrapperBase._metric_init)__name__ __module__ __qualname__r.r!r*r+r0r1r7r r@r5rJr2rKrLr;rrrrr&/s&  7 r&c@s:eZdZdZdZddZd ddZefdd Zd d Z d S)CounterarA 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 rcCs0t|j|j|jd|j|j|_t|_dS)Nr) r ValueClassr.r,r'r(_valuetime_created)r)rrrr;s"zCounter._metric_initrcCs |dkrtd|j|dS)z&Increment counter by the given amount.rz9Counters can only be incremented by non-negative amounts.N)rrVinc)r)amountrrrrYsz Counter.inccCs 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. )r)r)Z exceptionrrrcount_exceptionsszCounter.count_exceptionscCsdi|jfdi|jffS)NrrX)rVgetrX)r)rrrrLszCounter._child_samplesN)r) rQrRrS__doc__r.r;rY Exceptionr[rLrrrrrTs   rTcseZdZdZdZedZddddeddffdd Zd d Z dd dZ dddZ ddZ ddZ ddZddZddZddZZS)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)) Zgauge)minmaxZlivesumZliveallallrrNrbc sL| |_| |jkrtd| tt|j||||||||d|j|jd<dS)NzInvalid multiprocess mode: )rr=r#rrrr>r?multiprocess_mode)_multiprocess_mode_MULTIPROC_MODESrsuperr_r@r8) r)rr=r#rrrr>r?rc)rIrrr@*s    zGauge.__init__cCs(tj|j|j|j|j|j|jd|_dS)N)rc)rrUr.r,r'r(rdrV)r)rrrr;DszGauge._metric_initrcCs|j|dS)z$Increment gauge by the given amount.N)rVrY)r)rZrrrrYJsz Gauge.inccCs|j| dS)z$Decrement gauge by the given amount.N)rVrY)r)rZrrrdecNsz Gauge.deccCs|jt|dS)zSet gauge to the given value.N)rVsetfloat)r)r6rrrrhRsz Gauge.setcCs|tdS)z"Set gauge to the current unixtime.N)rhrW)r)rrrset_to_current_timeVszGauge.set_to_current_timecCst|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. )r)r)rrrtrack_inprogressZszGauge.track_inprogresscCs t|jS)zTime a block of code or function, and set the duration in seconds. Can be used as a function decorator or context manager. )rrh)r)rrrrWcsz Gauge.timecsfdd}t|||_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. csditffS)Nr)ri)r))frrsamplesqsz#Gauge.set_function..samplesN)types MethodTyperL)r)rlrmr)rlr set_functionjs zGauge.set_functioncCsdi|jffS)Nr)rVr\)r)rrrrLvszGauge._child_samples)r)r)rQrRrSr]r. frozensetrer r@r;rYrgrhrjrkrWrprL __classcell__rr)rIrr_s&$    r_c@s:eZdZdZdZdgZddZddZdd Zd d Z d S) 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 ZsummaryZquantilecCsRt|j|j|jd|j|j|_t|j|j|jd|j|j|_t|_ dS)N_count_sum) rrUr.r,r'r(rtrurWrX)r)rrrr;s""zSummary._metric_initcCs|jd|j|dS)zObserve the given amount.rN)rtrYru)r)rZrrrobserves zSummary.observecCs t|jS)zTime a block of code or function, and observe the duration in seconds. Can be used as a function decorator or context manager. )rrv)r)rrrrWsz Summary.timecCs*di|jfdi|jfdi|jffS)NrtrurX)rtr\rurX)r)rrrrLszSummary._child_samplesN) rQrRrSr]r.r!r;rvrWrLrrrrrszsrscseZdZdZdZdgZdddddd d d d d ddddefZddddedeffdd Z ddZ ddZ ddZ ddZ dd ZZS)! 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`. Z histogramleg{Gzt?g{Gz?g?g?g333333?g?g?g?g?g?g@g@g@g$@rrNc s8|| tt|j||||||||d| |jd<dS)N)rr=r#rrrr>r?buckets)_prepare_bucketsrfrwr@r8) r)rr=r#rrrr>r?ry)rIrrr@s  zHistogram.__init__cCsZdd|D}|t|kr"td|r<|dtkr<|tt|dkrPtd||_dS)NcSsg|] }t|qSr)ri)rBbrrr sz.Histogram._prepare_buckets..zBuckets not in sorted orderzMust have at least two buckets)rGrrappendrH _upper_bounds)r)ryrrrrzs   zHistogram._prepare_bucketsc Csg|_t|_|jd}t|j|j|jd|j|j|_ x>|j D]4}|j t|j|j|jd||jt |fqDWdS)N)rxru_bucket) _bucketsrWrXr'rrUr.r,r(rurrr )r)Zbucket_labelnamesr{rrrr;s  "  zHistogram._metric_initcCsB|j|x0t|jD]"\}}||kr|j|dPqWdS)zObserve the given amount.rN)rurY enumeraterr)r)rZiboundrrrrv s  zHistogram.observecCs t|jS)zTime a block of code or function, and observe the duration in seconds. Can be used as a function decorator or context manager. )rrv)r)rrrrWszHistogram.timecCsg}d}x@t|jD]2\}}||j|7}|ddt|i|fqW|di|f|di|jf|di|jft|S)NrrrxrtrurX) rrrr\rr rurXr)r)rmZaccrrrrrrLszHistogram._child_samples)rQrRrSr]r.r!rZDEFAULT_BUCKETSr r@rzr;rvrWrLrrrr)rIrrws "" rwc@s,eZdZdZdZddZddZddZd S) 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. rcCst|j|_t|_i|_dS)N)rhr'_labelname_setrr9rV)r)rrrr;9s zInfo._metric_initc CsB|j|r"td|j|f|jt||_WdQRXdS)zSet info metric.z8Overlapping labels for Info metric, metric: %s child: %sN)r intersectionkeysrr'r9rErV)r)valrrrr>s z Info.infoc Cs |jd|jdffSQRXdS)NZ_infog?)r9rV)r)rrrrLFszInfo._child_samplesN)rQrRrSr]r.r;rrLrrrrr's rcsLeZdZdZdZddddeddffdd Zdd Zd d Zd d Z Z S)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. rrrNc s\tt|j||||||||d||kr6td|f| sHtd|f| |jd<|_dS)N)rr=r#rrrr>r?z&Overlapping labels for Enum metric: %sz&No states provided for Enum metric: %sstates)rfrr@rr8_states) r)rr=r#rrrr>r?r)rIrrr@Zs z Enum.__init__cCsd|_t|_dS)Nr)rVrr9)r)rrrr;uszEnum._metric_initc Cs$|j|j||_WdQRXdS)zSet enum metric state.N)r9rindexrV)r)staterrrrysz Enum.statec s*jfddtjDSQRXdS)Ncs.g|]&\}}dj|i|jkr$dndfqS)rrr)r,rV)rBrs)r)rrr|sz'Enum._child_samples..)r9rr)r)r)r)rrL~s zEnum._child_samples) rQrRrSr]r.r r@r;rrLrrrr)rIrrKs r)"sysZ threadingrrWrnrrZcontext_managersrrrZ metrics_corerr r r r>r Zutilsr r version_infostrrArr%objectr&rTr_rsrwrrrrrrs(     <y9t$