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

    • getSampleTypeList

      List<ValueType> getSampleTypeList()
       A description of the samples associated with each Sample.value.
 For a cpu profile this might be:
 [["cpu","nanoseconds"]] or [["wall","seconds"]] or [["syscall","count"]]
 For a heap profile, this might be:
 [["allocations","count"], ["space","bytes"]],
 If one of the values represents the number of events represented
 by the sample, by convention it should be at index 0 and use
 sample_type.unit == "count".
      repeated .opentelemetry.proto.profiles.v1development.ValueType sample_type = 1;

    • getSampleType

      ValueType getSampleType(int index)
       A description of the samples associated with each Sample.value.
 For a cpu profile this might be:
 [["cpu","nanoseconds"]] or [["wall","seconds"]] or [["syscall","count"]]
 For a heap profile, this might be:
 [["allocations","count"], ["space","bytes"]],
 If one of the values represents the number of events represented
 by the sample, by convention it should be at index 0 and use
 sample_type.unit == "count".
      repeated .opentelemetry.proto.profiles.v1development.ValueType sample_type = 1;

    • getSampleTypeCount

      int getSampleTypeCount()
       A description of the samples associated with each Sample.value.
 For a cpu profile this might be:
 [["cpu","nanoseconds"]] or [["wall","seconds"]] or [["syscall","count"]]
 For a heap profile, this might be:
 [["allocations","count"], ["space","bytes"]],
 If one of the values represents the number of events represented
 by the sample, by convention it should be at index 0 and use
 sample_type.unit == "count".
      repeated .opentelemetry.proto.profiles.v1development.ValueType sample_type = 1;

    • getSampleTypeOrBuilderList

      List<? extends ValueTypeOrBuilder> getSampleTypeOrBuilderList()
       A description of the samples associated with each Sample.value.
 For a cpu profile this might be:
 [["cpu","nanoseconds"]] or [["wall","seconds"]] or [["syscall","count"]]
 For a heap profile, this might be:
 [["allocations","count"], ["space","bytes"]],
 If one of the values represents the number of events represented
 by the sample, by convention it should be at index 0 and use
 sample_type.unit == "count".
      repeated .opentelemetry.proto.profiles.v1development.ValueType sample_type = 1;

    • getSampleTypeOrBuilder

      ValueTypeOrBuilder getSampleTypeOrBuilder(int index)
       A description of the samples associated with each Sample.value.
 For a cpu profile this might be:
 [["cpu","nanoseconds"]] or [["wall","seconds"]] or [["syscall","count"]]
 For a heap profile, this might be:
 [["allocations","count"], ["space","bytes"]],
 If one of the values represents the number of events represented
 by the sample, by convention it should be at index 0 and use
 sample_type.unit == "count".
      repeated .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;

    • getMappingTableList

      List<Mapping> getMappingTableList()
       Mapping from address ranges to the image/binary/library mapped
 into that address range.  mapping[0] will be the main binary.
 If multiple binaries contribute to the Profile and no main
 binary can be identified, mapping[0] has no special meaning.
      repeated .opentelemetry.proto.profiles.v1development.Mapping mapping_table = 3;

    • getMappingTable

      Mapping getMappingTable(int index)
       Mapping from address ranges to the image/binary/library mapped
 into that address range.  mapping[0] will be the main binary.
 If multiple binaries contribute to the Profile and no main
 binary can be identified, mapping[0] has no special meaning.
      repeated .opentelemetry.proto.profiles.v1development.Mapping mapping_table = 3;

    • getMappingTableCount

      int getMappingTableCount()
       Mapping from address ranges to the image/binary/library mapped
 into that address range.  mapping[0] will be the main binary.
 If multiple binaries contribute to the Profile and no main
 binary can be identified, mapping[0] has no special meaning.
      repeated .opentelemetry.proto.profiles.v1development.Mapping mapping_table = 3;

    • getMappingTableOrBuilderList

      List<? extends MappingOrBuilder> getMappingTableOrBuilderList()
       Mapping from address ranges to the image/binary/library mapped
 into that address range.  mapping[0] will be the main binary.
 If multiple binaries contribute to the Profile and no main
 binary can be identified, mapping[0] has no special meaning.
      repeated .opentelemetry.proto.profiles.v1development.Mapping mapping_table = 3;

    • getMappingTableOrBuilder

      MappingOrBuilder getMappingTableOrBuilder(int index)
       Mapping from address ranges to the image/binary/library mapped
 into that address range.  mapping[0] will be the main binary.
 If multiple binaries contribute to the Profile and no main
 binary can be identified, mapping[0] has no special meaning.
      repeated .opentelemetry.proto.profiles.v1development.Mapping mapping_table = 3;

    • getLocationTableList

      List<Location> getLocationTableList()
       Locations referenced by samples via location_indices.
      repeated .opentelemetry.proto.profiles.v1development.Location location_table = 4;

    • getLocationTable

      Location getLocationTable(int index)
       Locations referenced by samples via location_indices.
      repeated .opentelemetry.proto.profiles.v1development.Location location_table = 4;

    • getLocationTableCount

      int getLocationTableCount()
       Locations referenced by samples via location_indices.
      repeated .opentelemetry.proto.profiles.v1development.Location location_table = 4;

    • getLocationTableOrBuilderList

      List<? extends LocationOrBuilder> getLocationTableOrBuilderList()
       Locations referenced by samples via location_indices.
      repeated .opentelemetry.proto.profiles.v1development.Location location_table = 4;

    • getLocationTableOrBuilder

      LocationOrBuilder getLocationTableOrBuilder(int index)
       Locations referenced by samples via location_indices.
      repeated .opentelemetry.proto.profiles.v1development.Location location_table = 4;

    • getLocationIndicesList

      List<Integer> getLocationIndicesList()
       Array of locations referenced by samples.
      repeated int32 location_indices = 5;
      Returns:
      A list containing the locationIndices.

    • getLocationIndicesCount

      int getLocationIndicesCount()
       Array of locations referenced by samples.
      repeated int32 location_indices = 5;
      Returns:
      The count of locationIndices.

    • getLocationIndices

      int getLocationIndices(int index)
       Array of locations referenced by samples.
      repeated int32 location_indices = 5;
      Parameters:
      index - The index of the element to return.
      Returns:
      The locationIndices at the given index.

    • getFunctionTableList

      List<Function> getFunctionTableList()
       Functions referenced by locations.
      repeated .opentelemetry.proto.profiles.v1development.Function function_table = 6;

    • getFunctionTable

      Function getFunctionTable(int index)
       Functions referenced by locations.
      repeated .opentelemetry.proto.profiles.v1development.Function function_table = 6;

    • getFunctionTableCount

      int getFunctionTableCount()
       Functions referenced by locations.
      repeated .opentelemetry.proto.profiles.v1development.Function function_table = 6;

    • getFunctionTableOrBuilderList

      List<? extends FunctionOrBuilder> getFunctionTableOrBuilderList()
       Functions referenced by locations.
      repeated .opentelemetry.proto.profiles.v1development.Function function_table = 6;

    • getFunctionTableOrBuilder

      FunctionOrBuilder getFunctionTableOrBuilder(int index)
       Functions referenced by locations.
      repeated .opentelemetry.proto.profiles.v1development.Function function_table = 6;

    • getAttributeTableList

      List<KeyValue> getAttributeTableList()
       Lookup table for attributes.
      repeated .opentelemetry.proto.common.v1.KeyValue attribute_table = 7;

    • getAttributeTable

      KeyValue getAttributeTable(int index)
       Lookup table for attributes.
      repeated .opentelemetry.proto.common.v1.KeyValue attribute_table = 7;

    • getAttributeTableCount

      int getAttributeTableCount()
       Lookup table for attributes.
      repeated .opentelemetry.proto.common.v1.KeyValue attribute_table = 7;

    • getAttributeTableOrBuilderList

      List<? extends KeyValueOrBuilder> getAttributeTableOrBuilderList()
       Lookup table for attributes.
      repeated .opentelemetry.proto.common.v1.KeyValue attribute_table = 7;

    • getAttributeTableOrBuilder

      KeyValueOrBuilder getAttributeTableOrBuilder(int index)
       Lookup table for attributes.
      repeated .opentelemetry.proto.common.v1.KeyValue attribute_table = 7;

    • getAttributeUnitsList

      List<AttributeUnit> getAttributeUnitsList()
       Represents a mapping between Attribute Keys and Units.
      repeated .opentelemetry.proto.profiles.v1development.AttributeUnit attribute_units = 8;

    • getAttributeUnits

      AttributeUnit getAttributeUnits(int index)
       Represents a mapping between Attribute Keys and Units.
      repeated .opentelemetry.proto.profiles.v1development.AttributeUnit attribute_units = 8;

    • getAttributeUnitsCount

      int getAttributeUnitsCount()
       Represents a mapping between Attribute Keys and Units.
      repeated .opentelemetry.proto.profiles.v1development.AttributeUnit attribute_units = 8;

    • getAttributeUnitsOrBuilderList

      List<? extends AttributeUnitOrBuilder> getAttributeUnitsOrBuilderList()
       Represents a mapping between Attribute Keys and Units.
      repeated .opentelemetry.proto.profiles.v1development.AttributeUnit attribute_units = 8;

    • getAttributeUnitsOrBuilder

      AttributeUnitOrBuilder getAttributeUnitsOrBuilder(int index)
       Represents a mapping between Attribute Keys and Units.
      repeated .opentelemetry.proto.profiles.v1development.AttributeUnit attribute_units = 8;

    • getLinkTableList

      List<Link> getLinkTableList()
       Lookup table for links.
      repeated .opentelemetry.proto.profiles.v1development.Link link_table = 9;

    • getLinkTable

      Link getLinkTable(int index)
       Lookup table for links.
      repeated .opentelemetry.proto.profiles.v1development.Link link_table = 9;

    • getLinkTableCount

      int getLinkTableCount()
       Lookup table for links.
      repeated .opentelemetry.proto.profiles.v1development.Link link_table = 9;

    • getLinkTableOrBuilderList

      List<? extends LinkOrBuilder> getLinkTableOrBuilderList()
       Lookup table for links.
      repeated .opentelemetry.proto.profiles.v1development.Link link_table = 9;

    • getLinkTableOrBuilder

      LinkOrBuilder getLinkTableOrBuilder(int index)
       Lookup table for links.
      repeated .opentelemetry.proto.profiles.v1development.Link link_table = 9;

    • getStringTableList

      List<String> getStringTableList()
       A common table for strings referenced by various messages.
 string_table[0] must always be "".
      repeated string string_table = 10;
      Returns:
      A list containing the stringTable.

    • getStringTableCount

      int getStringTableCount()
       A common table for strings referenced by various messages.
 string_table[0] must always be "".
      repeated string string_table = 10;
      Returns:
      The count of stringTable.

    • getStringTable

      String getStringTable(int index)
       A common table for strings referenced by various messages.
 string_table[0] must always be "".
      repeated string string_table = 10;
      Parameters:
      index - The index of the element to return.
      Returns:
      The stringTable at the given index.

    • getStringTableBytes

      com.google.protobuf.ByteString getStringTableBytes(int index)
       A common table for strings referenced by various messages.
 string_table[0] must always be "".
      repeated string string_table = 10;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the stringTable at the given index.

    • getTimeNanos

      long getTimeNanos()
       Time of collection (UTC) represented as nanoseconds past the epoch.
      int64 time_nanos = 11;
      Returns:
      The timeNanos.

    • getDurationNanos

      long getDurationNanos()
       Duration of the profile, if a duration makes sense.
      int64 duration_nanos = 12;
      Returns:
      The durationNanos.

    • hasPeriodType

      boolean hasPeriodType()
       The kind of events between sampled occurrences.
 e.g [ "cpu","cycles" ] or [ "heap","bytes" ]
      .opentelemetry.proto.profiles.v1development.ValueType period_type = 13;
      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 = 13;
      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 = 13;

    • getPeriod

      long getPeriod()
       The number of events between sampled occurrences.
      int64 period = 14;
      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 = 15;
      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 = 15;
      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 = 15;
      Parameters:
      index - The index of the element to return.
      Returns:
      The commentStrindices at the given index.

    • getDefaultSampleTypeStrindex

      int getDefaultSampleTypeStrindex()
       Index into the string table of the type of the preferred sample
 value. If unset, clients should default to the last sample value.
      int32 default_sample_type_strindex = 16;
      Returns:
      The defaultSampleTypeStrindex.

    • 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.

 This field is required.
      bytes profile_id = 17;
      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 = 19;
      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 = 20;
      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 = 20;
      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 = 21;
      Returns:
      The originalPayload.

    • getAttributeIndicesList

      List<Integer> getAttributeIndicesList()
       References to attributes in attribute_table. [optional]
 It is a collection of key/value pairs. Note, global attributes
 like server name can be set using the resource API. Examples of attributes:

 "/http/user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36"
 "/http/server_latency": 300
 "abc.com/myattribute": true
 "abc.com/score": 10.239

 The OpenTelemetry API specification further restricts the allowed value types:
 https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/README.md#attribute
 Attribute keys MUST be unique (it is not allowed to have more than one
 attribute with the same key).
      repeated int32 attribute_indices = 22;
      Returns:
      A list containing the attributeIndices.

    • getAttributeIndicesCount

      int getAttributeIndicesCount()
       References to attributes in attribute_table. [optional]
 It is a collection of key/value pairs. Note, global attributes
 like server name can be set using the resource API. Examples of attributes:

 "/http/user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36"
 "/http/server_latency": 300
 "abc.com/myattribute": true
 "abc.com/score": 10.239

 The OpenTelemetry API specification further restricts the allowed value types:
 https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/README.md#attribute
 Attribute keys MUST be unique (it is not allowed to have more than one
 attribute with the same key).
      repeated int32 attribute_indices = 22;
      Returns:
      The count of attributeIndices.

    • getAttributeIndices

      int getAttributeIndices(int index)
       References to attributes in attribute_table. [optional]
 It is a collection of key/value pairs. Note, global attributes
 like server name can be set using the resource API. Examples of attributes:

 "/http/user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36"
 "/http/server_latency": 300
 "abc.com/myattribute": true
 "abc.com/score": 10.239

 The OpenTelemetry API specification further restricts the allowed value types:
 https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/README.md#attribute
 Attribute keys MUST be unique (it is not allowed to have more than one
 attribute with the same key).
      repeated int32 attribute_indices = 22;
      Parameters:
      index - The index of the element to return.
      Returns:
      The attributeIndices at the given index.