brk-code

client_python の API リファレンス

client_python (prometheus/client_python) の公開 API 53 件 —— クラス 24、関数 5、メソッド 24。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。

リポジトリ: prometheus/client_python

種別件数
クラス24
関数5
メソッド24

API 一覧

funcprometheus_client.decorator.getargspec(f)
A replacement for inspect.getargspec
classprometheus_client.decorator.getfullargspec
A quick and dirty replacement for getfullargspec for Python 2.X
classprometheus_client.exposition.MetricsHandler
HTTP handler that gives metrics from ``REGISTRY``.
methodprometheus_client.exposition.MetricsHandler.log_message(format:str, *args:Any) -> None
Log nothing.
classprometheus_client.exposition.ThreadingWSGIServer
Thread per request HTTP server.
funcprometheus_client.exposition.write_to_textfile(path:str, registry:Collector, escaping:str=openmetrics.ALLOWUTF8, tmpdir:Optional[str]=None) -> None
Write metrics to the given path.
classprometheus_client.gc_collector.GCCollector
Collector for Garbage collection statistics.
classprometheus_client.metrics.Counter
A Counter tracks counts of events or running totals.
methodprometheus_client.metrics.Counter.inc(amount:float=1, exemplar:Optional[Dict[str, str]]=None) -> None
Increment counter by the given amount.
methodprometheus_client.metrics.Counter.reset() -> None
Reset the counter to zero.
classprometheus_client.metrics.Enum
Enum metric, which of a set of states is true.
methodprometheus_client.metrics.Enum.state(state:str) -> None
Set enum metric state.
classprometheus_client.metrics.Gauge
Gauge metric, to report instantaneous values.
methodprometheus_client.metrics.Gauge.dec(amount:float=1) -> None
Decrement gauge by the given amount.
methodprometheus_client.metrics.Gauge.inc(amount:float=1) -> None
Increment gauge by the given amount.
methodprometheus_client.metrics.Gauge.set(value:float) -> None
Set gauge to the given value.
methodprometheus_client.metrics.Gauge.set_function(f:Callable[[], float]) -> None
Call the provided function to return the Gauge value.
methodprometheus_client.metrics.Gauge.set_to_current_time() -> None
Set gauge to the current unixtime.
methodprometheus_client.metrics.Gauge.time() -> Timer
Time a block of code or function, and set the duration in seconds.
methodprometheus_client.metrics.Gauge.track_inprogress() -> InprogressTracker
Track inprogress blocks of code or functions.
methodprometheus_client.metrics.Histogram.observe(amount:float, exemplar:Optional[Dict[str, str]]=None) -> None
Observe the given amount.
classprometheus_client.metrics.Info
Info metric, key-value pairs.
methodprometheus_client.metrics.Info.info(val:Dict[str, str]) -> None
Set info metric.
classprometheus_client.metrics.Summary
A Summary tracks the size and number of events.
methodprometheus_client.metrics.Summary.observe(amount:float) -> None
Observe the given amount.
classprometheus_client.metrics_core.CounterMetricFamily
A single counter and its samples.
classprometheus_client.metrics_core.GaugeHistogramMetricFamily
A single gauge histogram and its samples.
classprometheus_client.metrics_core.GaugeMetricFamily
A single gauge and its samples.
methodprometheus_client.metrics_core.GaugeMetricFamily.add_metric(labels:Sequence[str], value:float, timestamp:Optional[Union[Timestamp, float]]=None) -> None
Add a metric to the metric family.
classprometheus_client.metrics_core.HistogramMetricFamily
A single histogram and its samples.
classprometheus_client.metrics_core.InfoMetricFamily
A single info and its samples.
methodprometheus_client.metrics_core.InfoMetricFamily.add_metric(labels:Sequence[str], value:Dict[str, str], timestamp:Optional[Union[Timestamp, float]]=None) -> None
Add a metric to the metric family.
classprometheus_client.metrics_core.Metric
A single metric family and its samples.
classprometheus_client.metrics_core.StateSetMetricFamily
A single stateset and its samples.
methodprometheus_client.metrics_core.StateSetMetricFamily.add_metric(labels:Sequence[str], value:Dict[str, bool], timestamp:Optional[Union[Timestamp, float]]=None) -> None
Add a metric to the metric family.
classprometheus_client.metrics_core.SummaryMetricFamily
A single summary and its samples.
methodprometheus_client.metrics_core.SummaryMetricFamily.add_metric(labels:Sequence[str], count_value:int, sum_value:float, timestamp:Optional[Union[float, Timestamp]]=None) -> None
Add a metric to the metric family.
classprometheus_client.metrics_core.UnknownMetricFamily
A single unknown metric and its samples.
methodprometheus_client.metrics_core.UnknownMetricFamily.add_metric(labels:Sequence[str], value:float, timestamp:Optional[Union[Timestamp, float]]=None) -> None
Add a metric to the metric family.
classprometheus_client.mmap_dict.MmapedDict
A dict of doubles, backed by an mmapped file.
methodprometheus_client.mmap_dict.MmapedDict.read_all_values()
Yield (key, value, timestamp).
funcprometheus_client.mmap_dict.mmap_key(metric_name:str, name:str, labelnames:List[str], labelvalues:List[str], help_text:str) -> str
Format a key for use in the mmap file.
classprometheus_client.multiprocess.MultiProcessCollector
Collector for files for multi-process mode.
funcprometheus_client.parser.text_fd_to_metric_families(fd:TextIO) -> Iterable[Metric]
Parse Prometheus text format from a file descriptor.
funcprometheus_client.parser.text_string_to_metric_families(text:str) -> Iterable[Metric]
Parse Prometheus text format from a unicode string.
classprometheus_client.platform_collector.PlatformCollector
Collector for python platform information
methodprometheus_client.registry.Collector.collect() -> Iterable[Metric]
Collect metrics.
classprometheus_client.registry.CollectorRegistry
Metric collector registry.
methodprometheus_client.registry.CollectorRegistry.register(collector:Collector) -> None
Add a collector to the registry.
methodprometheus_client.registry.CollectorRegistry.restricted_registry(names:Iterable[str]) -> 'RestrictedRegistry'
Returns object that only collects some metrics.
methodprometheus_client.registry.CollectorRegistry.unregister(collector:Collector) -> None
Remove a collector from the registry.
classprometheus_client.samples.Timestamp
A nanosecond-resolution timestamp.
classprometheus_client.values.MutexValue
A float protected by a mutex.

この情報について

掲載しているシグネチャは prometheus/client_python の公開ソースコードを Python の ast モジュールで静的解析し、引数名・デフォルト値・ 型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。 詳しくは仕組みの解説をご覧ください。

収録ライブラリ一覧（全 805 件）へ戻る