def get_log_metric(
self,
request: logging_metrics.GetLogMetricRequest = None,
*,
metric_name: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> logging_metrics.LogMetric:
r"""Gets a logs-based metric.
Args:
request (google.cloud.logging_v2.types.GetLogMetricRequest):
The request object. The parameters to GetLogMetric.
metric_name (str):
Required. The resource name of the desired metric:
::
"projects/[PROJECT_ID]/metrics/[METRIC_ID]"
This corresponds to the ``metric_name`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
google.cloud.logging_v2.types.LogMetric:
Describes a logs-based metric. The
value of the metric is the number of log
entries that match a logs filter in a
given time interval.
Logs-based metrics can also be used to
extract values from logs and create a
distribution of the values. The
distribution records the statistics of
the extracted values along with an
optional histogram of the values as
specified by the bucket options.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([metric_name])
if request is not None and has_flattened_params:
raise ValueError('If the `request` argument is set, then none of '
'the individual field arguments should be set.')
# Minor optimization to avoid making a copy if the user passes
# in a logging_metrics.GetLogMetricRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, logging_metrics.GetLogMetricRequest):
request = logging_metrics.GetLogMetricRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if metric_name is not None:
request.metric_name = metric_name
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.get_log_metric]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("metric_name", request.metric_name), )), )
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
async def get_log_metric(
self,
request: logging_metrics.GetLogMetricRequest = None,
*,
metric_name: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> logging_metrics.LogMetric:
r"""Gets a logs-based metric.
Args:
request (:class:`~.logging_metrics.GetLogMetricRequest`):
The request object. The parameters to GetLogMetric.
metric_name (:class:`str`):
Required. The resource name of the desired metric:
::
"projects/[PROJECT_ID]/metrics/[METRIC_ID]".
This corresponds to the ``metric_name`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
~.logging_metrics.LogMetric:
Describes a logs-based metric. The
value of the metric is the number of log
entries that match a logs filter in a
given time interval.
Logs-based metrics can also be used to
extract values from logs and create a
distribution of the values. The
distribution records the statistics of
the extracted values along with an
optional histogram of the values as
specified by the bucket options.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([metric_name])
if request is not None and has_flattened_params:
raise ValueError("If the `request` argument is set, then none of "
"the individual field arguments should be set.")
request = logging_metrics.GetLogMetricRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if metric_name is not None:
request.metric_name = metric_name
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.get_log_metric,
default_retry=retries.Retry(
initial=0.1,
maximum=60.0,
multiplier=1.3,
predicate=retries.if_exception_type(
exceptions.DeadlineExceeded,
exceptions.InternalServerError,
exceptions.ServiceUnavailable,
),
),
default_timeout=60.0,
client_info=DEFAULT_CLIENT_INFO,
)
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("metric_name", request.metric_name), )), )
# Send the request.
response = await rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response