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 401 of file client.py.

Inheritance diagram for pytest_userver.client.ClientMonitor:

Public Member Functions
'MetricsDiffer'	metrics_diff (self, *, typing.Optional[str] path=None, typing.Optional[str] prefix=None, typing.Optional[typing.Dict[str, str]] labels=None, bool diff_gauge=False)
	Creates a MetricsDiffer that fetches metrics using this client.
metric_module.MetricsSnapshot	metrics (self, *, typing.Optional[str] path=None, typing.Optional[str] prefix=None, typing.Optional[typing.Dict[str, str]] labels=None)
	Returns a dict of metric names to Metric.
typing.Optional[Metric]	single_metric_optional (self, str path, *, typing.Optional[typing.Dict[str, str]] labels=None)
	Either return a Metric or None if there's no such metric.
typing.Optional[Metric]	single_metric (self, str path, *, typing.Optional[typing.Dict[str, str]] labels=None)
	Returns the Metric.
typing.Dict[str, Metric]	metrics_raw (self, str output_format, *, typing.Optional[str] path=None, typing.Optional[str] prefix=None, typing.Optional[typing.Dict[str, str]] 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)
http.ClientResponse	post (self, str path, JsonAnyOptional json=None, typing.Any data=None, typing.Optional[typing.Dict[str, str]] params=None, typing.Optional[str] bearer=None, typing.Optional[str] x_real_ip=None, typing.Optional[typing.Dict[str, str]] headers=None, **kwargs)
	Make a HTTP POST request.
http.ClientResponse	put (self, path, JsonAnyOptional json=None, typing.Any data=None, typing.Optional[typing.Dict[str, str]] params=None, typing.Optional[str] bearer=None, typing.Optional[str] x_real_ip=None, typing.Optional[typing.Dict[str, str]] headers=None, **kwargs)
	Make a HTTP PUT request.
http.ClientResponse	patch (self, path, JsonAnyOptional json=None, typing.Any data=None, typing.Optional[typing.Dict[str, str]] params=None, typing.Optional[str] bearer=None, typing.Optional[str] x_real_ip=None, typing.Optional[typing.Dict[str, str]] headers=None, **kwargs)
	Make a HTTP PATCH request.
http.ClientResponse	get (self, str path, typing.Optional[typing.Dict[str, str]] headers=None, typing.Optional[str] bearer=None, typing.Optional[str] x_real_ip=None, **kwargs)
	Make a HTTP GET request.
http.ClientResponse	delete (self, str path, typing.Optional[typing.Dict[str, str]] headers=None, typing.Optional[str] bearer=None, typing.Optional[str] x_real_ip=None, **kwargs)
	Make a HTTP DELETE request.
http.ClientResponse	options (self, str path, typing.Optional[typing.Dict[str, str]] headers=None, typing.Optional[str] bearer=None, typing.Optional[str] x_real_ip=None, **kwargs)
	Make a HTTP OPTIONS request.
http.ClientResponse	request (self, str http_method, str path, **kwargs)
	Make a HTTP request with the specified method.
	raw_aiohttp_client (self)

Protected Member Functions
typing.Awaitable[http.ClientResponse]	_wrap_client_response (self, aiohttp.ClientResponse response)

Protected Attributes
	_client = client

Member Function Documentation

_wrap_client_response()

typing.Awaitable[http.ClientResponse] pytest_userver.client.ClientWrapper._wrap_client_response ( self, aiohttp.ClientResponse response )

protectedinherited

Definition at line 272 of file client.py.

delete()

http.ClientResponse pytest_userver.client.ClientWrapper.delete ( self, str path, typing.Optional[typing.Dict[str, str]] headers = None, typing.Optional[str] bearer = None, typing.Optional[str] x_real_ip = None, ** kwargs )

inherited

Make a HTTP DELETE request.

Definition at line 213 of file client.py.

fired_alerts()

pytest_userver.client.ClientMonitor.fired_alerts

(

self

)

Definition at line 543 of file client.py.

get()

http.ClientResponse pytest_userver.client.ClientWrapper.get ( self, str path, typing.Optional[typing.Dict[str, str]] headers = None, typing.Optional[str] bearer = None, typing.Optional[str] x_real_ip = None, ** kwargs )

inherited

Make a HTTP GET request.

Definition at line 193 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 536 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 529 of file client.py.

metrics()

metric_module.MetricsSnapshot pytest_userver.client.ClientMonitor.metrics	(		self,
		*	,
		typing.Optional[str]	path = None,
		typing.Optional[str]	prefix = None,
		typing.Optional[typing.Dict[str, str]]	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 448 of file client.py.

metrics_diff()

'MetricsDiffer' pytest_userver.client.ClientMonitor.metrics_diff	(		self,
		*	,
		typing.Optional[str]	path = None,
		typing.Optional[str]	prefix = None,
		typing.Optional[typing.Dict[str, str]]	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 411 of file client.py.

metrics_raw()

typing.Dict[str, Metric] pytest_userver.client.ClientMonitor.metrics_raw	(		self,
		str	output_format,
		*	,
		typing.Optional[str]	path = None,
		typing.Optional[str]	prefix = None,
		typing.Optional[typing.Dict[str, str]]	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 503 of file client.py.

options()

http.ClientResponse pytest_userver.client.ClientWrapper.options ( self, str path, typing.Optional[typing.Dict[str, str]] headers = None, typing.Optional[str] bearer = None, typing.Optional[str] x_real_ip = None, ** kwargs )

inherited

Make a HTTP OPTIONS request.

Definition at line 233 of file client.py.

patch()

http.ClientResponse pytest_userver.client.ClientWrapper.patch ( self, path, JsonAnyOptional json = None, typing.Any data = None, typing.Optional[typing.Dict[str, str]] params = None, typing.Optional[str] bearer = None, typing.Optional[str] x_real_ip = None, typing.Optional[typing.Dict[str, str]] headers = None, ** kwargs )

inherited

Make a HTTP PATCH request.

Definition at line 166 of file client.py.

post()

http.ClientResponse pytest_userver.client.ClientWrapper.post ( self, str path, JsonAnyOptional json = None, typing.Any data = None, typing.Optional[typing.Dict[str, str]] params = None, typing.Optional[str] bearer = None, typing.Optional[str] x_real_ip = None, typing.Optional[typing.Dict[str, str]] headers = None, ** kwargs )

inherited

Make a HTTP POST request.

Definition at line 112 of file client.py.

put()

http.ClientResponse pytest_userver.client.ClientWrapper.put ( self, path, JsonAnyOptional json = None, typing.Any data = None, typing.Optional[typing.Dict[str, str]] params = None, typing.Optional[str] bearer = None, typing.Optional[str] x_real_ip = None, typing.Optional[typing.Dict[str, str]] headers = None, ** kwargs )

inherited

Make a HTTP PUT request.

Definition at line 139 of file client.py.

raw_aiohttp_client()

pytest_userver.client.ClientWrapper.raw_aiohttp_client ( self )

inherited

Deprecated

Use pytest_userver.client.Client directly instead.

Definition at line 266 of file client.py.

request()

http.ClientResponse pytest_userver.client.ClientWrapper.request ( self, str http_method, str path, ** kwargs )

inherited

Make a HTTP request with the specified method.

Definition at line 253 of file client.py.

single_metric()

typing.Optional[Metric] pytest_userver.client.ClientMonitor.single_metric	(		self,
		str	path,
		*	,
		typing.Optional[typing.Dict[str, str]]	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 486 of file client.py.

single_metric_optional()

typing.Optional[Metric] pytest_userver.client.ClientMonitor.single_metric_optional	(		self,
		str	path,
		*	,
		typing.Optional[typing.Dict[str, str]]	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 469 of file client.py.

Member Data Documentation

_client

pytest_userver.client.ClientWrapper._client = client

protectedinherited

Definition at line 110 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