pytest_userver.client.ClientMonitor Class Reference

Detailed Description

Asyncio userver client for monitor listeners, typically retrieved from plugins.service_client.monitor_client fixture.

Compatible with werkzeug interface.

Definition at line 402 of file client.py.

Inheritance diagram for pytest_userver.client.ClientMonitor:

Public Member Functions
MetricsDiffer	metrics_diff (self, *str|None path=None, str|None prefix=None, dict[str, str]|None labels=None, bool diff_gauge=False)
	Creates a MetricsDiffer that fetches metrics using this client.
metric_module.MetricsSnapshot	metrics (self, *str|None path=None, str|None prefix=None, dict[str, str]|None labels=None)
	Returns a dict of metric names to Metric.
Metric|None	single_metric_optional (self, str path, *dict[str, str]|None labels=None)
	Either return a Metric or None if there's no such metric.
Metric|None	single_metric (self, str path, *dict[str, str]|None labels=None)
	Returns the Metric.
dict[str, Metric]	metrics_raw (self, str output_format, *str|None path=None, str|None prefix=None, dict[str, str]|None labels=None)
	Low level function that returns metrics in a specific format.
	get_metrics (self, prefix=None)
	get_metric (self, metric_name)
	fired_alerts (self)

Member Function Documentation

fired_alerts()

pytest_userver.client.ClientMonitor.fired_alerts

(

self

)

Definition at line 544 of file client.py.

get_metric()

pytest_userver.client.ClientMonitor.get_metric	(		self,
			metric_name
	)

Deprecated:

Use metrics() or single_metric() instead

Definition at line 537 of file client.py.

get_metrics()

pytest_userver.client.ClientMonitor.get_metrics	(		self,
			prefix = None
	)

Deprecated:

Use metrics() or single_metric() instead

Definition at line 530 of file client.py.

metrics()

metric_module.MetricsSnapshot pytest_userver.client.ClientMonitor.metrics	(		self,
		*str | None	path = None,
		str | None	prefix = None,
		dict[str, str] | None	labels = None
	)

Returns a dict of metric names to Metric.

Parameters

path	Optional full metric path
prefix	Optional prefix on which the metric paths should start
labels	Optional dictionary of labels that must be in the metric

Definition at line 449 of file client.py.

metrics_diff()

MetricsDiffer pytest_userver.client.ClientMonitor.metrics_diff	(		self,
		*str | None	path = None,
		str | None	prefix = None,
		dict[str, str] | None	labels = None,
		bool	diff_gauge = False
	)

Creates a MetricsDiffer that fetches metrics using this client.

It's recommended to use this method over metrics to make sure the tests don't affect each other.

With diff_gauge off, only RATE metrics are differentiated. With diff_gauge on, GAUGE metrics are differentiated as well, which may lead to nonsensical results for those.

Parameters

path	Optional full metric path
prefix	Optional prefix on which the metric paths should start
labels	Optional dictionary of labels that must be in the metric
diff_gauge	Whether to differentiate GAUGE metrics

async with monitor_client.metrics_diff(prefix='foo') as differ:
    # Do something that makes the service update its metrics
assert differ.value_at('path-suffix', {'label'}) == 42

Definition at line 412 of file client.py.

metrics_raw()

dict[str, Metric] pytest_userver.client.ClientMonitor.metrics_raw	(		self,
		str	output_format,
		*str | None	path = None,
		str | None	prefix = None,
		dict[str, str] | None	labels = None
	)

Low level function that returns metrics in a specific format.

Use metrics and single_metric instead if possible.

Parameters

output_format	Metric output format. See server::handlers::ServerMonitor for a list of supported formats.
path	Optional full metric path
prefix	Optional prefix on which the metric paths should start
labels	Optional dictionary of labels that must be in the metric

Definition at line 504 of file client.py.

single_metric()

Metric | None pytest_userver.client.ClientMonitor.single_metric	(		self,
		str	path,
		*dict[str, str] | None	labels = None
	)

Returns the Metric.

Parameters

path	Full metric path
labels	Optional dictionary of labels that must be in the metric

Exceptions

AssertionError

if more than one metric or no metric found

Definition at line 487 of file client.py.

single_metric_optional()

Metric | None pytest_userver.client.ClientMonitor.single_metric_optional	(		self,
		str	path,
		*dict[str, str] | None	labels = None
	)

Either return a Metric or None if there's no such metric.

Parameters

path	Full metric path
labels	Optional dictionary of labels that must be in the metric

Exceptions

AssertionError

if more than one metric returned

Definition at line 470 of file client.py.

---

The documentation for this class was generated from the following file:

• /data/code/userver/testsuite/pytest_plugins/pytest_userver/client.py