관리-도구
편집 파일: metrics.cpython-38.pyc
U .?�fam � @ s� d dl Z d dlmZ d dlZd dlZd dlmZmZmZm Z m Z m Z m Z m Z mZmZmZmZ d dlZddlmZ ddlmZmZmZ ddlmZmZm Z m Z 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/� a0dd � Z1d d � Z2G d d � d e �Z3G d d!� d!e3�Z4G d"d#� d#e3�Z5G d$d%� d%e3�Z6G d&d'� d'e3�Z7G d(d)� d)e3�Z8G d*d+� d+e3�Z9dS ),� N)�Lock) �Any�Callable�Dict�Iterable�List�Literal�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� r0 �G/opt/hc_python/lib/python3.8/site-packages/prometheus_client/metrics.py�_build_full_name s r2 c C s0 t �| �std| ��t�| �r,td| ��d S )NzInvalid label metric name: � Reserved label metric name: )r �matchr* r )�lr0 r0 r1 �_validate_labelname) s r6 c C s4 t |�}|D ]"}t|� || jkr td| ��q |S )Nr3 )�tupler6 �_reserved_labelnamesr* )�cls� labelnamesr5 r0 r0 r1 �_validate_labelnames0 s r; c C sJ d}| � � D ](\}}t|� |t|�7 }|t|�7 }q |dkrFtd��d S )Nr � zDExemplar labels have %d UTF-8 characters, exceeding the limit of 128)�itemsr6 �lenr* )�exemplarZrunes�k�vr0 r0 r1 �_validate_exemplar9 s rB ��returnc C s t j�dd��� dkS )NZ!PROMETHEUS_DISABLE_CREATED_SERIES�False)�true�1�t)�os�environ�get�lowerr0 r0 r0 r1 �_get_use_createdC s rM c C s da dS )zJDisable exporting _created metrics on counters, histograms, and summaries.FN�� _use_createdr0 r0 r0 r1 �disable_created_metricsJ s rP c C s da dS )zIEnable exporting _created metrics on counters, histograms, and summaries.TNrN r0 r0 r0 r1 �enable_created_metricsP s rQ 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�_typer0 r8 c C s | j p| j o| jS �N�� _labelnames� _labelvalues��selfr0 r0 r1 �_is_observableZ s z MetricWrapperBase._is_observablec C s | � � stdt| j� ��d S )Nz!%s metric is missing label values)rY r* �strrR rW r0 r0 r1 �_raise_if_not_observable` s z*MetricWrapperBase._raise_if_not_observablec C s | j o | j S rS rT rW r0 r0 r1 � _is_parentg s z MetricWrapperBase._is_parentc C s t | j| j| j| j�S rS )r �_name�_documentationrR �_unitrW r0 r0 r1 � _get_metricj s z MetricWrapperBase._get_metricrC c C s | � � gS rS )r` rW r0 r0 r1 �describem s zMetricWrapperBase.describec C s> | � � }| �� D ]&\}}}}}|�| j| ||||� q|gS rS )r` �_samplesZ add_sampler] )rX �metric�suffix�labels�value� timestampr? r0 r0 r1 �collectp s zMetricWrapperBase.collectc C s | j � d| j� �S )N�:)rR r] rW r0 r0 r1 �__str__v s zMetricWrapperBase.__str__c C s$ t | �}|j� d|j� d| j� d�S )N�.�(�))�type� __module__�__name__r] )rX r+ r0 r0 r1 �__repr__y s zMetricWrapperBase.__repr__r# ) rX r, � documentationr: r- r. r/ �registryrV rD c C s� t | j||||�| _t| |�| _t|p(d�| _i | _|| _|| _ t � | j�sZt d| j ��| � � rpt� | _i | _| �� r�| �� | js�|r�|�| � d S )Nr0 zInvalid metric name: )r2 rR r] r; rU r7 rV �_kwargsr^ r_ r r4 r* r\ r �_lock�_metricsrY � _metric_init�register) rX r, rr r: r- r. r/ rs rV r0 r0 r1 �__init__} s zMetricWrapperBase.__init__)rX � labelvalues� labelkwargsrD 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 �N || j kr�| j | j f| j | j | j|d �| j��| j |< | j | W 5 Q R � 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). �,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 rS �rZ ��.0r5 �r{ r0 r1 � <genexpr>� s z+MetricWrapperBase.labels.<locals>.<genexpr>zIncorrect label countc s s | ]}t |�V qd S rS r} r~ r0 r0 r1 r� � s )rr r: r/ rV N)rU r* rV �format�dict�zip�sortedr7 r> ru rv � __class__r] r^ r_ rt )rX rz r{ r0 r� r1 re � s: � ��� zMetricWrapperBase.labels)rz rD c G s� dt jksdt jkr t�dt� | js2td| ��t|�t| j�krZtdt| j�|f ��tdd� |D ��}| j � | j |= W 5 Q R X d S )N�prometheus_multiproc_dir�PROMETHEUS_MULTIPROC_DIRzFRemoval of labels has not been implemented in multi-process mode yet.r| z+Incorrect label count (expected %d, got %s)c s s | ]}t |�V qd S rS r} r~ r0 r0 r1 r� � s z+MetricWrapperBase.remove.<locals>.<genexpr>) rI rJ �warnings�warn� UserWarningrU r* r> r7 ru rv )rX rz r0 r0 r1 �remove� s � zMetricWrapperBase.removec C s< dt jksdt jkr t�dt� | j� i | _W 5 Q R X dS )z$Remove all labelsets from the metricr� r� zBClearing labels has not been implemented in multi-process mode yetN)rI rJ r� r� r� ru rv rW r0 r0 r1 �clear� s �zMetricWrapperBase.clearc C s | � � r| �� S | �� S d S rS )r\ �_multi_samples�_child_samplesrW r0 r0 r1 rb � s zMetricWrapperBase._samplesc c s| | j � | j�� }W 5 Q R X |�� D ]R\}}tt| j|��}|�� D ]0\}}}}} t|t |t|�� � �||| �V qDq$d S rS ) ru rv �copyr= �listr� rU rb r r� ) rX Zmetricsre rc Z series_labelsrd Z sample_labelsrf rg r? r0 r0 r1 r� � s z MetricWrapperBase._multi_samplesc C s t d| ��d S )Nz*_child_samples() must be implemented by %r��NotImplementedErrorrW r0 r0 r1 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 %rNr� rW r0 r0 r1 rw � s z MetricWrapperBase._metric_init) rp ro � __qualname__rR r rZ �__annotations__r8 r rY r[ r\ r` r r ra rh rj rq r r r ry r re r� r� r rb r� r� rw r0 r0 r0 r1 r V sD � � !7 c @ s� e Zd ZdZdZdd�dd�Zdeeee e f dd�d d �Z dd�d d �Z e fe ee eee d f f ed�dd�Zee d�dd�ZdS )�Countera 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 You can also reset the counter to zero in case your logical "process" restarts without restarting the actual python process. c.reset() r% NrC c C s4 t �| j| j| jd | j| j| j�| _t�� | _ d S )Nr& ) r � ValueClassrR r] rU rV r^ �_value�time�_createdrW r0 r0 r1 rw 0 s �zCounter._metric_initr ��amountr? rD 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)r[ r* r� �incrB � set_exemplarr r� )rX r� r? r0 r0 r1 r� 5 s z Counter.incc C s | j �d� t�� | _dS )zqReset the counter to zero. Use this when a logical process restarts without restarting the actual python process.r N)r� �setr� r� rW r0 r0 r1 �reset? s z Counter.reset.)� exceptionrD 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. )r[ r )rX r� r0 r0 r1 �count_exceptionsD s zCounter.count_exceptionsc C s< t di | j�� d | j�� �}tr6|t di | jd d �fS |fS )Nr& r� )r r� rK � get_exemplarrO r� )rX �sampler0 r0 r1 r� N s �zCounter._child_samples)r N)rp ro r� �__doc__rR rw �floatr r rZ r� r� � Exceptionr r � BaseExceptionr r r� r r r� r0 r0 r0 r1 r� s % , r� c s e Zd ZdZdZed�Zed�Zddddeddfe e e e e e e e e e e e ed d � � fd d � Zdd �d d�Zd#edd�dd�Zd$edd�dd�Zedd�dd�Zdd �dd�Zed �dd�Zed �d d �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�sumZlivesum� mostrecent�livemostrecent)r� r� r0 r# Nr� ) r, rr r: r- r. r/ rs rV �multiprocess_modec sV | | _ | | jkr td| ��t� j||||||||d� | j | jd< | j | jk| _d S )NzInvalid multiprocess mode: �r, rr r: r- r. r/ rs rV r� )�_multiprocess_mode�_MULTIPROC_MODESr* �superry rt �_MOST_RECENT_MODES�_is_most_recent) rX r, rr r: r- r. r/ rs rV r� �r� r0 r1 ry � s � zGauge.__init__rC c C s, t j| j| j| j| j| j| j| jd�| _d S )N)r� ) r r� rR r] rU rV r^ r� r� rW r0 r0 r1 rw � s �zGauge._metric_initr �r� rD c C s& | j rtd��| �� | j�|� dS )z$Increment gauge by the given amount.z-inc must not be used with the mostrecent modeN�r� � RuntimeErrorr[ r� r� �rX r� r0 r0 r1 r� � s z Gauge.incc C s( | j rtd��| �� | j�| � dS )z$Decrement gauge by the given amount.z-dec must not be used with the mostrecent modeNr� r� r0 r0 r1 �dec� s z Gauge.dec)rf rD c C s< | � � | jr(| jjt|�t�� d� n| j�t|�� dS )z Set gauge to the given value.)rg N)r[ r� r� r� r� r� )rX rf r0 r0 r1 r� � s z Gauge.setc C s | � t�� � dS )z"Set gauge to the current unixtime.N)r� r� rW r0 r0 r1 �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. )r[ r rW r0 r0 r1 �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 rW r0 r0 r1 r� � s z Gauge.time)�frD 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$ rD c s t di t� � �d d �fS �Nr# )r r� )r$ �r� r0 r1 �samples� s z#Gauge.set_function.<locals>.samplesN)r[ r� r r �types� MethodTyper� )rX r� r� r0 r� r1 � set_function� s zGauge.set_functionc C s t di | j�� d d �fS r� )r r� rK rW r0 r0 r1 r� � s zGauge._child_samples)r )r ) rp ro r� r� rR � frozensetr� r� r rZ r r r r r ry rw r� r� r� r� r� r r� r r� r r� r r� � __classcell__r0 r0 r� r1 r� X s> $� � 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 �summaryZquantileNrC 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� rR r] rU rV r^ r� r� r� r� rW r0 r0 r1 rw s �&zSummary._metric_initr� 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)r[ r� r� r� r� r0 r0 r1 �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� rW r0 r0 r1 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� rK r� rO �appendr� r7 )rX r� r0 r0 r1 r� s �zSummary._child_samples)rp ro r� r� rR r8 rw r� r� r r� r r r� r0 r0 r0 r1 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 $@r0 r# N) r, rr r: r- r. r/ rs rV �bucketsc s4 | � | � t� j||||||||d� | | jd< d S )Nr� r� )�_prepare_bucketsr� ry rt ) rX r, rr r: r- r. r/ rs rV r� r� r0 r1 ry L s � zHistogram.__init__)�source_bucketsrD c C sZ dd� |D �}|t |�kr"td��|r<|d tkr<|�t� t|�dk rPtd��|| _d S )Nc S s g | ] }t |��qS r0 )r� )r �br0 r0 r1 � <listcomp>e s z.Histogram._prepare_buckets.<locals>.<listcomp>zBuckets not in sorted order���� z Must have at least two buckets)r� r* r r� r> � _upper_bounds)rX r� r� r0 r0 r1 r� d s zHistogram._prepare_bucketsrC c C s� g | _ t�� | _| jd }t�| j| j| jd | j| j| j �| _ | j D ]8}| j � t�| j| j| jd || jt |�f | j �� qFd S )N)r� r� �_bucket)�_bucketsr� r� rU r r� rR r] rV r^ r� r� r� r )rX Zbucket_labelnamesr� r0 r0 r1 rw p s & �zHistogram._metric_initr� c C sp | � � | j�|� t| j�D ]L\}}||kr | j| �d� |rft|� | j| �t||t � � �� qlq dS r� ) r[ r� r� � enumerater� r� rB r� r r� )rX r� r? �ir! r0 r0 r1 r� s zHistogram.observec C s t | d�S r� r� rW r0 r0 r1 r� � s zHistogram.timec C s� g }d}t | j�D ]B\}}|| j| �� 7 }|�tddt|�i|d | j| �� �� q|�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� rK r� r r r� r� rO r� r7 )rX r� �accr� r! r0 r0 r1 r� � s * zHistogram._child_samples)N)rp ro r� r� rR r8 r ZDEFAULT_BUCKETSr rZ r r r r r r� ry r� rw r r� r r� r r� r� r0 r0 r� r1 r� % s6 ""� � 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 rS )r� rU �_labelname_setr ru r� rW r0 r0 r1 rw � s zInfo._metric_initN)�valrD c C sB | j �|�� �r"td�| j|���| j� t|�| _W 5 Q R X dS )zSet info metric.z8Overlapping labels for Info metric, metric: {} child: {}N) r� � intersection�keysr* r� rU ru r� r� )rX r� r0 r0 r1 r' � s �z Info.inforC c C s2 | j �" td| jdd d �fW 5 Q R � S Q R X d S )N�_infor� )ru r r� rW r0 r0 r1 r� � s zInfo._child_samples) rp ro r� r� rR rw r rZ r' r r r� r0 r0 r0 r1 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( r0 r# N) r, rr r: r- r. r/ rs rV �statesc sX t � j||||||||d� ||kr2td|� ���| sDtd|� ���| | jd< | _d S )Nr� z$Overlapping labels for Enum metric: z$No states provided for Enum metric: r� )r� ry r* rt �_states) rX r, rr r: r- r. r/ rs rV r� r� r0 r1 ry � s � z Enum.__init__rC c C s d| _ t� | _d S )Nr )r� r ru rW r0 r0 r1 rw � s zEnum._metric_init)�staterD c C s, | � � | j� | j�|�| _W 5 Q R X dS )zSet enum metric state.N)r[ ru r� �indexr� )rX r� r0 r0 r1 r� � s z Enum.statec s6 � j �& � fdd�t� j�D �W 5 Q R � S Q R X d S )Nc s4 g | ],\}}t d � j|i|� jkr&dnddd��qS )r# r r N)r r] r� )r r� �srW r0 r1 r� s �z'Enum._child_samples.<locals>.<listcomp>)ru r� r� rW r0 rW r1 r� s �zEnum._child_samples)rp ro r� r� rR r rZ r r r ry rw r� r r r� r� r0 r0 r� r1 r� � s. � �r� ):rI � threadingr r� r� �typingr r r r r r r r r r r r r� r# r Zcontext_managersr r r Z metrics_corer r r r rs r r r r� r r �utilsr r r r" r2 r6 r; rB �boolrM rO rP rQ r r� r� r� r� r� r� r0 r0 r0 r1 �<module> s> 8 3P F $