Class: Google::Apis::MonitoringV3::MetricDescriptor

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/monitoring_v3/classes.rb,
generated/google/apis/monitoring_v3/representations.rb,
generated/google/apis/monitoring_v3/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



1812
1813
1814
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1812

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

Instance Attribute Details

#description ⇒ String

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

Returns:

  • (String) 


1695
1696
1697
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1695

def description
  @description
end

#display_name ⇒ String

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) 


1703
1704
1705
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1703

def display_name
  @display_name
end

#labels ⇒ Array<Google::Apis::MonitoringV3::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

Returns:



1712
1713
1714
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1712

def labels
  @labels
end

#launch_stage ⇒ String

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

Returns:

  • (String) 


1717
1718
1719
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1717

def launch_stage
  @launch_stage
end

#metadata ⇒ Google::Apis::MonitoringV3::MetricDescriptorMetadata

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

Returns:



1722
1723
1724
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1722

def metadata
  @metadata
end

#metric_kind ⇒ String

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) 


1728
1729
1730
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1728

def metric_kind
  @metric_kind
end

#monitored_resource_types ⇒ Array<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>) 


1736
1737
1738
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1736

def monitored_resource_types
  @monitored_resource_types
end

#name ⇒ String

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

Returns:

  • (String) 


1741
1742
1743
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1741

def name
  @name
end

#type ⇒ String

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) 


1752
1753
1754
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1752

def type
  @type
end

#unit ⇒ String

The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d dayPrefixes (PREFIX) k kilo (10*3) M mega (106) G giga (109) T tera (1012) P peta (1015) E exa (1018) Z zetta (1021) Y yotta (1024) 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 (210) Mi mebi (220) Gi gibi (230) Ti tebi (2*40)GrammarThe grammar also includes these connectors: / division (as an infix operator, e.g. 1/s). . multiplication (as an infix operator, e.g. GBy.d)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 and is equivalent to 1 if it is used alone. For examples, requests/s == 1/s, Bytransmitted/s == By/ s. NAME is a sequence of non-blank printable ASCII characters not containing '' or ''. 1 represents dimensionless value 1, such as in 1/s. % represents dimensionless value 1/100, and annotates values giving a percentage. Corresponds to the JSON property unit

Returns:

  • (String) 


1804
1805
1806
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1804

def unit
  @unit
end

#value_type ⇒ String

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) 


1810
1811
1812
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1810

def value_type
  @value_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1817

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