Class Profile
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.opentelemetry.proto.profiles.v1development.Profile
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,ProfileOrBuilder,Serializable
public final class Profile
extends com.google.protobuf.GeneratedMessageV3
implements ProfileOrBuilder
Represents a complete profile, including sample types, samples, mappings to binaries, stacks, locations, functions, string table, and additional metadata. It modifies and annotates pprof Profile with OpenTelemetry specific fields. Note that whilst fields in this message retain the name and field id from pprof in most cases for ease of understanding data migration, it is not intended that pprof:Profile and OpenTelemetry:Profile encoding be wire compatible.Protobuf type
opentelemetry.proto.profiles.v1development.Profile- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classRepresents a complete profile, including sample types, samples, mappings to binaries, stacks, locations, functions, string table, and additional metadata.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanintgetAttributeIndices(int index) References to attributes in attribute_table.intReferences to attributes in attribute_table.References to attributes in attribute_table.static Profilestatic final com.google.protobuf.Descriptors.DescriptorintThe number of attributes that were discarded.longDuration of the profile, if a duration makes sense.com.google.protobuf.ByteStringThe original payload bytes.The original payload format.com.google.protobuf.ByteStringThe original payload format.com.google.protobuf.Parser<Profile>longThe number of events between sampled occurrences.The kind of events between sampled occurrences.The kind of events between sampled occurrences.com.google.protobuf.ByteStringA globally unique identifier for a profile.getSamples(int index) The set of samples recorded in this profile.intThe set of samples recorded in this profile.The set of samples recorded in this profile.getSamplesOrBuilder(int index) The set of samples recorded in this profile.List<? extends SampleOrBuilder>The set of samples recorded in this profile.The type and unit of all Sample.values in this profile.The type and unit of all Sample.values in this profile.intlongTime of collection (UTC) represented as nanoseconds past the epoch.inthashCode()booleanThe kind of events between sampled occurrences.booleanThe type and unit of all Sample.values in this profile.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanstatic Profile.Builderstatic Profile.BuildernewBuilder(Profile prototype) protected Profile.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static ProfileparseDelimitedFrom(InputStream input) static ProfileparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ProfileparseFrom(byte[] data) static ProfileparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ProfileparseFrom(com.google.protobuf.ByteString data) static ProfileparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ProfileparseFrom(com.google.protobuf.CodedInputStream input) static ProfileparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ProfileparseFrom(InputStream input) static ProfileparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ProfileparseFrom(ByteBuffer data) static ProfileparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<Profile>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
SAMPLE_TYPE_FIELD_NUMBER
public static final int SAMPLE_TYPE_FIELD_NUMBER- See Also:
-
SAMPLES_FIELD_NUMBER
public static final int SAMPLES_FIELD_NUMBER- See Also:
-
TIME_UNIX_NANO_FIELD_NUMBER
public static final int TIME_UNIX_NANO_FIELD_NUMBER- See Also:
-
DURATION_NANO_FIELD_NUMBER
public static final int DURATION_NANO_FIELD_NUMBER- See Also:
-
PERIOD_TYPE_FIELD_NUMBER
public static final int PERIOD_TYPE_FIELD_NUMBER- See Also:
-
PERIOD_FIELD_NUMBER
public static final int PERIOD_FIELD_NUMBER- See Also:
-
PROFILE_ID_FIELD_NUMBER
public static final int PROFILE_ID_FIELD_NUMBER- See Also:
-
DROPPED_ATTRIBUTES_COUNT_FIELD_NUMBER
public static final int DROPPED_ATTRIBUTES_COUNT_FIELD_NUMBER- See Also:
-
ORIGINAL_PAYLOAD_FORMAT_FIELD_NUMBER
public static final int ORIGINAL_PAYLOAD_FORMAT_FIELD_NUMBER- See Also:
-
ORIGINAL_PAYLOAD_FIELD_NUMBER
public static final int ORIGINAL_PAYLOAD_FIELD_NUMBER- See Also:
-
ATTRIBUTE_INDICES_FIELD_NUMBER
public static final int ATTRIBUTE_INDICES_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
hasSampleType
public 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;- Specified by:
hasSampleTypein interfaceProfileOrBuilder- Returns:
- Whether the sampleType field is set.
-
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;- Specified by:
getSampleTypein interfaceProfileOrBuilder- Returns:
- The sampleType.
-
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;- Specified by:
getSampleTypeOrBuilderin interfaceProfileOrBuilder
-
getSamplesList
The set of samples recorded in this profile.
repeated .opentelemetry.proto.profiles.v1development.Sample samples = 2;- Specified by:
getSamplesListin interfaceProfileOrBuilder
-
getSamplesOrBuilderList
The set of samples recorded in this profile.
repeated .opentelemetry.proto.profiles.v1development.Sample samples = 2;- Specified by:
getSamplesOrBuilderListin interfaceProfileOrBuilder
-
getSamplesCount
public int getSamplesCount()The set of samples recorded in this profile.
repeated .opentelemetry.proto.profiles.v1development.Sample samples = 2;- Specified by:
getSamplesCountin interfaceProfileOrBuilder
-
getSamples
The set of samples recorded in this profile.
repeated .opentelemetry.proto.profiles.v1development.Sample samples = 2;- Specified by:
getSamplesin interfaceProfileOrBuilder
-
getSamplesOrBuilder
The set of samples recorded in this profile.
repeated .opentelemetry.proto.profiles.v1development.Sample samples = 2;- Specified by:
getSamplesOrBuilderin interfaceProfileOrBuilder
-
getTimeUnixNano
public long getTimeUnixNano()Time of collection (UTC) represented as nanoseconds past the epoch.
fixed64 time_unix_nano = 3;- Specified by:
getTimeUnixNanoin interfaceProfileOrBuilder- Returns:
- The timeUnixNano.
-
getDurationNano
public long getDurationNano()Duration of the profile, if a duration makes sense.
uint64 duration_nano = 4;- Specified by:
getDurationNanoin interfaceProfileOrBuilder- Returns:
- The durationNano.
-
hasPeriodType
public boolean hasPeriodType()The kind of events between sampled occurrences. e.g [ "cpu","cycles" ] or [ "heap","bytes" ]
.opentelemetry.proto.profiles.v1development.ValueType period_type = 5;- Specified by:
hasPeriodTypein interfaceProfileOrBuilder- Returns:
- Whether the periodType field is set.
-
getPeriodType
The kind of events between sampled occurrences. e.g [ "cpu","cycles" ] or [ "heap","bytes" ]
.opentelemetry.proto.profiles.v1development.ValueType period_type = 5;- Specified by:
getPeriodTypein interfaceProfileOrBuilder- Returns:
- The periodType.
-
getPeriodTypeOrBuilder
The kind of events between sampled occurrences. e.g [ "cpu","cycles" ] or [ "heap","bytes" ]
.opentelemetry.proto.profiles.v1development.ValueType period_type = 5;- Specified by:
getPeriodTypeOrBuilderin interfaceProfileOrBuilder
-
getPeriod
public long getPeriod()The number of events between sampled occurrences.
int64 period = 6;- Specified by:
getPeriodin interfaceProfileOrBuilder- Returns:
- The period.
-
getProfileId
public 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;- Specified by:
getProfileIdin interfaceProfileOrBuilder- Returns:
- The profileId.
-
getDroppedAttributesCount
public 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;- Specified by:
getDroppedAttributesCountin interfaceProfileOrBuilder- Returns:
- The droppedAttributesCount.
-
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;- Specified by:
getOriginalPayloadFormatin interfaceProfileOrBuilder- Returns:
- The originalPayloadFormat.
-
getOriginalPayloadFormatBytes
public 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;- Specified by:
getOriginalPayloadFormatBytesin interfaceProfileOrBuilder- Returns:
- The bytes for originalPayloadFormat.
-
getOriginalPayload
public 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;- Specified by:
getOriginalPayloadin interfaceProfileOrBuilder- Returns:
- The originalPayload.
-
getAttributeIndicesList
References to attributes in attribute_table. [optional]
repeated int32 attribute_indices = 11;- Specified by:
getAttributeIndicesListin interfaceProfileOrBuilder- Returns:
- A list containing the attributeIndices.
-
getAttributeIndicesCount
public int getAttributeIndicesCount()References to attributes in attribute_table. [optional]
repeated int32 attribute_indices = 11;- Specified by:
getAttributeIndicesCountin interfaceProfileOrBuilder- Returns:
- The count of attributeIndices.
-
getAttributeIndices
public int getAttributeIndices(int index) References to attributes in attribute_table. [optional]
repeated int32 attribute_indices = 11;- Specified by:
getAttributeIndicesin interfaceProfileOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The attributeIndices at the given index.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Profile parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Profile parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Profile parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Profile parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Profile parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Profile parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Profile parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Profile parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Profile parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Profile.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-