Class: Google::Api::MetricDescriptor
- Inherits:
-
Object
- Object
- Google::Api::MetricDescriptor
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/api/metric.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.
Defined Under Namespace
Modules: MetricKind, ValueType Classes: MetricDescriptorMetadata
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::Api::LabelDescriptor>
The set of labels that can be used to describe a specific instance of this metric type.
-
#launch_stage ⇒ ::Google::Api::LaunchStage
Optional.
-
#metadata ⇒ ::Google::Api::MetricDescriptor::MetricDescriptorMetadata
Optional.
-
#metric_kind ⇒ ::Google::Api::MetricDescriptor::MetricKind
Whether the metric records instantaneous values, changes to a value, etc.
-
#monitored_resource_types ⇒ ::Array<::String>
Read-only.
-
#name ⇒ ::String
The resource name of the metric descriptor.
-
#type ⇒ ::String
The metric type, including its DNS name prefix.
-
#unit ⇒ ::String
The units in which the metric value is reported.
-
#value_type ⇒ ::Google::Api::MetricDescriptor::ValueType
Whether the measurement is an integer, a floating-point number, etc.
Instance Attribute Details
#description ⇒ ::String
Returns A detailed description of the metric, which can be used in documentation.
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'proto_docs/google/api/metric.rb', line 181 class MetricDescriptor include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Additional annotations that can be used to guide the usage of a metric. # @!attribute [rw] launch_stage # @deprecated This field is deprecated and may be removed in the next major version update. # @return [::Google::Api::LaunchStage] # Deprecated. Must use the # {::Google::Api::MetricDescriptor#launch_stage MetricDescriptor.launch_stage} # instead. # @!attribute [rw] sample_period # @return [::Google::Protobuf::Duration] # The sampling period of metric data points. For metrics which are written # periodically, consecutive data points are stored at this time interval, # excluding data loss due to errors. Metrics with a higher granularity have # a smaller sampling period. # @!attribute [rw] ingest_delay # @return [::Google::Protobuf::Duration] # The delay of data points caused by ingestion. Data points older than this # age are guaranteed to be ingested and available to be read, excluding # data loss due to errors. # @!attribute [rw] time_series_resource_hierarchy_level # @return [::Array<::Google::Api::MetricDescriptor::MetricDescriptorMetadata::TimeSeriesResourceHierarchyLevel>] # The scope of the timeseries data of the metric. class MetricDescriptorMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The resource hierarchy level of the timeseries data of a metric. module TimeSeriesResourceHierarchyLevel # Do not use this default value. TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED = 0 # Scopes a metric to a project. PROJECT = 1 # Scopes a metric to an organization. ORGANIZATION = 2 # Scopes a metric to a folder. FOLDER = 3 end end # The kind of measurement. It describes how the data is reported. # For information on setting the start time and end time based on # the MetricKind, see {::Google::Cloud::Monitoring::V3::TimeInterval TimeInterval}. 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 |
#display_name ⇒ ::String
Returns 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.
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'proto_docs/google/api/metric.rb', line 181 class MetricDescriptor include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Additional annotations that can be used to guide the usage of a metric. # @!attribute [rw] launch_stage # @deprecated This field is deprecated and may be removed in the next major version update. # @return [::Google::Api::LaunchStage] # Deprecated. Must use the # {::Google::Api::MetricDescriptor#launch_stage MetricDescriptor.launch_stage} # instead. # @!attribute [rw] sample_period # @return [::Google::Protobuf::Duration] # The sampling period of metric data points. For metrics which are written # periodically, consecutive data points are stored at this time interval, # excluding data loss due to errors. Metrics with a higher granularity have # a smaller sampling period. # @!attribute [rw] ingest_delay # @return [::Google::Protobuf::Duration] # The delay of data points caused by ingestion. Data points older than this # age are guaranteed to be ingested and available to be read, excluding # data loss due to errors. # @!attribute [rw] time_series_resource_hierarchy_level # @return [::Array<::Google::Api::MetricDescriptor::MetricDescriptorMetadata::TimeSeriesResourceHierarchyLevel>] # The scope of the timeseries data of the metric. class MetricDescriptorMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The resource hierarchy level of the timeseries data of a metric. module TimeSeriesResourceHierarchyLevel # Do not use this default value. TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED = 0 # Scopes a metric to a project. PROJECT = 1 # Scopes a metric to an organization. ORGANIZATION = 2 # Scopes a metric to a folder. FOLDER = 3 end end # The kind of measurement. It describes how the data is reported. # For information on setting the start time and end time based on # the MetricKind, see {::Google::Cloud::Monitoring::V3::TimeInterval TimeInterval}. 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 |
#labels ⇒ ::Array<::Google::Api::LabelDescriptor>
Returns 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.
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'proto_docs/google/api/metric.rb', line 181 class MetricDescriptor include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Additional annotations that can be used to guide the usage of a metric. # @!attribute [rw] launch_stage # @deprecated This field is deprecated and may be removed in the next major version update. # @return [::Google::Api::LaunchStage] # Deprecated. Must use the # {::Google::Api::MetricDescriptor#launch_stage MetricDescriptor.launch_stage} # instead. # @!attribute [rw] sample_period # @return [::Google::Protobuf::Duration] # The sampling period of metric data points. For metrics which are written # periodically, consecutive data points are stored at this time interval, # excluding data loss due to errors. Metrics with a higher granularity have # a smaller sampling period. # @!attribute [rw] ingest_delay # @return [::Google::Protobuf::Duration] # The delay of data points caused by ingestion. Data points older than this # age are guaranteed to be ingested and available to be read, excluding # data loss due to errors. # @!attribute [rw] time_series_resource_hierarchy_level # @return [::Array<::Google::Api::MetricDescriptor::MetricDescriptorMetadata::TimeSeriesResourceHierarchyLevel>] # The scope of the timeseries data of the metric. class MetricDescriptorMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The resource hierarchy level of the timeseries data of a metric. module TimeSeriesResourceHierarchyLevel # Do not use this default value. TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED = 0 # Scopes a metric to a project. PROJECT = 1 # Scopes a metric to an organization. ORGANIZATION = 2 # Scopes a metric to a folder. FOLDER = 3 end end # The kind of measurement. It describes how the data is reported. # For information on setting the start time and end time based on # the MetricKind, see {::Google::Cloud::Monitoring::V3::TimeInterval TimeInterval}. 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 |
#launch_stage ⇒ ::Google::Api::LaunchStage
Returns Optional. The launch stage of the metric definition.
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'proto_docs/google/api/metric.rb', line 181 class MetricDescriptor include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Additional annotations that can be used to guide the usage of a metric. # @!attribute [rw] launch_stage # @deprecated This field is deprecated and may be removed in the next major version update. # @return [::Google::Api::LaunchStage] # Deprecated. Must use the # {::Google::Api::MetricDescriptor#launch_stage MetricDescriptor.launch_stage} # instead. # @!attribute [rw] sample_period # @return [::Google::Protobuf::Duration] # The sampling period of metric data points. For metrics which are written # periodically, consecutive data points are stored at this time interval, # excluding data loss due to errors. Metrics with a higher granularity have # a smaller sampling period. # @!attribute [rw] ingest_delay # @return [::Google::Protobuf::Duration] # The delay of data points caused by ingestion. Data points older than this # age are guaranteed to be ingested and available to be read, excluding # data loss due to errors. # @!attribute [rw] time_series_resource_hierarchy_level # @return [::Array<::Google::Api::MetricDescriptor::MetricDescriptorMetadata::TimeSeriesResourceHierarchyLevel>] # The scope of the timeseries data of the metric. class MetricDescriptorMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The resource hierarchy level of the timeseries data of a metric. module TimeSeriesResourceHierarchyLevel # Do not use this default value. TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED = 0 # Scopes a metric to a project. PROJECT = 1 # Scopes a metric to an organization. ORGANIZATION = 2 # Scopes a metric to a folder. FOLDER = 3 end end # The kind of measurement. It describes how the data is reported. # For information on setting the start time and end time based on # the MetricKind, see {::Google::Cloud::Monitoring::V3::TimeInterval TimeInterval}. 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 |
#metadata ⇒ ::Google::Api::MetricDescriptor::MetricDescriptorMetadata
Returns Optional. Metadata which can be used to guide usage of the metric.
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'proto_docs/google/api/metric.rb', line 181 class MetricDescriptor include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Additional annotations that can be used to guide the usage of a metric. # @!attribute [rw] launch_stage # @deprecated This field is deprecated and may be removed in the next major version update. # @return [::Google::Api::LaunchStage] # Deprecated. Must use the # {::Google::Api::MetricDescriptor#launch_stage MetricDescriptor.launch_stage} # instead. # @!attribute [rw] sample_period # @return [::Google::Protobuf::Duration] # The sampling period of metric data points. For metrics which are written # periodically, consecutive data points are stored at this time interval, # excluding data loss due to errors. Metrics with a higher granularity have # a smaller sampling period. # @!attribute [rw] ingest_delay # @return [::Google::Protobuf::Duration] # The delay of data points caused by ingestion. Data points older than this # age are guaranteed to be ingested and available to be read, excluding # data loss due to errors. # @!attribute [rw] time_series_resource_hierarchy_level # @return [::Array<::Google::Api::MetricDescriptor::MetricDescriptorMetadata::TimeSeriesResourceHierarchyLevel>] # The scope of the timeseries data of the metric. class MetricDescriptorMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The resource hierarchy level of the timeseries data of a metric. module TimeSeriesResourceHierarchyLevel # Do not use this default value. TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED = 0 # Scopes a metric to a project. PROJECT = 1 # Scopes a metric to an organization. ORGANIZATION = 2 # Scopes a metric to a folder. FOLDER = 3 end end # The kind of measurement. It describes how the data is reported. # For information on setting the start time and end time based on # the MetricKind, see {::Google::Cloud::Monitoring::V3::TimeInterval TimeInterval}. 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 |
#metric_kind ⇒ ::Google::Api::MetricDescriptor::MetricKind
Returns Whether the metric records instantaneous values, changes to a value, etc.
Some combinations of metric_kind
and value_type
might not be supported.
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'proto_docs/google/api/metric.rb', line 181 class MetricDescriptor include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Additional annotations that can be used to guide the usage of a metric. # @!attribute [rw] launch_stage # @deprecated This field is deprecated and may be removed in the next major version update. # @return [::Google::Api::LaunchStage] # Deprecated. Must use the # {::Google::Api::MetricDescriptor#launch_stage MetricDescriptor.launch_stage} # instead. # @!attribute [rw] sample_period # @return [::Google::Protobuf::Duration] # The sampling period of metric data points. For metrics which are written # periodically, consecutive data points are stored at this time interval, # excluding data loss due to errors. Metrics with a higher granularity have # a smaller sampling period. # @!attribute [rw] ingest_delay # @return [::Google::Protobuf::Duration] # The delay of data points caused by ingestion. Data points older than this # age are guaranteed to be ingested and available to be read, excluding # data loss due to errors. # @!attribute [rw] time_series_resource_hierarchy_level # @return [::Array<::Google::Api::MetricDescriptor::MetricDescriptorMetadata::TimeSeriesResourceHierarchyLevel>] # The scope of the timeseries data of the metric. class MetricDescriptorMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The resource hierarchy level of the timeseries data of a metric. module TimeSeriesResourceHierarchyLevel # Do not use this default value. TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED = 0 # Scopes a metric to a project. PROJECT = 1 # Scopes a metric to an organization. ORGANIZATION = 2 # Scopes a metric to a folder. FOLDER = 3 end end # The kind of measurement. It describes how the data is reported. # For information on setting the start time and end time based on # the MetricKind, see {::Google::Cloud::Monitoring::V3::TimeInterval TimeInterval}. 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 |
#monitored_resource_types ⇒ ::Array<::String>
Returns Read-only. If present, then a [time series][google.monitoring.v3.TimeSeries], 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.
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'proto_docs/google/api/metric.rb', line 181 class MetricDescriptor include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Additional annotations that can be used to guide the usage of a metric. # @!attribute [rw] launch_stage # @deprecated This field is deprecated and may be removed in the next major version update. # @return [::Google::Api::LaunchStage] # Deprecated. Must use the # {::Google::Api::MetricDescriptor#launch_stage MetricDescriptor.launch_stage} # instead. # @!attribute [rw] sample_period # @return [::Google::Protobuf::Duration] # The sampling period of metric data points. For metrics which are written # periodically, consecutive data points are stored at this time interval, # excluding data loss due to errors. Metrics with a higher granularity have # a smaller sampling period. # @!attribute [rw] ingest_delay # @return [::Google::Protobuf::Duration] # The delay of data points caused by ingestion. Data points older than this # age are guaranteed to be ingested and available to be read, excluding # data loss due to errors. # @!attribute [rw] time_series_resource_hierarchy_level # @return [::Array<::Google::Api::MetricDescriptor::MetricDescriptorMetadata::TimeSeriesResourceHierarchyLevel>] # The scope of the timeseries data of the metric. class MetricDescriptorMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The resource hierarchy level of the timeseries data of a metric. module TimeSeriesResourceHierarchyLevel # Do not use this default value. TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED = 0 # Scopes a metric to a project. PROJECT = 1 # Scopes a metric to an organization. ORGANIZATION = 2 # Scopes a metric to a folder. FOLDER = 3 end end # The kind of measurement. It describes how the data is reported. # For information on setting the start time and end time based on # the MetricKind, see {::Google::Cloud::Monitoring::V3::TimeInterval TimeInterval}. 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 |
#name ⇒ ::String
Returns The resource name of the metric descriptor.
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'proto_docs/google/api/metric.rb', line 181 class MetricDescriptor include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Additional annotations that can be used to guide the usage of a metric. # @!attribute [rw] launch_stage # @deprecated This field is deprecated and may be removed in the next major version update. # @return [::Google::Api::LaunchStage] # Deprecated. Must use the # {::Google::Api::MetricDescriptor#launch_stage MetricDescriptor.launch_stage} # instead. # @!attribute [rw] sample_period # @return [::Google::Protobuf::Duration] # The sampling period of metric data points. For metrics which are written # periodically, consecutive data points are stored at this time interval, # excluding data loss due to errors. Metrics with a higher granularity have # a smaller sampling period. # @!attribute [rw] ingest_delay # @return [::Google::Protobuf::Duration] # The delay of data points caused by ingestion. Data points older than this # age are guaranteed to be ingested and available to be read, excluding # data loss due to errors. # @!attribute [rw] time_series_resource_hierarchy_level # @return [::Array<::Google::Api::MetricDescriptor::MetricDescriptorMetadata::TimeSeriesResourceHierarchyLevel>] # The scope of the timeseries data of the metric. class MetricDescriptorMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The resource hierarchy level of the timeseries data of a metric. module TimeSeriesResourceHierarchyLevel # Do not use this default value. TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED = 0 # Scopes a metric to a project. PROJECT = 1 # Scopes a metric to an organization. ORGANIZATION = 2 # Scopes a metric to a folder. FOLDER = 3 end end # The kind of measurement. It describes how the data is reported. # For information on setting the start time and end time based on # the MetricKind, see {::Google::Cloud::Monitoring::V3::TimeInterval TimeInterval}. 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 |
#type ⇒ ::String
Returns 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".
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'proto_docs/google/api/metric.rb', line 181 class MetricDescriptor include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Additional annotations that can be used to guide the usage of a metric. # @!attribute [rw] launch_stage # @deprecated This field is deprecated and may be removed in the next major version update. # @return [::Google::Api::LaunchStage] # Deprecated. Must use the # {::Google::Api::MetricDescriptor#launch_stage MetricDescriptor.launch_stage} # instead. # @!attribute [rw] sample_period # @return [::Google::Protobuf::Duration] # The sampling period of metric data points. For metrics which are written # periodically, consecutive data points are stored at this time interval, # excluding data loss due to errors. Metrics with a higher granularity have # a smaller sampling period. # @!attribute [rw] ingest_delay # @return [::Google::Protobuf::Duration] # The delay of data points caused by ingestion. Data points older than this # age are guaranteed to be ingested and available to be read, excluding # data loss due to errors. # @!attribute [rw] time_series_resource_hierarchy_level # @return [::Array<::Google::Api::MetricDescriptor::MetricDescriptorMetadata::TimeSeriesResourceHierarchyLevel>] # The scope of the timeseries data of the metric. class MetricDescriptorMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The resource hierarchy level of the timeseries data of a metric. module TimeSeriesResourceHierarchyLevel # Do not use this default value. TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED = 0 # Scopes a metric to a project. PROJECT = 1 # Scopes a metric to an organization. ORGANIZATION = 2 # Scopes a metric to a folder. FOLDER = 3 end end # The kind of measurement. It describes how the data is reported. # For information on setting the start time and end time based on # the MetricKind, see {::Google::Cloud::Monitoring::V3::TimeInterval TimeInterval}. 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 |
#unit ⇒ ::String
Returns 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 might 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 might 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
s{CPU}
(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
ks{CPU}
, 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
bitBy
bytes
secondmin
minuteh
hourd
day1
dimensionless
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/s
in 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
ork{watt}.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 aUNIT
. If the annotation is used alone, then the unit is equivalent to1
. For examples,{request}/s == 1/s
,By{transmitted}/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 in1/s
. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as1/d
or{new-users}/d
(and a metric value5
would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as1000/d
ork1/d
ork{page_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 value3
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 value0.03
means "3 percent").
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'proto_docs/google/api/metric.rb', line 181 class MetricDescriptor include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Additional annotations that can be used to guide the usage of a metric. # @!attribute [rw] launch_stage # @deprecated This field is deprecated and may be removed in the next major version update. # @return [::Google::Api::LaunchStage] # Deprecated. Must use the # {::Google::Api::MetricDescriptor#launch_stage MetricDescriptor.launch_stage} # instead. # @!attribute [rw] sample_period # @return [::Google::Protobuf::Duration] # The sampling period of metric data points. For metrics which are written # periodically, consecutive data points are stored at this time interval, # excluding data loss due to errors. Metrics with a higher granularity have # a smaller sampling period. # @!attribute [rw] ingest_delay # @return [::Google::Protobuf::Duration] # The delay of data points caused by ingestion. Data points older than this # age are guaranteed to be ingested and available to be read, excluding # data loss due to errors. # @!attribute [rw] time_series_resource_hierarchy_level # @return [::Array<::Google::Api::MetricDescriptor::MetricDescriptorMetadata::TimeSeriesResourceHierarchyLevel>] # The scope of the timeseries data of the metric. class MetricDescriptorMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The resource hierarchy level of the timeseries data of a metric. module TimeSeriesResourceHierarchyLevel # Do not use this default value. TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED = 0 # Scopes a metric to a project. PROJECT = 1 # Scopes a metric to an organization. ORGANIZATION = 2 # Scopes a metric to a folder. FOLDER = 3 end end # The kind of measurement. It describes how the data is reported. # For information on setting the start time and end time based on # the MetricKind, see {::Google::Cloud::Monitoring::V3::TimeInterval TimeInterval}. 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 |
#value_type ⇒ ::Google::Api::MetricDescriptor::ValueType
Returns Whether the measurement is an integer, a floating-point number, etc.
Some combinations of metric_kind
and value_type
might not be supported.
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'proto_docs/google/api/metric.rb', line 181 class MetricDescriptor include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Additional annotations that can be used to guide the usage of a metric. # @!attribute [rw] launch_stage # @deprecated This field is deprecated and may be removed in the next major version update. # @return [::Google::Api::LaunchStage] # Deprecated. Must use the # {::Google::Api::MetricDescriptor#launch_stage MetricDescriptor.launch_stage} # instead. # @!attribute [rw] sample_period # @return [::Google::Protobuf::Duration] # The sampling period of metric data points. For metrics which are written # periodically, consecutive data points are stored at this time interval, # excluding data loss due to errors. Metrics with a higher granularity have # a smaller sampling period. # @!attribute [rw] ingest_delay # @return [::Google::Protobuf::Duration] # The delay of data points caused by ingestion. Data points older than this # age are guaranteed to be ingested and available to be read, excluding # data loss due to errors. # @!attribute [rw] time_series_resource_hierarchy_level # @return [::Array<::Google::Api::MetricDescriptor::MetricDescriptorMetadata::TimeSeriesResourceHierarchyLevel>] # The scope of the timeseries data of the metric. class MetricDescriptorMetadata include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The resource hierarchy level of the timeseries data of a metric. module TimeSeriesResourceHierarchyLevel # Do not use this default value. TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED = 0 # Scopes a metric to a project. PROJECT = 1 # Scopes a metric to an organization. ORGANIZATION = 2 # Scopes a metric to a folder. FOLDER = 3 end end # The kind of measurement. It describes how the data is reported. # For information on setting the start time and end time based on # the MetricKind, see {::Google::Cloud::Monitoring::V3::TimeInterval TimeInterval}. 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 |