Class: Google::Apis::LoggingV2beta1::MetricDescriptor

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



1163
1164
1165
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 1163

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) 


1066
1067
1068
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 1066

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) 


1074
1075
1076
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 1074

def display_name
  @display_name
end

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



1083
1084
1085
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 1083

def labels
  @labels
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) 


1089
1090
1091
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 1089

def metric_kind
  @metric_kind
end

#name ⇒ String

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

Returns:

  • (String) 


1094
1095
1096
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 1094

def name
  @name
end

#type ⇒ String

The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined custom metric types have the DNS name custom.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "appengine.googleapis.com/http/server/response_latencies" Corresponds to the JSON property type

Returns:

  • (String) 


1103
1104
1105
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 1103

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) 


1155
1156
1157
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 1155

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) 


1161
1162
1163
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 1161

def value_type
  @value_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 1168

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)
  @metric_kind = args[:metric_kind] if args.key?(:metric_kind)
  @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