Skip to main content

metrics

Creates, updates, deletes, gets or lists a metrics resource.

Overview​

Namemetrics
TypeResource
Idgoogle.logging.metrics

Fields​

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringRequired. The client-assigned metric identifier. Examples: "error_count", "nginx/requests".Metric identifiers are limited to 100 characters and can include only the following characters: A-Z, a-z, 0-9, and the special characters _-.,+!*',()%/. The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name.This field is the [METRIC_ID] part of a metric resource name in the format "projects/PROJECT_ID/metrics/METRIC_ID". Example: If the resource name of a metric is "projects/my-project/metrics/nginx%2Frequests", this field's value is "nginx/requests".
bucketNamestringOptional. The resource name of the Log Bucket that owns the Log Metric. Only Log Buckets in projects are supported. The bucket has to be in the same project as the metric.For example:projects/my-project/locations/global/buckets/my-bucketIf empty, then the Log Metric is considered a non-Bucket Log Metric.
bucketOptionsobjectOptional. The bucket_options are required when the logs-based metric is using a DISTRIBUTION value type and it describes the bucket boundaries used to create a histogram of the extracted values. (id: BucketOptions)
createTimestring (google-datetime)Output only. The creation timestamp of the metric.This field may not be present for older metrics.
descriptionstringOptional. A description of this metric, which is used in documentation. The maximum length of the description is 8000 characters.
disabledbooleanOptional. If set to True, then this metric is disabled and it does not generate any points.
filterstringRequired. An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced_filters) which is used to match log entries. Example: "resource.type=gae_app AND severity>=ERROR" The maximum length of the filter is 20000 characters.
labelExtractorsobjectOptional. A map from a label key string to an extractor expression which is used to extract data from a log entry field and assign as the label value. Each label key specified in the LabelDescriptor must have an associated extractor expression in this map. The syntax of the extractor expression is the same as for the value_extractor field.The extracted value is converted to the type defined in the label descriptor. If either the extraction or the type conversion fails, the label will have a default value. The default value for a string label is an empty string, for an integer label its 0, and for a boolean label its false.Note that there are upper bounds on the maximum number of labels and the number of active time series that are allowed in a project.
metricDescriptorobjectOptional. The metric descriptor associated with the logs-based metric. If unspecified, it uses a default metric descriptor with a DELTA metric kind, INT64 value type, with no labels and a unit of "1". Such a metric counts the number of log entries matching the filter expression.The name, type, and description fields in the metric_descriptor are output only, and is constructed using the name and description field in the LogMetric.To create a logs-based metric that records a distribution of log values, a DELTA metric kind with a DISTRIBUTION value type must be used along with a value_extractor expression in the LogMetric.Each label in the metric descriptor must have a matching label name as the key and an extractor expression as the value in the label_extractors map.The metric_kind and value_type fields in the metric_descriptor cannot be updated once initially configured. New labels can be added in the metric_descriptor, but existing labels cannot be modified except for their description. (id: MetricDescriptor)
resourceNamestringOutput only. The resource name of the metric: "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
updateTimestring (google-datetime)Output only. The last update timestamp of the metric.This field may not be present for older metrics.
valueExtractorstringOptional. A value_extractor is required when using a distribution logs-based metric to extract the values to record from a log entry. Two functions are supported for value extraction: EXTRACT(field) or REGEXP_EXTRACT(field, regex). The arguments are: field: The name of the log entry field from which the value is to be extracted. regex: A regular expression using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax) with a single capture group to extract data from the specified log entry field. The value of the field is converted to a string before applying the regex. It is an error to specify a regex that does not include exactly one capture group.The result of the extraction must be convertible to a double type, as the distribution always records double values. If either the extraction or the conversion to double fails, then those values are not recorded in the distribution.Example: REGEXP_EXTRACT(jsonPayload.request, ".quantity=(\d+).")
versionstringDeprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
projects_metrics_getselectprojectsId, metricsIdGets a logs-based metric.
projects_metrics_listselectprojectsIdpageToken, pageSizeLists logs-based metrics.
projects_metrics_createinsertprojectsIdCreates a logs-based metric.
projects_metrics_updatereplaceprojectsId, metricsIdCreates or updates a logs-based metric.
projects_metrics_deletedeleteprojectsId, metricsIdDeletes a logs-based metric.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
metricsIdstring
projectsIdstring
pageSizeinteger (int32)
pageTokenstring

SELECT examples​

Gets a logs-based metric.

SELECT
name,
bucketName,
bucketOptions,
createTime,
description,
disabled,
filter,
labelExtractors,
metricDescriptor,
resourceName,
updateTime,
valueExtractor,
version
FROM google.logging.metrics
WHERE projectsId = '{{ projectsId }}' -- required
AND metricsId = '{{ metricsId }}' -- required;

INSERT examples​

Creates a logs-based metric.

INSERT INTO google.logging.metrics (
data__name,
data__description,
data__filter,
data__bucketName,
data__disabled,
data__metricDescriptor,
data__valueExtractor,
data__labelExtractors,
data__bucketOptions,
data__version,
projectsId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ filter }}',
'{{ bucketName }}',
{{ disabled }},
'{{ metricDescriptor }}',
'{{ valueExtractor }}',
'{{ labelExtractors }}',
'{{ bucketOptions }}',
'{{ version }}',
'{{ projectsId }}'
RETURNING
name,
bucketName,
bucketOptions,
createTime,
description,
disabled,
filter,
labelExtractors,
metricDescriptor,
resourceName,
updateTime,
valueExtractor,
version
;

REPLACE examples​

Creates or updates a logs-based metric.

REPLACE google.logging.metrics
SET 
data__name = '{{ name }}',
data__description = '{{ description }}',
data__filter = '{{ filter }}',
data__bucketName = '{{ bucketName }}',
data__disabled = {{ disabled }},
data__metricDescriptor = '{{ metricDescriptor }}',
data__valueExtractor = '{{ valueExtractor }}',
data__labelExtractors = '{{ labelExtractors }}',
data__bucketOptions = '{{ bucketOptions }}',
data__version = '{{ version }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND metricsId = '{{ metricsId }}' --required
RETURNING
name,
bucketName,
bucketOptions,
createTime,
description,
disabled,
filter,
labelExtractors,
metricDescriptor,
resourceName,
updateTime,
valueExtractor,
version;

DELETE examples​

Deletes a logs-based metric.

DELETE FROM google.logging.metrics
WHERE projectsId = '{{ projectsId }}' --required
AND metricsId = '{{ metricsId }}' --required;