fܲ_ ~ d dl Z d dlmZ d dlZd dlZddlmZ ddlmZm Z m
Z
ddl m Z m
Z
mZmZ ddlmZ ddlmZmZ e j d k r
eZej Znd
Zd Zd Z G d
de Z G d de Z G d de Z G d de Z G d de Z! G d de Z" G d de Z#dS ) N)Lock )values)ExceptionCounterInprogressTrackerTimer)MetricMETRIC_LABEL_NAME_REMETRIC_NAME_RE RESERVED_METRIC_LABEL_NAME_RE)REGISTRY)floatToGoStringINF) c 8 t j | ||j S N)types
MethodType __class__)funcobjs k/builddir/build/BUILD/cloudlinux-venv-1.0.10/venv/lib/python3.11/site-packages/prometheus_client/metrics.pycreate_bound_methodr s c3=999 c d}|r||dz z
}|r||dz z
}||z
}| dk r | d r
|d d }|r | d|z s|d|z z
}|r| dv rt d|z |S )N _counter_totali)infostatesetz2Metric name is of a type that cannot have a unit: )endswith
ValueError) metric_typename namespace subsystemunit full_names r _build_full_namer* s I %Y_$ %Y_$
Ii I$6$6x$@$@ crcN I&&sTz22 S4Z [ 333MPYYZZZ r c t | }|D ]i}t j | st d|z t j | rt d|z || j v rt d|z j|S )NzInvalid label metric name: z Reserved label metric name: )tupler
matchr# r _reserved_labelnames)cls
labelnamesls r _validate_labelnamesr2 ' s z""J
A A#)!,, @ :Q >?? ? ( .q 1 1 A ;a ?@@ @ ( ( ( ;a ?@@ @ ) r c ~ e Zd ZdZdZd Zd Zd Zd Zd Z d Z
d Z d
Z dd d d e
dfd Zd
Zd Zd Zd Zd Zd ZdS )MetricWrapperBaseN c . | j p
| j o| j S r _labelnames _labelvaluesselfs r _is_observablez MetricWrapperBase._is_observable7 s ##O(8(NT=NOr c v | s$t dt | j z d S )Nz!%s metric is missing label values)r< r# str_typer: s r _raise_if_not_observablez*MetricWrapperBase._raise_if_not_observable= sA ""$$ T @3tz?? RSS S T Tr c | j o| j S r r7 r: s r
_is_parentz MetricWrapperBase._is_parentD s 9(9$99r c N t | j | j | j | j S r )r _name_documentationr? _unitr: s r _get_metricz MetricWrapperBase._get_metricG s dj$"5tz4:NNNr c , | gS r )rG r: s r describezMetricWrapperBase.describeJ s ""##r c | }| D ]%\ }}}| | j |z || &|gS r )rG _samples
add_samplerD )r; metricsuffixlabelsvalues r collectzMetricWrapperBase.collectM s\ !!##%)]]__ B B !FFE dj6 165 A A A Axr c B d | j | j S )Nz{0}:{1})formatr? rD r: s r __str__zMetricWrapperBase.__str__S s
DJ777r c l t | }d |j |j | j S )Nz {0}.{1}({2}))typerS
__module____name__rD )r; r$ s r __repr__zMetricWrapperBase.__repr__V s/ 4jj $$[%;[=QSWS]^^^r r c t | j |||| | _ t | | | _ t |pd | _ i | _ || _ || _ t j | j st d| j z |
rt | _ i | _ | r| | j s|r| | d S d S d S )Nr5 zInvalid metric name: )r* r? rD r2 r8 r, r9 _kwargsrE rF r r- r# rB r _lock_metricsr< _metric_initregister) r; r%
documentationr0 r& r' r( registry labelvaluess r __init__zMetricWrapperBase.__init__Z s &dj$ 9dSS
/jAA !+"3 4 4 +
#DJ// C 4tz ABB B ?? DJ DM (
(!!$''''' ( (
(
(r c
| j st d| z | j r:t | dt t | j | j d |rrt d rUt t | j k rt d t
fd| j D }nMt | t | j k rt d t
d |D }| j 5 || j vr4 | j
| j f| j | j | j
|d | j | j |< | j | cd
d
d
S # 1 swxY w Y d
S ) ar Return 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 (z#); can not chain calls to .labels()z"Can't pass both *args and **kwargszIncorrect label namesc 3 B K | ]}t | V d S r unicode).0r1 labelkwargss r z+MetricWrapperBase.labels.. s/ R RA A 7 7 R R R R R Rr zIncorrect label countc 3 4 K | ]}t | V d S r rg ri r1 s r rk z+MetricWrapperBase.labels.. s( @ @q
@ @ @ @ @ @r )r` r0 r( rb N)r8 r# r9 dictzipsortedr, lenr\ r] r rD rE rF r[ )r; rb rj s `r rO zMetricWrapperBase.labels{ s . T Kd RSS S S)4+<==>>>>
C; C ABB B Ak""fT-=&>&>>> !8999 R R R RAQ R R RRRKK; 3t'7#8#888 !8999 @ @K @ @ @@@K
Z
.
.$-//-;T^J."&"5 # / + . . l
. .
k* =-
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.s A
E11E58E5c R | j st d| z t | t | j k r&t dt | j |fz t d |D }| j 5 | j |= d d d d S # 1 swxY w Y d S )Nre z+Incorrect label count (expected %d, got %s)c 3 4 K | ]}t | V d S r rg rm s r rk z+MetricWrapperBase.remove.. s( <<1GAJJ<<<<<!> ? ?M060A0A
Y
Y,
u tMD 9L9L9N9N4O4O$O P PRWXXXXX
Y Y Ys 044c & t d| z )Nz*_child_samples() must be implemented by %rNotImplementedErrorr: s r rw z MetricWrapperBase._child_samples s !"NQU"UVVVr c & t d| 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 %rr r: s r r^ z MetricWrapperBase._metric_init s ""Lt"STTTr )rX rW __qualname__r? r. r< r@ rB rG rI rQ rT rY r
rc rO rt rK rv rw r^ r5 r r r4 r4 3 s2 E P P P T T T: : :O O O$ $ $ 8 8 8_ _ _ " ! ( ( ( (B5. 5. 5.n + + +) ) ) Y Y YW W WU U U U Ur r4 c 4 e Zd ZdZdZd Zd dZefdZd Z dS )
Counterar A 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
r c t j | j | j | j dz | j | j | _ t j | _ d S )Nr ) r
ValueClassr? rD r8 r9 _valuetime_createdr: s r r^ zCounter._metric_init sD '
DJ
X@UW[Wg(,(9; ;
r r c d |dk rt d | j | dS )z&Increment counter by the given amount.r z9Counters can only be incremented by non-negative amounts.N)r# r incr; amounts r r z Counter.inc s4 A:: XYY Y r c J | 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 )r; exceptions r count_exceptionszCounter.count_exceptions s&
%%''' i000r c N di | j fdi | j ffS )Nr r )r getr r: s r rw zCounter._child_samples s.
r4;??,, -
T] +
r Nr )
rX rW r __doc__r? r^ r Exceptionr rw r5 r r r r sp >
E$ $ $
*3 1 1 1 1
r r c e Zd ZdZdZ ed Zddddeddf fd Zd Z dd Z
dd Z d
Z d Z
d Zd Zd Zd Z xZS )Gaugea Gauge 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)minmaxlivesumliveallallr5 r Nr c
| | _ | | j vrt d| z t t | |||||||| | j | j d< d S )NzInvalid multiprocess mode: r% r` r0 r& r' r( ra rb multiprocess_mode)_multiprocess_mode_MULTIPROC_MODESr# superr rc r[ ) r; r% r` r0 r& r' r( ra rb r r s r rc zGauge.__init__= s #4 D$9 9 9 :=N NOO O
eT##'! # $
-1,C ()))r c t j | j | j | j | j | j | j | _ d S )N)r )r r r? rD r8 r9 r r r: s r r^ zGauge._metric_initW s< ' J
DJ0@$BS " 5
r r c : | j | dS )z$Increment gauge by the given amount.Nr r r s r r z Gauge.inc] s r c < | j | dS )z$Decrement gauge by the given amount.Nr r s r decz Gauge.deca s r c T | j t | dS )z Set gauge to the given value.N)r setfloat)r; rP s r r z Gauge.sete s" e %%%%%r c R | t j dS )z"Set gauge to the current unixtime.N)r r r: s r set_to_current_timezGauge.set_to_current_timei s r c H | 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.
)r@ r r: s r track_inprogresszGauge.track_inprogressm s$
%%''' &&&r c R | t | j S )zTime a block of code or function, and set the duration in seconds.
Can be used as a function decorator or context manager.
)r@ r r r: s r r z
Gauge.timew s$
%%'''TX r c < fd}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.
c : di t ffS Nr r )r; fs r samplesz#Gauge.set_function..samples s U1133ZZ(* *r N)r rw )r; r r s ` r set_functionzGauge.set_function s6 + + + + + 2'4 @ @r c < di | j ffS r )r r r: s r rw zGauge._child_samples s R **+--r r )rX rW r r r? frozensetr r
rc r^ r r r r r r r rw
__classcell__r s @r r r s # #H
E y!LMM
" !#(D D D D D D4
! ! ! !& & & ' ' '
A
A
A. . . . . . .r r c 4 e Zd ZdZdZdgZd Zd Zd Zd Z dS ) Summarya A 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
summaryquantilec t j | j | j | j dz | j | j | _ t j | j | j | j dz | j | j | _ t j | _ d S )N_count_sum)
r r r? rD r8 r9 r r r r r: s r r^ zSummary._metric_init sq '
DJ
X@UW[Wg(,(9; ; %dj$*dj6>QSWSceievww
r c n | j d | j | dS zObserve the given amount.r N)r r r r s r observezSummary.observe s0
f r c R | t | j S zTime a block of code or function, and observe the duration in seconds.
Can be used as a function decorator or context manager.
)r@ r r r: s r r z Summary.time s&
%%'''T\"""r c di | j fdi | j fdi | j ffS )Nr r r )r r r r r: s r rw zSummary._child_samples sB
r4;??,, -
R )
T] +- -r N)
rX rW r r r? r. r^ r r rw r5 r r r r si :
E &<$ $ $
# # #- - - - -r r c | e Zd ZdZdZdgZdddddd d
d d d
ddddefZddddedef fd Z d Z
d Z d Z d Z
d Z xZS ) Histograma A 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 $@r5 r Nc
| | t t | |||||||| | | j d< d S )Nr buckets)_prepare_bucketsr r rc r[ ) r; r% r` r0 r& r' r( ra rb r r s r rc zHistogram.__init__ sl
g&&&
i '''! # (
#* Y r c d |D }|t | k rt d |r+|d t k r| t t | dk rt d || _ d S )Nc , g | ]}t | S r5 r )ri bs r
z.Histogram._prepare_buckets..
s ---588---r zBuckets not in sorted order z Must have at least two buckets)rp r# r appendrq
_upper_bounds)r; r s r r zHistogram._prepare_buckets s --W--- fWoo % % :;; ; wr{c)) NN3 w<> > $r c
g | _ t j | _ | j dz }t j | j | j | j dz | j | j | _ | j
D ]Z}| j t j | j | j | j dz || j t | fz [d S )N)r r _bucket)
_bucketsr r r8 r r r? rD r9 r r r r )r; bucket_labelnamesr s r r^ zHistogram._metric_init s
,w 6%dj$*dj6>QSWSceievww # A M !2
Y&!!_Q%7%7$99 "; ";
r c | j | t | j D ].\ }}||k r#| j | d dS /dS r )r r enumerater r )r; r ibounds r r zHistogram.observe# sn
f !$"455 HAu
a $$Q''' r c * t | j S r )r r r: s r r zHistogram.time+ s
T\"""r c g }d}t | j D ]N\ }}|| j | z
}| ddt | i|f O| di |f | j d dk r/| di | j f | di | j f t | S )Nr r r r r r ) r r r r r r r r r, )r; r accr r s r rw zHistogram._child_samples2 s !$"455 M MHAu 4=#'')) )C NNIoe.D.D'EsK L L L L"c*+++ a A % % NNFB
8 9 9 9
B
6777W~~ r )rX rW r r r? r. r DEFAULT_BUCKETSr
rc r r^ r r rw r r s @r r r s ! !D
E 6S$T2sBS#sTWY]_bcO
" !(* * * * * *0
%
%
% # # #
r r c ( e Zd ZdZdZd Zd Zd ZdS )Infoa Info 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 c l t | j | _ t | _ i | _ d S r )r r8 _labelname_setr r\ r r: s r r^ zInfo._metric_initQ s+ !$"2 3 3VV
r c | j | rt d| j d| | j 5 t
| | _ ddd dS # 1 swxY w Y dS )zSet info metric.z,Overlapping labels for Info metric, metric: z child: N)r intersectionkeysr# r8 r\ rn r )r; vals r r z Info.infoV s + +CHHJJ 7 7 ( * ## ' ( (
(
Z $ $ s))DK $ $ $ $ $ $ $ $ $ $ $ $ $ $ $ $ $ $s A00A47A4c Z | j 5 d| j dffcd d d S # 1 swxY w Y d S )N_infor )r\ r r: s r rw zInfo._child_samples^ s}
Z 3 3 dk302 3 3 3 3 3 3 3 3 3 3 3 3 3 3 3 3 3 3s $$N)rX rW r r r? r^ r rw r5 r r r r ? sR
E
$ $ $3 3 3 3 3r r c H e Zd ZdZdZddddeddf fd Zd Zd Zd Z xZ
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.
r! r5 r Nc
t t | |||||||| ||v rt d| | st d| | x| j d< | _ d S )Nr z$Overlapping labels for Enum metric: z$No states provided for Enum metric: states)r r rc r# r[ _states) r; r% r` r0 r& r' r( ra rb r r s r rc z
Enum.__init__r s dD""'! # #
: * OPP P Q * OPP P066 X r c : d| _ t | _ d S )Nr )r r r\ r: s r r^ zEnum._metric_init s VV
r c | | j 5 | j | | _ ddd dS # 1 swxY w Y dS )zSet enum metric state.N)r@ r\ r indexr )r; states r r z
Enum.state s %%'''
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
c j 5 fdt j D cd d d S # 1 swxY w Y d S )Nc H g | ] \ }}d j |i|j k rdndf S )r r r )rD r )ri r sr; s r r z'Enum._child_samples.. sJ Aq dj!_1 +;+;aaD r )r\ r r r: s `r rw zEnum._child_samples s
Z T\** s 6::) rX rW r r r? r
rc r^ r rw r r s @r r r c s
E
" ! 7 7 7 7 7 76 4 4 4 r r )$sys threadingr r r r r context_managersr r r metrics_corer r
r r ra r
utilsr r version_infor> rh r r r* r2 objectr4 r r r r r r r5 r r r sr
H H H H H H H H H H ' ' ' ' ' ' ' 'dG *: : :
aU aU aU aU aU aU aU aUH;
;
;
;
;
;
;
;
|w. w. w. w. w. w. w. w.t8- 8- 8- 8- 8- 8- 8- 8-vr r r r r ! r r r j!3 !3 !3 !3 !3 !3 !3 !3H: : : : : : : : : :r