Struct googapis::google::logging::v2::LogMetric [−][src]
pub struct LogMetric {
pub name: String,
pub description: String,
pub filter: String,
pub metric_descriptor: Option<MetricDescriptor>,
pub value_extractor: String,
pub label_extractors: HashMap<String, String>,
pub bucket_options: Option<BucketOptions>,
pub create_time: Option<Timestamp>,
pub update_time: Option<Timestamp>,
pub version: i32,
}
Expand description
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.
Fields
name: String
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"
.
description: String
Optional. A description of this metric, which is used in documentation. The maximum length of the description is 8000 characters.
filter: String
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.
metric_descriptor: Option<MetricDescriptor>
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.
value_extractor: String
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+).*")
label_extractors: HashMap<String, String>
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.
bucket_options: Option<BucketOptions>
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.
create_time: Option<Timestamp>
Output only. The creation timestamp of the metric.
This field may not be present for older metrics.
update_time: Option<Timestamp>
Output only. The last update timestamp of the metric.
This field may not be present for older metrics.
version: i32
Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.
Implementations
Returns the enum value of version
, or the default if the field is set to an invalid enum value.
Sets version
to the provided enum value.
Trait Implementations
fn merge_field<B>(
&mut self,
tag: u32,
wire_type: WireType,
buf: &mut B,
ctx: DecodeContext
) -> Result<(), DecodeError> where
B: Buf,
Returns the encoded length of the message without a length delimiter.
Encodes the message to a buffer. Read more
Encodes the message to a newly allocated buffer.
Encodes the message with a length-delimiter to a buffer. Read more
Encodes the message with a length-delimiter to a newly allocated buffer.
Decodes an instance of the message from a buffer. Read more
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
Decodes a length-delimited instance of the message from the buffer.
Decodes an instance of the message from a buffer, and merges it into self
. Read more
Decodes a length-delimited instance of the message from buffer, and
merges it into self
. Read more
Auto Trait Implementations
impl RefUnwindSafe for LogMetric
impl UnwindSafe for LogMetric
Blanket Implementations
Mutably borrows from an owned value. Read more
Wrap the input message T
in a tonic::Request
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more