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 metric can also be used to extract values from logs and create a 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| Modifier and Type | Class and Description |
|---|---|
static class |
LogMetric.ApiVersion
Stackdriver Logging API version.
|
static class |
LogMetric.Builder
Describes a logs-based metric.
|
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable| Modifier and Type | Field and Description |
|---|---|
static int |
BUCKET_OPTIONS_FIELD_NUMBER |
static int |
DESCRIPTION_FIELD_NUMBER |
static int |
FILTER_FIELD_NUMBER |
static int |
LABEL_EXTRACTORS_FIELD_NUMBER |
static int |
METRIC_DESCRIPTOR_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
VALUE_EXTRACTOR_FIELD_NUMBER |
static int |
VERSION_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFieldsmemoizedSizememoizedHashCodecanUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneoftoByteArray, toByteString, writeDelimitedTo, writeTopublic static final int NAME_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
public static final int METRIC_DESCRIPTOR_FIELD_NUMBER
public static final int VALUE_EXTRACTOR_FIELD_NUMBER
public static final int LABEL_EXTRACTORS_FIELD_NUMBER
public static final int BUCKET_OPTIONS_FIELD_NUMBER
public static final int VERSION_FIELD_NUMBER
public final UnknownFieldSet getUnknownFields()
getUnknownFields in interface MessageOrBuildergetUnknownFields in class GeneratedMessageV3public static final Descriptors.Descriptor getDescriptor()
protected MapField internalGetMapField(int number)
internalGetMapField in class GeneratedMessageV3protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class GeneratedMessageV3public java.lang.String 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](https://en.wikipedia.org/wiki/Percent-encoding). 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;getName in interface LogMetricOrBuilderpublic 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](https://en.wikipedia.org/wiki/Percent-encoding). 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;getNameBytes in interface LogMetricOrBuilderpublic java.lang.String getDescription()
Optional. A description of this metric, which is used in documentation.
string description = 2;getDescription in interface LogMetricOrBuilderpublic ByteString getDescriptionBytes()
Optional. A description of this metric, which is used in documentation.
string description = 2;getDescriptionBytes in interface LogMetricOrBuilderpublic java.lang.String getFilter()
Required. An [advanced logs filter](/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.
string filter = 3;getFilter in interface LogMetricOrBuilderpublic ByteString getFilterBytes()
Required. An [advanced logs filter](/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.
string filter = 3;getFilterBytes in interface LogMetricOrBuilderpublic 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;hasMetricDescriptor in interface LogMetricOrBuilderpublic 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;getMetricDescriptor in interface LogMetricOrBuilderpublic 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;getMetricDescriptorOrBuilder in interface LogMetricOrBuilderpublic java.lang.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:
1. field: The name of the log entry field from which the value is to be
extracted.
2. 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;getValueExtractor in interface LogMetricOrBuilderpublic 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:
1. field: The name of the log entry field from which the value is to be
extracted.
2. 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;getValueExtractorBytes in interface LogMetricOrBuilderpublic int getLabelExtractorsCount()
LogMetricOrBuilderOptional. 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;getLabelExtractorsCount in interface LogMetricOrBuilderpublic boolean containsLabelExtractors(java.lang.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;containsLabelExtractors in interface LogMetricOrBuilder@Deprecated public java.util.Map<java.lang.String,java.lang.String> getLabelExtractors()
getLabelExtractorsMap() instead.getLabelExtractors in interface LogMetricOrBuilderpublic java.util.Map<java.lang.String,java.lang.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;getLabelExtractorsMap in interface LogMetricOrBuilderpublic java.lang.String getLabelExtractorsOrDefault(java.lang.String key,
java.lang.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;getLabelExtractorsOrDefault in interface LogMetricOrBuilderpublic java.lang.String getLabelExtractorsOrThrow(java.lang.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;getLabelExtractorsOrThrow in interface LogMetricOrBuilderpublic 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;hasBucketOptions in interface LogMetricOrBuilderpublic 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;getBucketOptions in interface LogMetricOrBuilderpublic 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;getBucketOptionsOrBuilder in interface LogMetricOrBuilderpublic 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;getVersionValue in interface LogMetricOrBuilderpublic 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;getVersion in interface LogMetricOrBuilderpublic final boolean isInitialized()
isInitialized in interface MessageLiteOrBuilderisInitialized in class GeneratedMessageV3public void writeTo(CodedOutputStream output) throws java.io.IOException
writeTo in interface MessageLitewriteTo in class GeneratedMessageV3java.io.IOExceptionpublic int getSerializedSize()
getSerializedSize in interface MessageLitegetSerializedSize in class GeneratedMessageV3public boolean equals(java.lang.Object obj)
equals in interface Messageequals in class AbstractMessagepublic int hashCode()
hashCode in interface MessagehashCode in class AbstractMessagepublic static LogMetric parseFrom(java.nio.ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static LogMetric parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static LogMetric parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static LogMetric parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static LogMetric parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static LogMetric parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static LogMetric parseFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOExceptionpublic static LogMetric parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic static LogMetric parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOExceptionpublic static LogMetric parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic static LogMetric parseFrom(CodedInputStream input) throws java.io.IOException
java.io.IOExceptionpublic static LogMetric parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic LogMetric.Builder newBuilderForType()
newBuilderForType in interface MessagenewBuilderForType in interface MessageLitepublic static LogMetric.Builder newBuilder()
public static LogMetric.Builder newBuilder(LogMetric prototype)
public LogMetric.Builder toBuilder()
toBuilder in interface MessagetoBuilder in interface MessageLiteprotected LogMetric.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class GeneratedMessageV3public static LogMetric getDefaultInstance()
public Parser<LogMetric> getParserForType()
getParserForType in interface MessagegetParserForType in interface MessageLitegetParserForType in class GeneratedMessageV3public LogMetric getDefaultInstanceForType()
getDefaultInstanceForType in interface MessageLiteOrBuildergetDefaultInstanceForType in interface MessageOrBuilder