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
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;

    • getSamplesList

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

    • getSamples

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

    • getSamplesCount

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

    • getSamplesOrBuilderList

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

    • getSamplesOrBuilder

      SampleOrBuilder getSamplesOrBuilder(int index)
       The set of samples recorded in this profile.
      repeated .opentelemetry.proto.profiles.v1development.Sample samples = 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.

    • 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 = 7;
      Returns:
      The profileId.

    • getDroppedAttributesCount

      int getDroppedAttributesCount()
       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 = 8;
      Returns:
      The droppedAttributesCount.

    • getOriginalPayloadFormat

      String getOriginalPayloadFormat()
       The original payload format. See also original_payload. Optional, but the
 format and the bytes must be set or unset together.

 The allowed values for the format string are defined by the OpenTelemetry
 specification. Some examples are "jfr", "pprof", "linux_perf".

 The original payload may be optionally provided when the conversion to the
 OLTP format was done from a different format with some loss of the fidelity
 and the receiver may want to store the original payload to allow future
 lossless export or reinterpretation. Some examples of the original format
 are JFR (Java Flight Recorder), pprof, Linux perf.

 Even when the original payload is in a format that is semantically close to
 OTLP, such as pprof, a conversion may still be lossy in some cases (e.g. if
 the pprof file contains custom extensions or conventions).

 The original payload can be large in size, so including the original
 payload should be configurable by the profiler or collector options. The
 default behavior should be to not include the original payload.
      string original_payload_format = 9;
      Returns:
      The originalPayloadFormat.

    • getOriginalPayloadFormatBytes

      com.google.protobuf.ByteString getOriginalPayloadFormatBytes()
       The original payload format. See also original_payload. Optional, but the
 format and the bytes must be set or unset together.

 The allowed values for the format string are defined by the OpenTelemetry
 specification. Some examples are "jfr", "pprof", "linux_perf".

 The original payload may be optionally provided when the conversion to the
 OLTP format was done from a different format with some loss of the fidelity
 and the receiver may want to store the original payload to allow future
 lossless export or reinterpretation. Some examples of the original format
 are JFR (Java Flight Recorder), pprof, Linux perf.

 Even when the original payload is in a format that is semantically close to
 OTLP, such as pprof, a conversion may still be lossy in some cases (e.g. if
 the pprof file contains custom extensions or conventions).

 The original payload can be large in size, so including the original
 payload should be configurable by the profiler or collector options. The
 default behavior should be to not include the original payload.
      string original_payload_format = 9;
      Returns:
      The bytes for originalPayloadFormat.

    • getOriginalPayload

      com.google.protobuf.ByteString getOriginalPayload()
       The original payload bytes. See also original_payload_format. Optional, but
 format and the bytes must be set or unset together.
      bytes original_payload = 10;
      Returns:
      The originalPayload.

    • getAttributeIndicesList

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

    • getAttributeIndicesCount

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

    • getAttributeIndices

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