Class: Google::Apis::LoggingV2::MetricDescriptor
- Inherits:
-
Object
- Object
- Google::Apis::LoggingV2::MetricDescriptor
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/logging_v2/classes.rb,
generated/google/apis/logging_v2/representations.rb,
generated/google/apis/logging_v2/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
-
#description ⇒ String
A detailed description of the metric, which can be used in documentation.
-
#display_name ⇒ String
A concise name for the metric, which can be displayed in user interfaces.
-
#labels ⇒ Array<Google::Apis::LoggingV2::LabelDescriptor>
The set of labels that can be used to describe a specific instance of this metric type.
-
#launch_stage ⇒ String
Optional.
-
#metadata ⇒ Google::Apis::LoggingV2::MetricDescriptorMetadata
Additional annotations that can be used to guide the usage of a metric.
-
#metric_kind ⇒ String
Whether the metric records instantaneous values, changes to a value, etc.
-
#name ⇒ String
The resource name of the metric descriptor.
-
#type ⇒ String
The metric type, including its DNS name prefix.
-
#unit ⇒ String
The unit in which the metric value is reported.
-
#value_type ⇒ String
Whether the measurement is an integer, a floating-point number, etc.
Instance Method Summary collapse
-
#initialize(**args) ⇒ MetricDescriptor
constructor
A new instance of MetricDescriptor.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ MetricDescriptor
Returns a new instance of MetricDescriptor
1296 1297 1298 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1296 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
1187 1188 1189 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1187 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
1195 1196 1197 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1195 def display_name @display_name end |
#labels ⇒ Array<Google::Apis::LoggingV2::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
1204 1205 1206 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1204 def labels @labels end |
#launch_stage ⇒ String
Optional. The launch stage of the metric definition.
Corresponds to the JSON property launchStage
1209 1210 1211 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1209 def launch_stage @launch_stage end |
#metadata ⇒ Google::Apis::LoggingV2::MetricDescriptorMetadata
Additional annotations that can be used to guide the usage of a metric.
Corresponds to the JSON property metadata
1214 1215 1216 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1214 def @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
1220 1221 1222 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1220 def metric_kind @metric_kind end |
#name ⇒ String
The resource name of the metric descriptor.
Corresponds to the JSON property name
1225 1226 1227 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1225 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
1236 1237 1238 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1236 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
1288 1289 1290 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1288 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
1294 1295 1296 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1294 def value_type @value_type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 |
# File 'generated/google/apis/logging_v2/classes.rb', line 1301 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) @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 |