public final class LogMetric extends GeneratedMessageV3 implements LogMetricOrBuilder
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.
Protobuf type google.logging.v2.LogMetric
Fields
BUCKET_OPTIONS_FIELD_NUMBER
public static final int BUCKET_OPTIONS_FIELD_NUMBER
Field Value
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
public static final int LABEL_EXTRACTORS_FIELD_NUMBER
Field Value
METRIC_DESCRIPTOR_FIELD_NUMBER
public static final int METRIC_DESCRIPTOR_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
public static final int VALUE_EXTRACTOR_FIELD_NUMBER
Field Value
VERSION_FIELD_NUMBER
public static final int VERSION_FIELD_NUMBER
Field Value
Methods
public boolean containsLabelExtractors(String key)
Optional. 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 the 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.
map<string, string> label_extractors = 7 [(.google.api.field_behavior) = OPTIONAL];
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getBucketOptions()
public Distribution.BucketOptions getBucketOptions()
Optional. 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.
.google.api.Distribution.BucketOptions bucket_options = 8 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| com.google.api.Distribution.BucketOptions | The bucketOptions.
|
getBucketOptionsOrBuilder()
public Distribution.BucketOptionsOrBuilder getBucketOptionsOrBuilder()
Optional. 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.
.google.api.Distribution.BucketOptions bucket_options = 8 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| com.google.api.Distribution.BucketOptionsOrBuilder | |
getCreateTime()
public Timestamp getCreateTime()
Output only. The creation timestamp of the metric.
This field may not be present for older metrics.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The creation timestamp of the metric.
This field may not be present for older metrics.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstance()
public static LogMetric getDefaultInstance()
Returns
getDefaultInstanceForType()
public LogMetric getDefaultInstanceForType()
Returns
getDescription()
public String getDescription()
Optional. A description of this metric, which is used in documentation.
The maximum length of the description is 8000 characters.
string description = 2 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. A description of this metric, which is used in documentation.
The maximum length of the description is 8000 characters.
string description = 2 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| ByteString | The bytes for description.
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
getFilter()
public String getFilter()
Required. An advanced logs
filter which
is used to match log entries. Example:
"resource.type=gae_app AND severity>=ERROR"
The maximum length of the filter is 20000 characters.
string filter = 3 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| String | The filter.
|
getFilterBytes()
public ByteString getFilterBytes()
Required. An advanced logs
filter which
is used to match log entries. Example:
"resource.type=gae_app AND severity>=ERROR"
The maximum length of the filter is 20000 characters.
string filter = 3 [(.google.api.field_behavior) = REQUIRED];
public Map<String,String> getLabelExtractors()
Returns
public int getLabelExtractorsCount()
Optional. 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 the 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.
map<string, string> label_extractors = 7 [(.google.api.field_behavior) = OPTIONAL];
public Map<String,String> getLabelExtractorsMap()
Optional. 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 the 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.
map<string, string> label_extractors = 7 [(.google.api.field_behavior) = OPTIONAL];
public String getLabelExtractorsOrDefault(String key, String defaultValue)
Optional. 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 the 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.
map<string, string> label_extractors = 7 [(.google.api.field_behavior) = OPTIONAL];
public String getLabelExtractorsOrThrow(String key)
Optional. 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 the 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.
map<string, string> label_extractors = 7 [(.google.api.field_behavior) = OPTIONAL];
getMetricDescriptor()
public MetricDescriptor getMetricDescriptor()
Optional. 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.
.google.api.MetricDescriptor metric_descriptor = 5 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| com.google.api.MetricDescriptor | The metricDescriptor.
|
getMetricDescriptorOrBuilder()
public MetricDescriptorOrBuilder getMetricDescriptorOrBuilder()
Optional. 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.
.google.api.MetricDescriptor metric_descriptor = 5 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| com.google.api.MetricDescriptorOrBuilder | |
getName()
Required. 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.
The metric identifier in this field must not be
URL-encoded.
However, when the metric identifier appears as the [METRIC_ID] part of a
metric_name API parameter, then the metric identifier must be
URL-encoded. Example: "projects/my-project/metrics/nginx%2Frequests".
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Required. 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.
The metric identifier in this field must not be
URL-encoded.
However, when the metric identifier appears as the [METRIC_ID] part of a
metric_name API parameter, then the metric identifier must be
URL-encoded. Example: "projects/my-project/metrics/nginx%2Frequests".
string name = 1 [(.google.api.field_behavior) = REQUIRED];
getParserForType()
public Parser<LogMetric> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The last update timestamp of the metric.
This field may not be present for older metrics.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The last update timestamp of the metric.
This field may not be present for older metrics.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
public String getValueExtractor()
Optional. 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 argument 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+).")
string value_extractor = 6 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| String | The valueExtractor.
|
public ByteString getValueExtractorBytes()
Optional. 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 argument 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+).")
string value_extractor = 6 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| ByteString | The bytes for valueExtractor.
|
getVersion()
public LogMetric.ApiVersion getVersion()
Deprecated. The API version that created or updated this metric.
The v2 format is used by default and cannot be changed.
.google.logging.v2.LogMetric.ApiVersion version = 4 [deprecated = true];
getVersionValue()
public int getVersionValue()
Deprecated. The API version that created or updated this metric.
The v2 format is used by default and cannot be changed.
.google.logging.v2.LogMetric.ApiVersion version = 4 [deprecated = true];
| Type | Description |
| int | The enum numeric value on the wire for version.
|
hasBucketOptions()
public boolean hasBucketOptions()
Optional. 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.
.google.api.Distribution.BucketOptions bucket_options = 8 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the bucketOptions field is set.
|
hasCreateTime()
public boolean hasCreateTime()
Output only. The creation timestamp of the metric.
This field may not be present for older metrics.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the createTime field is set.
|
hasMetricDescriptor()
public boolean hasMetricDescriptor()
Optional. 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.
.google.api.MetricDescriptor metric_descriptor = 5 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the metricDescriptor field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. The last update timestamp of the metric.
This field may not be present for older metrics.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the updateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static LogMetric.Builder newBuilder()
Returns
newBuilder(LogMetric prototype)
public static LogMetric.Builder newBuilder(LogMetric prototype)
Parameter
Returns
newBuilderForType()
public LogMetric.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected LogMetric.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static LogMetric parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static LogMetric parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static LogMetric parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static LogMetric parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static LogMetric parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static LogMetric parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static LogMetric parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static LogMetric parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static LogMetric parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static LogMetric parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static LogMetric parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static LogMetric parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<LogMetric> parser()
Returns
toBuilder()
public LogMetric.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
