Google Cloud Logging v2 API - Class LogMetric (4.3.0) 

public sealed class LogMetric : IMessage<LogMetric>, IEquatable<LogMetric>, IDeepCloneable<LogMetric>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Logging v2 API class 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.

Inheritance

object > LogMetric

Namespace

Google.Cloud.Logging.V2

Assembly

Google.Cloud.Logging.V2.dll

Constructors

LogMetric()

public LogMetric()

LogMetric(LogMetric)

public LogMetric(LogMetric other)
Parameter
Name Description
other LogMetric

Properties

BucketName

public string BucketName { get; set; }

Optional. 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-bucket

If empty, then the Log Metric is considered a non-Bucket Log Metric.

Property Value
Type Description
string

BucketOptions

public Distribution.Types.BucketOptions BucketOptions { get; set; }

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.

Property Value
Type Description
DistributionTypesBucketOptions

CreateTime

public Timestamp CreateTime { get; set; }

Output only. The creation timestamp of the metric.

This field may not be present for older metrics.

Property Value
Type Description
Timestamp

Description

public string Description { get; set; }

Optional. A description of this metric, which is used in documentation. The maximum length of the description is 8000 characters.

Property Value
Type Description
string

Disabled

public bool Disabled { get; set; }

Optional. If set to True, then this metric is disabled and it does not generate any points.

Property Value
Type Description
bool

Filter

public string Filter { get; set; }

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.

Property Value
Type Description
string

LabelExtractors

public MapField<string, string> LabelExtractors { get; }

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 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.

Property Value
Type Description
MapFieldstringstring

LogMetricName

public LogMetricName LogMetricName { get; set; }

LogMetricName-typed view over the Name resource name property.

Property Value
Type Description
LogMetricName

Name

public string Name { get; set; }

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.

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".

Property Value
Type Description
string

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. The last update timestamp of the metric.

This field may not be present for older metrics.

Property Value
Type Description
Timestamp

ValueExtractor

public string ValueExtractor { get; set; }

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 arguments 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+).*")

Property Value
Type Description
string

Version

[Obsolete]
public LogMetric.Types.ApiVersion Version { get; set; }

Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.

Property Value
Type Description
LogMetricTypesApiVersion