Your IP : 216.73.216.196
B
�Y�^�V � @ s d dl Z d dlmZ d dlZd dlZddlmZ ddlmZm Z m
Z
ddl m Z m
Z
mZmZ ddlmZ ddlmZmZ e jd kr�eZejZnd
d � Zd d
� Zdd� ZG dd� de �Z G dd� de �Z G dd� de �Z G dd� de �Z G dd� de �Z!G dd� de �Z"G d d � d e �Z#dS ) � N)�Lock� )�values)�ExceptionCounter�InprogressTracker�Timer)�Metric�METRIC_LABEL_NAME_RE�METRIC_NAME_RE� RESERVED_METRIC_LABEL_NAME_RE)�REGISTRY)�floatToGoString�INF)� c C s t �| ||j�S )N)�types�
MethodType� __class__)�func�obj� r �J/opt/alt/python37/lib/python3.7/site-packages/prometheus_client/metrics.py�create_bound_method s r c C s� d}|r||d 7 }|r$||d 7 }||7 }| dkrJ|� d�rJ|d d� }|rh|� d| �sh|d| 7 }|r�| dkr�td| ��|S )N� �_�counter�_totali����)�info�statesetz2Metric name is of a type that cannot have a unit: )�endswith�
ValueError)� metric_type�name� namespace� subsystem�unit� full_namer r r �_build_full_name s r& c C s\ t |�}xN|D ]F}t�|�s(td| ��t�|�r>td| ��|| jkrtd| ��qW |S )NzInvalid label metric name: z Reserved label metric name: )�tupler �matchr r �_reserved_labelnames)�cls�
labelnames�lr r r �_validate_labelnames' s
r- c @ s� e Zd ZdZdZdd� Zdd� Zdd� Zd d
� Zd d � Z d
d� Z
dd� Z dd� Z dddde
dfdd�Zdd� Zdd� Zdd� Zd d � Zd d � Zd d!� ZdS )"�MetricWrapperBaseNr c C s | j p| j o| jS )N)� _labelnames� _labelvalues)�selfr r r �_is_observable7 s z MetricWrapperBase._is_observablec C s | � � stdt| j� ��d S )Nz!%s metric is missing label values)r2 r �str�_type)r1 r r r �_raise_if_not_observable= s z*MetricWrapperBase._raise_if_not_observablec C s | j o | j S )N)r/ r0 )r1 r r r �
_is_parentD s z MetricWrapperBase._is_parentc C s t | j| j| j| j�S )N)r �_name�_documentationr4 �_unit)r1 r r r � _get_metricG s z MetricWrapperBase._get_metricc C s
| � � gS )N)r: )r1 r r r �describeJ s zMetricWrapperBase.describec C s: | � � }x*| �� D ] \}}}|�| j| ||� qW |gS )N)r: �_samplesZ
add_sampler7 )r1 �metric�suffix�labels�valuer r r �collectM s zMetricWrapperBase.collectc C s d� | j| j�S )Nz{0}:{1})�formatr4 r7 )r1 r r r �__str__S s zMetricWrapperBase.__str__c C s t | �}d�|j|j| j�S )Nz {0}.{1}({2}))�typerB �
__module__�__name__r7 )r1 r r r r �__repr__V s zMetricWrapperBase.__repr__r c C s� t | j||||�| _t| |�| _t|p(d�| _i | _|| _|| _ t
� | j�sZt d| j ��| �
� rpt� | _i | _| �� r�| �� | js�|r�|�| � d S )Nr zInvalid metric name: )r& r4 r7 r- r/ r' r0 �_kwargsr8 r9 r
r( r r6 r �_lock�_metricsr2 � _metric_init�register) r1 r! �
documentationr+ r" r# r$ �registry� labelvaluesr r r �__init__Z s
zMetricWrapperBase.__init__c s� | j std| ��| jr6td| tt| j | j��f ��|rF� rFtd��� r~t� �t| j �krdtd��t� fdd�| j D ��}n,t|�t| j �kr�td��tdd� |D ��}| j�B || j kr�| j
| j f| j | j | j
|d �| j��| j |< | j | S Q R X 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).
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 namesc 3 s | ]}t � | �V qd S )N)�unicode)�.0r, )� labelkwargsr r � <genexpr>� s z+MetricWrapperBase.labels.<locals>.<genexpr>zIncorrect label countc s s | ]}t |�V qd S )N)rQ )rR r, r r r rT � s )rM r+ r$ rO N)r/ r r0 �dict�zip�sortedr' �lenrI rJ r r7 r8 r9 rH )r1 rO rS r )rS r r? { s2
zMetricWrapperBase.labelsc G sj | j std| ��t|�t| j �kr:tdt| j �|f ��tdd� |D ��}| j� | j|= W d Q R X d S )Nz,No label names were set when constructing %sz+Incorrect label count (expected %d, got %s)c s s | ]}t |�V qd S )N)rQ )rR r, r r r rT � s z+MetricWrapperBase.remove.<locals>.<genexpr>)r/ r rX r' rI rJ )r1 rO r r r �remove� s zMetricWrapperBase.removec C s | � � r| �� S | �� S d S )N)r6 �_multi_samples�_child_samples)r1 r r r r< � s zMetricWrapperBase._samplesc c sz | j � | j�� }W d Q R X xX|�� D ]L\}}tt| j|��}x2|�� D ]&\}}}|t|t|�� � �|fV qHW q&W d S )N) rI rJ �copy�items�listrV r/ r< rU )r1 Zmetricsr? r= Z
series_labelsr> Z
sample_labelsr@ r r r rZ � s z MetricWrapperBase._multi_samplesc C s t d| ��d S )Nz*_child_samples() must be implemented by %r)�NotImplementedError)r1 r r r r[ � s z MetricWrapperBase._child_samplesc C s t d| ��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)r_ )r1 r r r rK � s z MetricWrapperBase._metric_init)rF rE � __qualname__r4 r) r2 r5 r6 r: r; rA rC rG r rP r? rY r< rZ r[ rK r r r r r. 3 s, 7 r. c @ s: e Zd ZdZdZdd� Zd
dd�Zefdd �Zd
d � Z d S )�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 C s0 t �| j| j| jd | j| j�| _t�� | _d S )Nr ) r �
ValueClassr4 r7 r/ r0 �_value�time�_created)r1 r r r rK � s
zCounter._metric_initr c C s |dk rt d��| j�|� dS )z&Increment counter by the given amount.r z9Counters can only be incremented by non-negative amounts.N)r rc �inc)r1 �amountr r r rf � s z Counter.incc C s | � � t| |�S )z�Count 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.
)r5 r )r1 � exceptionr r r �count_exceptions s zCounter.count_exceptionsc C s di | j �� fdi | jffS )Nr re )rc �getre )r1 r r r r[ s zCounter._child_samplesN)r )
rF rE r` �__doc__r4 rK rf � Exceptionri r[ r r r r ra � s
ra c s� e Zd ZdZdZed�Zddddeddf� fdd � Zd
d � Z d d
d�Z
d dd�Z dd� Z dd� Z
dd� Zdd� Zdd� Zdd � Z� ZS ) �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))
Zgauge)�min�maxZlivesumZliveall�allr r Nrp c
sL | | _ | | jkr td| ��tt| �j||||||||d� | j | jd< d S )NzInvalid multiprocess mode: )r! rM r+ r" r# r$ rN rO �multiprocess_mode)�_multiprocess_mode�_MULTIPROC_MODESr �superrm rP rH )
r1 r! rM r+ r" r# r$ rN rO rq )r r r rP = s
zGauge.__init__c C s( t j| j| j| j| j| j| jd�| _d S )N)rq )r rb r4 r7 r/ r0 rr rc )r1 r r r rK W s zGauge._metric_initr c C s | j �|� dS )z$Increment gauge by the given amount.N)rc rf )r1 rg r r r rf ] s z Gauge.incc C s | j �| � dS )z$Decrement gauge by the given amount.N)rc rf )r1 rg r r r �deca s z Gauge.decc C s | j �t|�� dS )z Set gauge to the given value.N)rc �set�float)r1 r@ r r r rv e s z Gauge.setc C s | � t�� � dS )z"Set gauge to the current unixtime.N)rv rd )r1 r r r �set_to_current_timei s zGauge.set_to_current_timec C s | � � t| �S )z�Track 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.
)r5 r )r1 r r r �track_inprogressm s zGauge.track_inprogressc C s | � � t| j�S )z�Time a block of code or function, and set the duration in seconds.
Can be used as a function decorator or context manager.
)r5 r rv )r1 r r r rd w s z
Gauge.timec s � fdd�}t || �| _dS )z�Call 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 s di t � � �ffS )Nr )rw )r1 )�fr r �samples� s z#Gauge.set_function.<locals>.samplesN)r r[ )r1 rz r{ r )rz r � set_function s zGauge.set_functionc C s di | j �� ffS )Nr )rc rj )r1 r r r r[ � s zGauge._child_samples)r )r )rF rE r` rk r4 � frozensetrs r rP rK rf ru rv rx ry rd r| r[ �
__classcell__r r )r r rm s& $
rm c @ s: e Zd ZdZdZdgZdd� Zdd� Zdd � Zd
d � Z d S )
�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
�summaryZquantilec C sR t �| j| j| jd | j| j�| _t �| j| j| jd | j| j�| _t�� | _ d S )N�_count�_sum)
r rb r4 r7 r/ r0 r� r� rd re )r1 r r r rK � s
"zSummary._metric_initc C s | j �d� | j�|� dS )zObserve the given amount.r N)r� rf r� )r1 rg r r r �observe� s zSummary.observec C s | � � t| j�S )z�Time a block of code or function, and observe the duration in seconds.
Can be used as a function decorator or context manager.
)r5 r r� )r1 r r r rd � s z Summary.timec C s* di | j �� fdi | j�� fdi | jffS )Nr� r� re )r� rj r� re )r1 r r r r[ � s zSummary._child_samplesN)
rF rE r` rk r4 r) rK r� rd r[ r r r r r � s r c s� e Zd ZdZdZdgZdddddd d
d d d
ddddefZddddedef� fdd� Z dd� Z
dd� Z dd � Z d d � Z
d d � Z� ZS )!� 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`.
Z histogram�leg{�G�zt?g{�G�z�?g�������?g�������?g333333�?g�������?g �?g �?g �?g �?g @g @g @g $@r r Nc
s8 | � | � tt| �j||||||||d� | | jd< d S )N)r! rM r+ r" r# r$ rN rO �buckets)�_prepare_bucketsrt r� rP rH )
r1 r! rM r+ r" r# r$ rN rO r� )r r r rP � s
zHistogram.__init__c C sZ dd� |D �}|t |�kr"td��|r<|d tkr<|�t� t|�dk rPtd��|| _d S )Nc S s g | ] }t |��qS r )rw )rR �br r r �
<listcomp>
s z.Histogram._prepare_buckets.<locals>.<listcomp>zBuckets not in sorted order���� z Must have at least two buckets)rW r r �appendrX �
_upper_bounds)r1 r� r r r r� s
zHistogram._prepare_bucketsc C s� g | _ t�� | _| jd }t�| j| j| jd | j| j�| _ x>| j
D ]4}| j � t�| j| j| jd || jt |�f �� qDW d S )N)r� r� �_bucket)
�_bucketsrd re r/ r rb r4 r7 r0 r� r� r� r
)r1 Zbucket_labelnamesr� r r r rK s
"
zHistogram._metric_initc C sB | j �|� x0t| j�D ]"\}}||kr| j| �d� P qW dS )zObserve the given amount.r N)r� rf � enumerater� r� )r1 rg �i�boundr r r r� # s
zHistogram.observec C s
t | j�S )z�Time a block of code or function, and observe the duration in seconds.
Can be used as a function decorator or context manager.
)r r� )r1 r r r rd + s zHistogram.timec C s� g }d}x@t | j�D ]2\}}|| j| �� 7 }|�ddt|�i|f� qW |�di |f� | jd dkr~|�di | j�� f� |�di | jf� t|�S )Nr r� r� r� r� re ) r� r� r� rj r� r
r� re r' )r1 r{ �accr� r� r r r r[ 2 s zHistogram._child_samples)rF rE r` rk r4 r) r ZDEFAULT_BUCKETSr rP r� rK r� rd r[ r~ r r )r r r� � s "" r� c @ s, e Zd ZdZdZdd� Zdd� Zdd� Zd S )
�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 C s t | j�| _t� | _i | _d S )N)rv r/ �_labelname_setr rI rc )r1 r r r rK Q s zInfo._metric_initc C sB | j �|�� �r"td| j|f ��| j� t|�| _W dQ R X dS )zSet info metric.z8Overlapping labels for Info metric, metric: %s child: %sN)r� � intersection�keysr r/ rI rU rc )r1 �valr r r r V s
z Info.infoc C s | j � d| jdffS Q R X d S )N�_infog �?)rI rc )r1 r r r r[ ^ s zInfo._child_samplesN)rF rE r` rk r4 rK r r[ r r r r r� ? s
r� c sL e Zd ZdZdZddddeddf� fdd� 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.
r r r Nc
s\ t t| �j||||||||d� ||kr6td|f ��| sHtd|f ��| | jd< | _d S )N)r! rM r+ r" r# r$ rN rO z&Overlapping labels for Enum metric: %sz&No states provided for Enum metric: %s�states)rt r� rP r rH �_states)
r1 r! rM r+ r" r# r$ rN rO r� )r r r rP r s
z
Enum.__init__c C s d| _ t� | _d S )Nr )rc r rI )r1 r r r rK � s zEnum._metric_initc C s, | � � | j� | j�|�| _W dQ R X dS )zSet enum metric state.N)r5 rI r� �indexrc )r1 �stater r r r� � s z
Enum.statec s* � j � � fdd�t� j�D �S Q R X d S )Nc s. g | ]&\}}d � j |i|� jkr$dndf�qS )r r r )r7 rc )rR r� �s)r1 r r r� � s z'Enum._child_samples.<locals>.<listcomp>)rI r� r� )r1 r )r1 r r[ � s
zEnum._child_samples) rF rE r` rk r4 r rP rK r� r[ r~ r r )r r r� c s r� )$�sys� threadingr rd r r r Zcontext_managersr r r Z metrics_corer r r
r rN r �utilsr
r � version_infor3 rQ r r r& r- �objectr. ra rm r r� r� r� r r r r �<module> s,
%>z;u$