Class MetricDescriptor (2.10.0)

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.

Inheritance

object > MetricDescriptor

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

MetricDescriptor()

public MetricDescriptor()

MetricDescriptor(MetricDescriptor)

public MetricDescriptor(MetricDescriptor other)
Parameter
NameDescription
otherMetricDescriptor

Fields

DescriptionFieldNumber

public const int DescriptionFieldNumber = 6

Field number for the "description" field.

Field Value
TypeDescription
int

DisplayNameFieldNumber

public const int DisplayNameFieldNumber = 7

Field number for the "display_name" field.

Field Value
TypeDescription
int

LabelsFieldNumber

public const int LabelsFieldNumber = 2

Field number for the "labels" field.

Field Value
TypeDescription
int

LaunchStageFieldNumber

public const int LaunchStageFieldNumber = 12

Field number for the "launch_stage" field.

Field Value
TypeDescription
int

MetadataFieldNumber

public const int MetadataFieldNumber = 10

Field number for the "metadata" field.

Field Value
TypeDescription
int

MetricKindFieldNumber

public const int MetricKindFieldNumber = 3

Field number for the "metric_kind" field.

Field Value
TypeDescription
int

MonitoredResourceTypesFieldNumber

public const int MonitoredResourceTypesFieldNumber = 13

Field number for the "monitored_resource_types" field.

Field Value
TypeDescription
int

NameFieldNumber

public const int NameFieldNumber = 1

Field number for the "name" field.

Field Value
TypeDescription
int

TypeFieldNumber

public const int TypeFieldNumber = 8

Field number for the "type" field.

Field Value
TypeDescription
int

UnitFieldNumber

public const int UnitFieldNumber = 5

Field number for the "unit" field.

Field Value
TypeDescription
int

ValueTypeFieldNumber

public const int ValueTypeFieldNumber = 4

Field number for the "value_type" field.

Field Value
TypeDescription
int

Properties

Description

public string Description { get; set; }

A detailed description of the metric, which can be used in documentation.

Property Value
TypeDescription
string

Descriptor

public static MessageDescriptor Descriptor { get; }
Property Value
TypeDescription
MessageDescriptor

DisplayName

public string DisplayName { get; set; }

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.

Property Value
TypeDescription
string

Labels

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.

Property Value
TypeDescription
RepeatedFieldLabelDescriptor

LaunchStage

public LaunchStage LaunchStage { get; set; }

Optional. The launch stage of the metric definition.

Property Value
TypeDescription
LaunchStage

Metadata

public MetricDescriptor.Types.MetricDescriptorMetadata Metadata { get; set; }

Optional. Metadata which can be used to guide usage of the metric.

Property Value
TypeDescription
MetricDescriptorTypesMetricDescriptorMetadata

MetricKind

public MetricDescriptor.Types.MetricKind MetricKind { get; set; }

Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.

Property Value
TypeDescription
MetricDescriptorTypesMetricKind

MonitoredResourceTypes

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.

Property Value
TypeDescription
RepeatedFieldstring

Name

public string Name { get; set; }

The resource name of the metric descriptor.

Property Value
TypeDescription
string

Parser

public static MessageParser<MetricDescriptor> Parser { get; }
Property Value
TypeDescription
MessageParserMetricDescriptor

Type

public string Type { get; set; }

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:

"custom.googleapis.com/invoice/paid/amount"
"external.googleapis.com/prometheus/up"
"appengine.googleapis.com/http/server/response_latencies"
Property Value
TypeDescription
string

Unit

public string Unit { get; set; }

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.02kBy might be displayed as 20By, and a value of 3523kBy might 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).

The supported units are a subset of The Unified Code for Units of Measure standard:

Basic units (UNIT)

  • bit bit
  • By byte
  • s second
  • min minute
  • h hour
  • d day
  • 1 dimensionless

Prefixes (PREFIX)

  • k kilo (10^3)
  • M mega (10^6)
  • G giga (10^9)
  • T tera (10^12)
  • P peta (10^15)
  • E exa (10^18)
  • Z zetta (10^21)

  • Y yotta (10^24)

  • m milli (10^-3)

  • u micro (10^-6)
  • n nano (10^-9)
  • p pico (10^-12)
  • f femto (10^-15)
  • a atto (10^-18)
  • z zepto (10^-21)

  • y yocto (10^-24)

  • Ki kibi (2^10)

  • Mi mebi (2^20)
  • Gi gibi (2^30)
  • Ti tebi (2^40)
  • Pi pebi (2^50)

Grammar

The grammar also includes these connectors:

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

The grammar for a unit is as follows:

Expression = Component { "." Component } { "/" Component } ;

Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ]
          | Annotation
          | "1"
          ;

Annotation = "{" NAME "}" ;

Notes:

  • 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").
Property Value
TypeDescription
string

ValueType

public MetricDescriptor.Types.ValueType ValueType { get; set; }

Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.

Property Value
TypeDescription
MetricDescriptorTypesValueType

Methods

CalculateSize()

public int CalculateSize()
Returns
TypeDescription
int

Clone()

public MetricDescriptor Clone()
Returns
TypeDescription
MetricDescriptor

Equals(MetricDescriptor)

public bool Equals(MetricDescriptor other)
Parameter
NameDescription
otherMetricDescriptor
Returns
TypeDescription
bool

Equals(object)

public override bool Equals(object other)
Parameter
NameDescription
otherobject
Returns
TypeDescription
bool
Overrides

GetHashCode()

public override int GetHashCode()
Returns
TypeDescription
int
Overrides

MergeFrom(MetricDescriptor)

public void MergeFrom(MetricDescriptor other)
Parameter
NameDescription
otherMetricDescriptor

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream

ToString()

public override string ToString()
Returns
TypeDescription
string
Overrides

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream