Package io.opentelemetry.proto.profiles.v1development

Interface ProfileOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Profile, Profile.Builder
@Generated public interface ProfileOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasSampleType

      boolean hasSampleType()
       The type and unit of all Sample.values in this profile.
 For a cpu or off-cpu profile this might be:
 ["cpu","nanoseconds"] or ["off_cpu","nanoseconds"]
 For a heap profile, this might be:
 ["allocated_objects","count"] or ["allocated_space","bytes"],
      .opentelemetry.proto.profiles.v1development.ValueType sample_type = 1;
      Returns:
      Whether the sampleType field is set.

    • getSampleType

      ValueType getSampleType()
       The type and unit of all Sample.values in this profile.
 For a cpu or off-cpu profile this might be:
 ["cpu","nanoseconds"] or ["off_cpu","nanoseconds"]
 For a heap profile, this might be:
 ["allocated_objects","count"] or ["allocated_space","bytes"],
      .opentelemetry.proto.profiles.v1development.ValueType sample_type = 1;
      Returns:
      The sampleType.

    • getSampleTypeOrBuilder

      ValueTypeOrBuilder getSampleTypeOrBuilder()
       The type and unit of all Sample.values in this profile.
 For a cpu or off-cpu profile this might be:
 ["cpu","nanoseconds"] or ["off_cpu","nanoseconds"]
 For a heap profile, this might be:
 ["allocated_objects","count"] or ["allocated_space","bytes"],
      .opentelemetry.proto.profiles.v1development.ValueType sample_type = 1;

    • getSampleList

      List<Sample> getSampleList()
       The set of samples recorded in this profile.
      repeated .opentelemetry.proto.profiles.v1development.Sample sample = 2;

    • getSample

      Sample getSample(int index)
       The set of samples recorded in this profile.
      repeated .opentelemetry.proto.profiles.v1development.Sample sample = 2;

    • getSampleCount

      int getSampleCount()
       The set of samples recorded in this profile.
      repeated .opentelemetry.proto.profiles.v1development.Sample sample = 2;

    • getSampleOrBuilderList

      List<? extends SampleOrBuilder> getSampleOrBuilderList()
       The set of samples recorded in this profile.
      repeated .opentelemetry.proto.profiles.v1development.Sample sample = 2;

    • getSampleOrBuilder

      SampleOrBuilder getSampleOrBuilder(int index)
       The set of samples recorded in this profile.
      repeated .opentelemetry.proto.profiles.v1development.Sample sample = 2;

    • getTimeUnixNano

      long getTimeUnixNano()
       Time of collection (UTC) represented as nanoseconds past the epoch.
      fixed64 time_unix_nano = 3;
      Returns:
      The timeUnixNano.

    • getDurationNano

      long getDurationNano()
       Duration of the profile, if a duration makes sense.
      uint64 duration_nano = 4;
      Returns:
      The durationNano.

    • hasPeriodType

      boolean hasPeriodType()
       The kind of events between sampled occurrences.
 e.g [ "cpu","cycles" ] or [ "heap","bytes" ]
      .opentelemetry.proto.profiles.v1development.ValueType period_type = 5;
      Returns:
      Whether the periodType field is set.

    • getPeriodType

      ValueType getPeriodType()
       The kind of events between sampled occurrences.
 e.g [ "cpu","cycles" ] or [ "heap","bytes" ]
      .opentelemetry.proto.profiles.v1development.ValueType period_type = 5;
      Returns:
      The periodType.

    • getPeriodTypeOrBuilder

      ValueTypeOrBuilder getPeriodTypeOrBuilder()
       The kind of events between sampled occurrences.
 e.g [ "cpu","cycles" ] or [ "heap","bytes" ]
      .opentelemetry.proto.profiles.v1development.ValueType period_type = 5;

    • getPeriod

      long getPeriod()
       The number of events between sampled occurrences.
      int64 period = 6;
      Returns:
      The period.

    • getCommentStrindicesList

      List<Integer> getCommentStrindicesList()
       Free-form text associated with the profile. The text is displayed as is
 to the user by the tools that read profiles (e.g. by pprof). This field
 should not be used to store any machine-readable information, it is only
 for human-friendly content. The profile must stay functional if this field
 is cleaned.
      repeated int32 comment_strindices = 7;
      Returns:
      A list containing the commentStrindices.

    • getCommentStrindicesCount

      int getCommentStrindicesCount()
       Free-form text associated with the profile. The text is displayed as is
 to the user by the tools that read profiles (e.g. by pprof). This field
 should not be used to store any machine-readable information, it is only
 for human-friendly content. The profile must stay functional if this field
 is cleaned.
      repeated int32 comment_strindices = 7;
      Returns:
      The count of commentStrindices.

    • getCommentStrindices

      int getCommentStrindices(int index)
       Free-form text associated with the profile. The text is displayed as is
 to the user by the tools that read profiles (e.g. by pprof). This field
 should not be used to store any machine-readable information, it is only
 for human-friendly content. The profile must stay functional if this field
 is cleaned.
      repeated int32 comment_strindices = 7;
      Parameters:
      index - The index of the element to return.
      Returns:
      The commentStrindices at the given index.

    • getProfileId

      com.google.protobuf.ByteString getProfileId()
       A globally unique identifier for a profile. The ID is a 16-byte array. An ID with
 all zeroes is considered invalid. It may be used for deduplication and signal
 correlation purposes. It is acceptable to treat two profiles with different values
 in this field as not equal, even if they represented the same object at an earlier
 time.
 This field is optional; an ID may be assigned to an ID-less profile in a later step.
      bytes profile_id = 8;
      Returns:
      The profileId.

    • getDroppedAttributesCount

      int getDroppedAttributesCount()
       dropped_attributes_count is the number of attributes that were discarded. Attributes
 can be discarded because their keys are too long or because there are too many
 attributes. If this value is 0, then no attributes were dropped.
      uint32 dropped_attributes_count = 9;
      Returns:
      The droppedAttributesCount.

    • getOriginalPayloadFormat

      String getOriginalPayloadFormat()
       Specifies format of the original payload. Common values are defined in semantic conventions. [required if original_payload is present]
      string original_payload_format = 10;
      Returns:
      The originalPayloadFormat.

    • getOriginalPayloadFormatBytes

      com.google.protobuf.ByteString getOriginalPayloadFormatBytes()
       Specifies format of the original payload. Common values are defined in semantic conventions. [required if original_payload is present]
      string original_payload_format = 10;
      Returns:
      The bytes for originalPayloadFormat.

    • getOriginalPayload

      com.google.protobuf.ByteString getOriginalPayload()
       Original payload can be stored in this field. This can be useful for users who want to get the original payload.
 Formats such as JFR are highly extensible and can contain more information than what is defined in this spec.
 Inclusion of original payload should be configurable by the user. Default behavior should be to not include the original payload.
 If the original payload is in pprof format, it SHOULD not be included in this field.
 The field is optional, however if it is present then equivalent converted data should be populated in other fields
 of this message as far as is practicable.
      bytes original_payload = 11;
      Returns:
      The originalPayload.

    • getAttributeIndicesList

      List<Integer> getAttributeIndicesList()
       References to attributes in attribute_table. [optional]
      repeated int32 attribute_indices = 12;
      Returns:
      A list containing the attributeIndices.

    • getAttributeIndicesCount

      int getAttributeIndicesCount()
       References to attributes in attribute_table. [optional]
      repeated int32 attribute_indices = 12;
      Returns:
      The count of attributeIndices.

    • getAttributeIndices

      int getAttributeIndices(int index)
       References to attributes in attribute_table. [optional]
      repeated int32 attribute_indices = 12;
      Parameters:
      index - The index of the element to return.
      Returns:
      The attributeIndices at the given index.