Class: Google::Api::Distribution::Exemplar

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/api/distribution.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

Instance Attribute Details

#attachments ⇒ ::Array<::Google::Protobuf::Any>

Returns Contextual information about the example value. Examples are:

Trace: type.googleapis.com/google.monitoring.v3.SpanContext

Literal string: type.googleapis.com/google.protobuf.StringValue

Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels

There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.

Returns:

  • (::Array<::Google::Protobuf::Any>) —

    Contextual information about the example value. Examples are:

    Trace: type.googleapis.com/google.monitoring.v3.SpanContext

    Literal string: type.googleapis.com/google.protobuf.StringValue

    Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels

    There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.



219
220
221
222
 
# File 'proto_docs/google/api/distribution.rb', line 219

class Exemplar
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#timestamp ⇒ ::Google::Protobuf::Timestamp

Returns The observation (sampling) time of the above value.

Returns:



219
220
221
222
 
# File 'proto_docs/google/api/distribution.rb', line 219

class Exemplar
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#value ⇒ ::Float

Returns Value of the exemplar point. This value determines to which bucket the exemplar belongs.

Returns:

  • (::Float) —

    Value of the exemplar point. This value determines to which bucket the exemplar belongs.



219
220
221
222
 
# File 'proto_docs/google/api/distribution.rb', line 219

class Exemplar
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end