Class: Google::Apis::MonitoringV3::Exemplar
- Inherits:
-
Object
- Object
- Google::Apis::MonitoringV3::Exemplar
- 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
Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc.
Instance Attribute Summary collapse
-
#attachments ⇒ Array<Hash<String,Object>>
Contextual information about the example value.
-
#timestamp ⇒ String
The observation (sampling) time of the above value.
-
#value ⇒ Float
Value of the exemplar point.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Exemplar
constructor
A new instance of Exemplar.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Exemplar
Returns a new instance of Exemplar.
1123 1124 1125 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1123 def initialize(**args) update!(**args) end |
Instance Attribute Details
#attachments ⇒ Array<Hash<String,Object>>
Contextual information about the example value. Examples are:Trace: type.
googleapis.com/google.monitoring.v3.SpanContextLiteral string: type.googleapis.
com/google.protobuf.StringValueLabels dropped during aggregation: type.
googleapis.com/google.monitoring.v3.DroppedLabelsThere may be only a single
attachment of any given message type in a single exemplar, and this is
enforced by the system.
Corresponds to the JSON property attachments
1110 1111 1112 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1110 def @attachments end |
#timestamp ⇒ String
The observation (sampling) time of the above value.
Corresponds to the JSON property timestamp
1115 1116 1117 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1115 def @timestamp end |
#value ⇒ Float
Value of the exemplar point. This value determines to which bucket the
exemplar belongs.
Corresponds to the JSON property value
1121 1122 1123 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1121 def value @value end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1128 1129 1130 1131 1132 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1128 def update!(**args) @attachments = args[:attachments] if args.key?(:attachments) @timestamp = args[:timestamp] if args.key?(:timestamp) @value = args[:value] if args.key?(:value) end |