def metric_create(self, project, metric_name, filter_, description):
"""API call: create a metric resource.
See
https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.metrics/create
:type project: str
:param project: ID of the project in which to create the metric.
:type metric_name: str
:param metric_name: the name of the metric
:type filter_: str
:param filter_: the advanced logs filter expression defining the
entries exported by the metric.
:type description: str
:param description: description of the metric.
"""
options = None
parent = 'projects/%s' % (project, )
metric_pb = LogMetric(name=metric_name,
filter=filter_,
description=description)
try:
self._gax_api.create_log_metric(parent, metric_pb, options=options)
except GaxError as exc:
if exc_to_code(exc.cause) == StatusCode.FAILED_PRECONDITION:
path = 'projects/%s/metrics/%s' % (project, metric_name)
raise Conflict(path)
raise
def metric_update(self, project, metric_name, filter_, description):
"""API call: update a metric resource.
:type project: str
:param project: ID of the project containing the metric.
:type metric_name: str
:param metric_name: the name of the metric
:type filter_: str
:param filter_: the advanced logs filter expression defining the
entries exported by the metric.
:type description: str
:param description: description of the metric.
:rtype: dict
:returns: The metric object returned from the API (converted from a
protobuf to a dictionary).
"""
options = None
path = 'projects/%s/metrics/%s' % (project, metric_name)
metric_pb = LogMetric(name=path,
filter=filter_,
description=description)
try:
self._gax_api.update_log_metric(path, metric_pb, options=options)
except GaxError as exc:
if exc_to_code(exc.cause) == StatusCode.NOT_FOUND:
raise NotFound(path)
raise
return MessageToDict(metric_pb)
def test_list_metrics_w_paging(self):
from google.cloud.proto.logging.v2.logging_metrics_pb2 import LogMetric
from google.cloud._testing import _GAXPageIterator
from google.cloud.logging.metric import Metric
TOKEN = 'TOKEN'
PAGE_SIZE = 42
metric_pb = LogMetric(name=self.METRIC_PATH,
description=self.DESCRIPTION,
filter=self.FILTER)
response = _GAXPageIterator([metric_pb])
gax_api = _GAXMetricsAPI(_list_log_metrics_response=response)
client = object()
api = self._make_one(gax_api, client)
iterator = api.list_metrics(
self.PROJECT, page_size=PAGE_SIZE, page_token=TOKEN)
metrics = list(iterator)
token = iterator.next_page_token
# First check the token.
self.assertIsNone(token)
# Then check the metrics returned.
self.assertEqual(len(metrics), 1)
metric = metrics[0]
self.assertIsInstance(metric, Metric)
self.assertEqual(metric.name, self.METRIC_PATH)
self.assertEqual(metric.filter_, self.FILTER)
self.assertEqual(metric.description, self.DESCRIPTION)
self.assertIs(metric.client, client)
project, page_size, options = gax_api._list_log_metrics_called_with
self.assertEqual(project, self.PROJECT_PATH)
self.assertEqual(page_size, PAGE_SIZE)
self.assertEqual(options.page_token, TOKEN)
def test_metric_update_hit(self):
from google.cloud.proto.logging.v2.logging_metrics_pb2 import LogMetric
response = LogMetric(name=self.METRIC_NAME,
description=self.DESCRIPTION,
filter=self.FILTER)
gax_api = _GAXMetricsAPI(_update_log_metric_response=response)
api = self._make_one(gax_api, None)
api.metric_update(
self.PROJECT, self.METRIC_NAME, self.FILTER, self.DESCRIPTION)
metric_name, metric, options = (
gax_api._update_log_metric_called_with)
self.assertEqual(metric_name, self.METRIC_PATH)
self.assertIsInstance(metric, LogMetric)
self.assertEqual(metric.name, self.METRIC_PATH)
self.assertEqual(metric.filter, self.FILTER)
self.assertEqual(metric.description, self.DESCRIPTION)
self.assertIsNone(options)
def test_metric_get_hit(self):
from google.cloud.proto.logging.v2.logging_metrics_pb2 import LogMetric
RESPONSE = {
'name': self.METRIC_PATH,
'filter': self.FILTER,
'description': self.DESCRIPTION,
}
metric_pb = LogMetric(name=self.METRIC_PATH,
description=self.DESCRIPTION,
filter=self.FILTER)
gax_api = _GAXMetricsAPI(_get_log_metric_response=metric_pb)
api = self._make_one(gax_api, None)
response = api.metric_get(self.PROJECT, self.METRIC_NAME)
self.assertEqual(response, RESPONSE)
metric_name, options = gax_api._get_log_metric_called_with
self.assertEqual(metric_name, self.METRIC_PATH)
self.assertIsNone(options)