public sealed class MetricDescriptor : IMessage<MetricDescriptor>, IEquatable<MetricDescriptor>, IDeepCloneable<MetricDescriptor>, IBufferMessage, IMessage
Defines a metric type and its schema. Once a metric descriptor is created,
deleting or altering it stops data collection and makes the metric type's
existing data unusable.
A concise name for the metric, which can be displayed in user interfaces.
Use sentence case without an ending period, for example "Request count".
This field is optional but it is recommended to be set for any metrics
associated with user-visible concepts, such as Quota.
public RepeatedField<LabelDescriptor> Labels { get; }
The set of labels that can be used to describe a specific
instance of this metric type. For example, the
appengine.googleapis.com/http/server/response_latencies metric
type has a label for the HTTP response code, response_code, so
you can look at latencies for successful responses or just
for responses that failed.
public RepeatedField<string> MonitoredResourceTypes { get; }
Read-only. If present, then a [time
series][google.monitoring.v3.TimeSeries], which is identified partially by
a metric type and a
[MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor], that
is associated with this metric type can only be associated with one of the
monitored resource types listed here.
The metric type, including its DNS name prefix. The type is not
URL-encoded. All user-defined metric types have the DNS name
custom.googleapis.com or external.googleapis.com. Metric types should
use a natural hierarchical grouping. For example:
The units in which the metric value is reported. It is only applicable
if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit
defines the representation of the stored metric values.
Different systems might scale the values to be more easily displayed (so a
value of 0.02kBymight be displayed as 20By, and a value of
3523kBymight be displayed as 3.5MBy). However, if the unit is
kBy, then the value of the metric is always in thousands of bytes, no
matter how it might be displayed.
If you want a custom metric to record the exact number of CPU-seconds used
by a job, you can create an INT64 CUMULATIVE metric whose unit is
s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005
CPU-seconds, then the value is written as 12005.
Alternatively, if you want a custom metric to record data in a more
granular way, you can create a DOUBLE CUMULATIVE metric whose unit is
ks{CPU}, and then write the value 12.005 (which is 12005/1000),
or use Kis{CPU} and write 11.723 (which is 12005/1024).
/ division or ratio (as an infix operator). For examples,
kBy/{email} or MiBy/10ms (although you should almost never
have /s in a metric unit; rates should always be computed at
query time from the underlying cumulative or delta value).
. multiplication or composition (as an infix operator). For
examples, GBy.d or k{watt}.h.
Annotation is just a comment if it follows a UNIT. If the annotation
is used alone, then the unit is equivalent to 1. For examples,
{request}/s == 1/s, By{transmitted}/s == By/s.
NAME is a sequence of non-blank printable ASCII characters not
containing { or }.
1 represents a unitary dimensionless
unit of 1, such
as in 1/s. It is typically used when none of the basic units are
appropriate. For example, "new users per day" can be represented as
1/d or {new-users}/d (and a metric value 5 would mean "5 new
users). Alternatively, "thousands of page views per day" would be
represented as 1000/d or k1/d or k{page_views}/d (and a metric
value of 5.3 would mean "5300 page views per day").
% represents dimensionless value of 1/100, and annotates values giving
a percentage (so the metric values are typically in the range of 0..100,
and a metric value 3 means "3 percent").
10^2.% indicates a metric contains a ratio, typically in the range
0..1, that will be multiplied by 100 and displayed as a percentage
(so a metric value 0.03 means "3 percent").
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-12 UTC."],[[["The `MetricDescriptor` class defines a metric type and its schema, and once created, it cannot be altered or deleted without impacting data collection and usability."],["The class inherits from `object` and implements multiple interfaces such as `IMessage`, `IEquatable`, `IDeepCloneable`, and `IBufferMessage` to support various functionalities."],["`MetricDescriptor` contains fields such as `DescriptionFieldNumber`, `DisplayNameFieldNumber`, and `LabelsFieldNumber` that define the data being collected by the metric."],["Properties such as `Description`, `DisplayName`, and `Labels` provide specific details about the metric being defined."],["The `MetricDescriptor` class supports methods like `Clone`, `Equals`, `MergeFrom`, and `WriteTo` to handle object operations and data manipulation."]]],[]]