Class: Google::Apis::ServiceusageV1::MetricDescriptor

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/serviceusage_v1/classes.rb,
generated/google/apis/serviceusage_v1/representations.rb,
generated/google/apis/serviceusage_v1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ MetricDescriptor

Returns a new instance of MetricDescriptor.



3062
3063
3064
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 3062

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#descriptionString

A detailed description of the metric, which can be used in documentation. Corresponds to the JSON property description

Returns:

  • (String)


2909
2910
2911
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2909

def description
  @description
end

#display_nameString

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. Corresponds to the JSON property displayName

Returns:

  • (String)


2917
2918
2919
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2917

def display_name
  @display_name
end

#labelsArray<Google::Apis::ServiceusageV1::LabelDescriptor>

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. Corresponds to the JSON property labels



2927
2928
2929
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2927

def labels
  @labels
end

#launch_stageString

Optional. The launch stage of the metric definition. Corresponds to the JSON property launchStage

Returns:

  • (String)


2932
2933
2934
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2932

def launch_stage
  @launch_stage
end

#metadataGoogle::Apis::ServiceusageV1::MetricDescriptorMetadata

Additional annotations that can be used to guide the usage of a metric. Corresponds to the JSON property metadata



2937
2938
2939
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2937

def 
  @metadata
end

#metric_kindString

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

Returns:

  • (String)


2943
2944
2945
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2943

def metric_kind
  @metric_kind
end

#monitored_resource_typesArray<String>

Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here. Corresponds to the JSON property monitoredResourceTypes

Returns:

  • (Array<String>)


2952
2953
2954
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2952

def monitored_resource_types
  @monitored_resource_types
end

#nameString

The resource name of the metric descriptor. Corresponds to the JSON property name

Returns:

  • (String)


2957
2958
2959
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2957

def name
  @name
end

#typeString

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" Corresponds to the JSON property type

Returns:

  • (String)


2968
2969
2970
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2968

def type
  @type
end

#unitString

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 may 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 may 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 sCPU(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 ksCPU, 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 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`orMiBy/10ms(although you should almost never have/sin a metricunit`; 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 kwatt.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,Bytransmitted/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 value5would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as1000/dork1/dorkpage_views/d(and a metric value of5.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"). Corresponds to the JSON property unit

Returns:

  • (String)


3054
3055
3056
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 3054

def unit
  @unit
end

#value_typeString

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

Returns:

  • (String)


3060
3061
3062
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 3060

def value_type
  @value_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 3067

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @labels = args[:labels] if args.key?(:labels)
  @launch_stage = args[:launch_stage] if args.key?(:launch_stage)
  @metadata = args[:metadata] if args.key?(:metadata)
  @metric_kind = args[:metric_kind] if args.key?(:metric_kind)
  @monitored_resource_types = args[:monitored_resource_types] if args.key?(:monitored_resource_types)
  @name = args[:name] if args.key?(:name)
  @type = args[:type] if args.key?(:type)
  @unit = args[:unit] if args.key?(:unit)
  @value_type = args[:value_type] if args.key?(:value_type)
end