File: //opt/alt/python37/lib/python3.7/site-packages/prometheus_client/__pycache__/metrics.cpython-37.pyc
B
bP�e f � @ s� d dl Z d dlmZ d dlZd dlZd dlmZmZmZm Z m
Z
m Z m Z m
Z
mZmZmZ ddlmZ ddlmZmZmZ ddlmZmZmZmZ ddl m Z m Z m Z dd l m!Z!m"Z" dd
l#m$Z$m%Z% ed d d
�Z&ededef d
�Z'dd� Z(dd� Z)dd� Z*dd� Z+e,d�dd�Z-e-� Z.G dd � d e �Z/G d d � d e/�Z0G d d � d e/�Z1G d d!� d!e/�Z2G d"d#� d#e/�Z3G d$d%� d%e/�Z4G d&d'� d'e/�Z5dS )(� N)�Lock) �Any�Callable�Dict�Iterable�List�Optional�Sequence�Tuple�Type�TypeVar�Union� )�values)�ExceptionCounter�InprogressTracker�Timer)�Metric�METRIC_LABEL_NAME_RE�METRIC_NAME_RE� RESERVED_METRIC_LABEL_NAME_RE)� Collector�CollectorRegistry�REGISTRY)�Exemplar�Sample)�floatToGoString�INF�T�MetricWrapperBase)�bound�F.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�unitZ full_name� r/ �J/opt/alt/python37/lib/python3.7/site-packages/prometheus_client/metrics.py�_build_full_name s r1 c C s0 t �| �std| ��t�| �r,td| ��d S )NzInvalid label metric name: z Reserved label metric name: )r �matchr) r )�lr/ r/ r0 �_validate_labelname( s
r4 c C s8 t |�}x*|D ]"}t|� || jkrtd| ��qW |S )Nz Reserved label metric name: )�tupler4 �_reserved_labelnamesr) )�cls�
labelnamesr3 r/ r/ r0 �_validate_labelnames/ s
r9 c C sN d}x4| � � D ](\}}t|� |t|�7 }|t|�7 }qW |dkrJtd��d S )Nr � zDExemplar labels have %d UTF-8 characters, exceeding the limit of 128)�itemsr4 �lenr) )�exemplarZrunes�k�vr/ r/ r0 �_validate_exemplar8 s r@ )�returnc C s t j�dd��� dkS )NZ!PROMETHEUS_DISABLE_CREATED_SERIES�False)�true�1�t)�os�environ�get�lowerr/ r/ r/ r0 �_get_use_createdB s rJ c @ s< e Zd ZU dZee ed< dZee ed< dd� Z dd� Z
d d
� Z d d � Z e
e d
�dd�Ze
e d
�dd�Zed
�dd�Zed
�dd�Zddddedfeeee
e eeeee eee dd�
dd�Zeeeed�dd �Zedd �d d �Zdd
�d d!�Ze
e d
�d"d#�Z e
e d
�d$d%�Z e
e d
�d&d'�Z d(d)� Z dS )*r N�_typer/ r6 c C s | j p| j o| jS )N)� _labelnames� _labelvalues)�selfr/ r/ r0 �_is_observableM s z MetricWrapperBase._is_observablec C s | � � stdt| j� ��d S )Nz!%s metric is missing label values)rO r) �strrK )rN r/ r/ r0 �_raise_if_not_observableS s z*MetricWrapperBase._raise_if_not_observablec C s | j o | j S )N)rL rM )rN r/ r/ r0 �
_is_parentZ s z MetricWrapperBase._is_parentc C s t | j| j| j| j�S )N)r �_name�_documentationrK �_unit)rN r/ r/ r0 � _get_metric] s z MetricWrapperBase._get_metric)rA c C s
| � � gS )N)rV )rN r/ r/ r0 �describe` s zMetricWrapperBase.describec C sB | � � }x2| �� D ]&\}}}}}|�| j| ||||� qW |gS )N)rV �_samplesZ
add_samplerS )rN �metric�suffix�labels�value� timestampr= r/ r/ r0 �collectc s zMetricWrapperBase.collectc C s | j � d| j� �S )N�:)rK rS )rN r/ r/ r0 �__str__i s zMetricWrapperBase.__str__c C s$ t | �}|j� d|j� d| j� d�S )N�.�(�))�type�
__module__�__name__rS )rN r* r/ r/ r0 �__repr__l s zMetricWrapperBase.__repr__r" )
rN r+ �
documentationr8 r, r- r. �registryrM rA 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: )r1 rK rS r9 rL r5 rM �_kwargsrT rU r r2 r) rR r �_lock�_metricsrO � _metric_init�register) rN r+ rh r8 r, r- r. ri rM r/ r/ r0 �__init__p s
zMetricWrapperBase.__init__)rN � labelvalues� labelkwargsrA c s� | j std| ��| jr6td�| tt| j | j�����|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@{} already has labels set ({}); can not chain calls to .labels()z"Can't pass both *args and **kwargszIncorrect label namesc 3 s | ]}t � | �V qd S )N)rP )�.0r3 )rq r/ r0 � <genexpr>� s z+MetricWrapperBase.labels.<locals>.<genexpr>zIncorrect label countc s s | ]}t |�V qd S )N)rP )rr r3 r/ r/ r0 rs � s )rh r8 r. rM N)rL r) rM �format�dict�zip�sortedr5 r< rk rl � __class__rS rT rU rj )rN rp rq r/ )rq r0 r[ � s2
zMetricWrapperBase.labels)rp rA c 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)rP )rr r3 r/ r/ r0 rs � s z+MetricWrapperBase.remove.<locals>.<genexpr>)rL r) r< r5 rk rl )rN rp r/ r/ r0 �remove� s zMetricWrapperBase.removec C s | j � i | _W dQ R X dS )z$Remove all labelsets from the metricN)rk rl )rN r/ r/ r0 �clear� s zMetricWrapperBase.clearc C s | � � r| �� S | �� S d S )N)rR �_multi_samples�_child_samples)rN r/ r/ r0 rX � s zMetricWrapperBase._samplesc
c s� | j � | j�� }W d Q R X xb|�� D ]V\}}tt| j|��}x<|�� D ]0\}}}}} t|t |t|�� � �||| �V qHW q&W d S )N)
rk rl �copyr; �listrv rL rX r ru )
rN Zmetricsr[ rY Z
series_labelsrZ Z
sample_labelsr\ r] r= r/ r/ r0 r{ � s z MetricWrapperBase._multi_samplesc C s t d| ��d S )Nz*_child_samples() must be implemented by %r)�NotImplementedError)rN r/ r/ r0 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 )rN r/ r/ r0 rm � s z MetricWrapperBase._metric_init) rf re � __qualname__rK r rP �__annotations__r6 r rO rQ rR rV r r rW r^ r` rg r r r ro r r[ ry rz r rX r{ r| rm r/ r/ r/ r0 r I s0
&7 c @ s� e Zd ZdZdZdd�dd�Zdeeee e f dd�d d
�Z
e fe e
e ee
e d f f ed �d
d�Zee d�dd�ZdS )�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$ N)rA c C s4 t �| j| j| jd | j| j| j�| _t�� | _ d S )Nr% )
r �
ValueClassrK rS rL rM rT �_value�time�_created)rN r/ r/ r0 rm s zCounter._metric_initr )�amountr= rA c C sL | � � |dk rtd��| j�|� |rHt|� | j�t||t�� �� dS )z&Increment counter by the given amount.r z9Counters can only be incremented by non-negative amounts.N)rQ r) r� �incr@ � set_exemplarr r� )rN r� r= r/ r/ r0 r� s z Counter.inc.)� exceptionrA c 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.
)rQ r )rN r� r/ r/ r0 �count_exceptions# s zCounter.count_exceptionsc C s< t di | j�� d | j�� �}tr6|t di | jd d �fS |fS )Nr% r� )r r� rH � get_exemplar� _use_createdr� )rN �sampler/ r/ r0 r| - s
zCounter._child_samples)r N)rf re r� �__doc__rK rm �floatr r rP r� � Exceptionr
r �
BaseExceptionr
r r� r r r| r/ r/ r/ r0 r� � s
,
r� c s� e Zd ZdZdZed�Zddddeddfeee e eeee
e e
e e ed� � fd d
�
Z
dd �d d
�Zd"edd�dd�Zd#edd�dd�Zedd�dd�Zdd �dd�Zed �dd�Zed �dd �Zeg ef dd �d d �Ze e d �d d!�Z� Z S )$�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)�allZliveall�minZlivemin�maxZlivemax�sumZlivesumr/ r" Nr� ) r+ rh r8 r, r- r. ri rM �multiprocess_modec
sH | | _ | | jkr td| ��t� j||||||||d� | j | jd< d S )NzInvalid multiprocess mode: )r+ rh r8 r, r- r. ri rM r� )�_multiprocess_mode�_MULTIPROC_MODESr) �superro rj )
rN r+ rh r8 r, r- r. ri rM r� )rx r/ r0 ro _ s
zGauge.__init__)rA c C s, t j| j| j| j| j| j| j| jd�| _d S )N)r� ) r r� rK rS rL rM rT r� r� )rN r/ r/ r0 rm y s zGauge._metric_initr )r� rA c C s | � � | j�|� dS )z$Increment gauge by the given amount.N)rQ r� r� )rN r� r/ r/ r0 r� s z Gauge.incc C s | � � | j�| � dS )z$Decrement gauge by the given amount.N)rQ r� r� )rN r� r/ r/ r0 �dec� s z Gauge.dec)r\ rA c C s | � � | j�t|�� dS )z Set gauge to the given value.N)rQ r� �setr� )rN r\ r/ r/ r0 r� � s z Gauge.setc C s | � t�� � dS )z"Set gauge to the current unixtime.N)r� r� )rN r/ r/ r0 �set_to_current_time� 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.
)rQ r )rN r/ r/ r0 �track_inprogress� s zGauge.track_inprogressc C s
t | d�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.
r� )r )rN r/ r/ r0 r� � s z
Gauge.time)�frA c s2 | � � ttt d�� 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.
)r# rA c s t di t� � �d d �fS )Nr" )r r� )r# )r� r/ r0 �samples� s z#Gauge.set_function.<locals>.samplesN)rQ r� r r �types�
MethodTyper| )rN r� r� r/ )r� r0 � set_function� s zGauge.set_functionc C s t di | j�� d d �fS )Nr" )r r� rH )rN r/ r/ r0 r| � s zGauge._child_samples)r )r ) rf re r� r� rK � frozensetr� r rP r r r r ro rm r� r� r� r� r� r r� r r� r r� r r| �
__classcell__r/ r/ )rx r0 r� 7 s& $6
r� c @ sX e Zd ZdZdZdgZdd�dd�Zedd�d d
�Ze d�d d �Z
e e d�d
d�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
�summaryZquantileN)rA c C sZ t �| j| j| jd | j| j| j�| _t �| j| j| jd | j| j| j�| _t � � | _
d S )N�_count�_sum) r r� rK rS rL rM rT r� r� r� r� )rN r/ r/ r0 rm � s &zSummary._metric_init)r� rA c C s$ | � � | j�d� | j�|� dS )af Observe 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.
r N)rQ r� r� r� )rN r� r/ r/ r0 �observe� s
zSummary.observec C s
t | d�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 )rN r/ r/ r0 r� � s z Summary.timec C sP t di | j�� d d �t di | j�� d d �g}trH|�t di | jd d �� t|�S )Nr� r� r� )r r� rH r� r� �appendr� r5 )rN r� r/ r/ r0 r| � s
zSummary._child_samples)rf re r� r� rK r6 rm r� r� r r� r r r| r/ r/ r/ r0 r� � s r� c s� e Zd ZdZdZdgZdddddd d
d d d
ddddefZddddedefe e e
e e e e e e e e
e e
eee f d� � fdd�
Ze
eee f dd�dd�Zdd�d d �Zd%ee ee e f dd �d d �Zed�d!d"�Ze
e d�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" N) r+ rh r8 r, r- r. ri rM �bucketsc
s4 | � | � t� j||||||||d� | | jd< d S )N)r+ rh r8 r, r- r. ri rM r� )�_prepare_bucketsr� ro rj )
rN r+ rh r8 r, r- r. ri rM r� )rx r/ r0 ro " s
zHistogram.__init__)�source_bucketsrA c C sZ dd� |D �}|t |�kr"td��|r<|d tkr<|�t� t|�dk rPtd��|| _d S )Nc S s g | ] }t |��qS r/ )r� )rr �br/ r/ r0 �
<listcomp>; s z.Histogram._prepare_buckets.<locals>.<listcomp>zBuckets not in sorted order���� z Must have at least two buckets)rw r) r r� r< �
_upper_bounds)rN r� r� r/ r/ r0 r� : s
zHistogram._prepare_buckets)rA c C s� g | _ t�� | _| jd }t�| j| j| jd | j| j| j �| _
xB| j D ]8}| j � t�| j| j| jd || jt
|�f | j �� qHW d S )N)r� r� �_bucket)�_bucketsr� r� rL r r� rK rS rM rT r� r� r� r )rN Zbucket_labelnamesr� r/ r/ r0 rm F s
&
zHistogram._metric_init)r� r= rA c C sr | � � | j�|� xXt| j�D ]J\}}||kr | j| �d� |rht|� | j| �t||t � � �� P q W dS )af Observe 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.
r N)
rQ r� r� � enumerater� r� r@ r� r r� )rN r� r= �ir r/ r/ r0 r� U s
zHistogram.observec C s
t | d�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 )rN r/ r/ r0 r� i s zHistogram.timec
C s� g }d}xPt | j�D ]B\}}|| j| �� 7 }|�tddt|�i|d | j| �� �� qW |�tdi |d d �� | jd dkr�|�tdi | j�� d d �� t r�|�tdi | j
d d �� t |�S )Ng r� r� r� r r� r� ) r� r� r� rH r� r r r� r� r� r� r5 )rN r� �accr� r r/ r/ r0 r| p s , zHistogram._child_samples)N)rf re r� r� rK r6 r ZDEFAULT_BUCKETSr rP r r r r r
r� ro r� rm r r� r r� r r| r� r/ r/ )rx r0 r� � s ""B r� c @ sF e Zd ZdZdZdd� Zeeef dd�dd�Ze e
d �d
d �Z dS ) �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)r� rL �_labelname_setr rk r� )rN r/ r/ r0 rm � s zInfo._metric_initN)�valrA c C sB | j �|�� �r"td�| j|���| j� t|�| _W dQ R X dS )zSet info metric.z8Overlapping labels for Info metric, metric: {} child: {}N) r� � intersection�keysr) rt rL rk ru r� )rN r� r/ r/ r0 r& � s
z Info.info)rA c C s& | j � td| jdd d �fS Q R X d S )N�_infog �?)rk r r� )rN r/ r/ r0 r| � s zInfo._child_samples) rf re r� r� rK rm r rP r& r r r| r/ r/ r/ r0 r� ~ s
r� c s� e Zd ZdZdZddddeddfeeee eeeee eee eee d� � fdd�
Z
dd �d
d �Z edd �d
d�Z e
e d �dd�Z� ZS )�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" N) r+ rh r8 r, r- r. ri rM �statesc
sX t � j||||||||d� ||kr2td|� ���| sDtd|� ���| | jd< | _d S )N)r+ rh r8 r, r- r. ri rM z$Overlapping labels for Enum metric: z$No states provided for Enum metric: r� )r� ro r) rj �_states)
rN r+ rh r8 r, r- r. ri rM r� )rx r/ r0 ro � s z
Enum.__init__)rA c C s d| _ t� | _d S )Nr )r� r rk )rN r/ r/ r0 rm � s zEnum._metric_init)�staterA c C s, | � � | j� | j�|�| _W dQ R X dS )zSet enum metric state.N)rQ rk r� �indexr� )rN r� r/ r/ r0 r� � s z
Enum.statec s* � j � � fdd�t� j�D �S Q R X d S )Nc s4 g | ],\}}t d � j|i|� jkr&dnddd��qS )r" r r N)r rS r� )rr r� �s)rN r/ r0 r� � s z'Enum._child_samples.<locals>.<listcomp>)rk r� r� )rN r/ )rN r0 r| � s
zEnum._child_samples)rf re r� r� rK r rP r r r ro rm r� r r r| r� r/ r/ )rx r0 r� � s >r� )6rF � threadingr r� r� �typingr r r r r r r r
r r r
r" r Zcontext_managersr r r Z metrics_corer r r r ri r r r r� r r �utilsr r r r! r1 r4 r9 r@ �boolrJ r� r r� r� r� r� r� r� r/ r/ r/ r0 �<module> s6 4
*E~F $