# Copyright 2018 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
module Google
module Api
# 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.
# @!attribute [rw] name
# @return [String]
# The resource name of the metric descriptor.
# @!attribute [rw] type
# @return [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"
# @!attribute [rw] labels
# @return [Array<Google::Api::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.
# @!attribute [rw] metric_kind
# @return [Google::Api::MetricDescriptor::MetricKind]
# Whether the metric records instantaneous values, changes to a value, etc.
# Some combinations of +metric_kind+ and +value_type+ might not be supported.
# @!attribute [rw] value_type
# @return [Google::Api::MetricDescriptor::ValueType]
# Whether the measurement is an integer, a floating-point number, etc.
# Some combinations of +metric_kind+ and +value_type+ might not be supported.
# @!attribute [rw] unit
# @return [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+ 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)
#
# **Grammar**
#
# The 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+, +By{transmitted}/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.
# @!attribute [rw] description
# @return [String]
# A detailed description of the metric, which can be used in documentation.
# @!attribute [rw] display_name
# @return [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.
class MetricDescriptor
# The kind of measurement. It describes how the data is reported.
module MetricKind
# Do not use this default value.
METRIC_KIND_UNSPECIFIED = 0
# An instantaneous measurement of a value.
GAUGE = 1
# The change in a value during a time interval.
DELTA = 2
# A value accumulated over a time interval. Cumulative
# measurements in a time series should have the same start time
# and increasing end times, until an event resets the cumulative
# value to zero and sets a new start time for the following
# points.
CUMULATIVE = 3
end
# The value type of a metric.
module ValueType
# Do not use this default value.
VALUE_TYPE_UNSPECIFIED = 0
# The value is a boolean.
# This value type can be used only if the metric kind is +GAUGE+.
BOOL = 1
# The value is a signed 64-bit integer.
INT64 = 2
# The value is a double precision floating point number.
DOUBLE = 3
# The value is a text string.
# This value type can be used only if the metric kind is +GAUGE+.
STRING = 4
# The value is a {Google::Api::Distribution +Distribution+}.
DISTRIBUTION = 5
# The value is money.
MONEY = 6
end
end
# A specific metric, identified by specifying values for all of the
# labels of a {Google::Api::MetricDescriptor +MetricDescriptor+}.
# @!attribute [rw] type
# @return [String]
# An existing metric type, see {Google::Api::MetricDescriptor}.
# For example, +custom.googleapis.com/invoice/paid/amount+.
# @!attribute [rw] labels
# @return [Hash{String => String}]
# The set of label values that uniquely identify this metric. All
# labels listed in the +MetricDescriptor+ must be assigned values.
class Metric; end
end
end