org.apache.skywalking.apm.network.logging.v3

Class LogData

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.apache.skywalking.apm.network.logging.v3.LogData

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, LogDataOrBuilder

public final class LogData
extends com.google.protobuf.GeneratedMessageV3
implements LogDataOrBuilder

 Log data is collected through file scratcher of agent.
 Natively, Satellite provides various ways to collect logs.
 

Protobuf type skywalking.v3.LogData

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LogData.Builder Log data is collected through file scratcher of agent.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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

Fields

Modifier and Type	Field and Description
static int	BODY_FIELD_NUMBER
static int	ENDPOINT_FIELD_NUMBER
static int	LAYER_FIELD_NUMBER
static int	SERVICE_FIELD_NUMBER
static int	SERVICEINSTANCE_FIELD_NUMBER
static int	TAGS_FIELD_NUMBER
static int	TIMESTAMP_FIELD_NUMBER
static int	TRACECONTEXT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
LogDataBody	getBody() [Required] The content of the log.
LogDataBodyOrBuilder	getBodyOrBuilder() [Required] The content of the log.
static LogData	getDefaultInstance()
LogData	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getEndpoint() [Optional] **Endpoint**.
com.google.protobuf.ByteString	getEndpointBytes() [Optional] **Endpoint**.
String	getLayer() [Optional] Since 9.0.0 The layer of the service and servce instance.
com.google.protobuf.ByteString	getLayerBytes() [Optional] Since 9.0.0 The layer of the service and servce instance.
com.google.protobuf.Parser<LogData>	getParserForType()
int	getSerializedSize()
String	getService() [Required] **Service**.
com.google.protobuf.ByteString	getServiceBytes() [Required] **Service**.
String	getServiceInstance() [Optional] **Service Instance**.
com.google.protobuf.ByteString	getServiceInstanceBytes() [Optional] **Service Instance**.
LogTags	getTags() [Optional] The available tags.
LogTagsOrBuilder	getTagsOrBuilder() [Optional] The available tags.
long	getTimestamp() [Optional] The timestamp of the log, in millisecond.
TraceContext	getTraceContext() [Optional] Logs with trace context
TraceContextOrBuilder	getTraceContextOrBuilder() [Optional] Logs with trace context
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasBody() [Required] The content of the log.
int	hashCode()
boolean	hasTags() [Optional] The available tags.
boolean	hasTraceContext() [Optional] Logs with trace context
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static LogData.Builder	newBuilder()
static LogData.Builder	newBuilder(LogData prototype)
LogData.Builder	newBuilderForType()
protected LogData.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static LogData	parseDelimitedFrom(InputStream input)
static LogData	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LogData	parseFrom(byte[] data)
static LogData	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LogData	parseFrom(ByteBuffer data)
static LogData	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LogData	parseFrom(com.google.protobuf.ByteString data)
static LogData	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LogData	parseFrom(com.google.protobuf.CodedInputStream input)
static LogData	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LogData	parseFrom(InputStream input)
static LogData	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<LogData>	parser()
LogData.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

TIMESTAMP_FIELD_NUMBER

public static final int TIMESTAMP_FIELD_NUMBER

See Also:

Constant Field Values

SERVICE_FIELD_NUMBER

public static final int SERVICE_FIELD_NUMBER

See Also:

Constant Field Values

SERVICEINSTANCE_FIELD_NUMBER

public static final int SERVICEINSTANCE_FIELD_NUMBER

See Also:

Constant Field Values

ENDPOINT_FIELD_NUMBER

public static final int ENDPOINT_FIELD_NUMBER

See Also:

Constant Field Values

BODY_FIELD_NUMBER

public static final int BODY_FIELD_NUMBER

See Also:

Constant Field Values

TRACECONTEXT_FIELD_NUMBER

public static final int TRACECONTEXT_FIELD_NUMBER

See Also:

Constant Field Values

TAGS_FIELD_NUMBER

public static final int TAGS_FIELD_NUMBER

See Also:

Constant Field Values

LAYER_FIELD_NUMBER

public static final int LAYER_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getTimestamp

public long getTimestamp()

 [Optional] The timestamp of the log, in millisecond.
 If not set, OAP server would use the received timestamp as log's timestamp, or relies on the OAP server analyzer.
 

int64 timestamp = 1;

Specified by:

getTimestamp in interface LogDataOrBuilder

Returns:

The timestamp.

getService

public String getService()

 [Required] **Service**. Represents a set/group of workloads which provide the same behaviours for incoming requests.
 The logic name represents the service. This would show as a separate node in the topology.
 The metrics analyzed from the spans, would be aggregated for this entity as the service level.
 If this is not the first element of the streaming, use the previous not-null name as the service name.
 

string service = 2;

Specified by:

getService in interface LogDataOrBuilder

Returns:

The service.

getServiceBytes

public com.google.protobuf.ByteString getServiceBytes()

 [Required] **Service**. Represents a set/group of workloads which provide the same behaviours for incoming requests.
 The logic name represents the service. This would show as a separate node in the topology.
 The metrics analyzed from the spans, would be aggregated for this entity as the service level.
 If this is not the first element of the streaming, use the previous not-null name as the service name.
 

string service = 2;

Specified by:

getServiceBytes in interface LogDataOrBuilder

Returns:

The bytes for service.

getServiceInstance

public String getServiceInstance()

 [Optional] **Service Instance**. Each individual workload in the Service group is known as an instance. Like `pods` in Kubernetes, it
 doesn't need to be a single OS process, however, if you are using instrument agents, an instance is actually a real OS process.
 The logic name represents the service instance. This would show as a separate node in the instance relationship.
 The metrics analyzed from the spans, would be aggregated for this entity as the service instance level.
 

string serviceInstance = 3;

Specified by:

getServiceInstance in interface LogDataOrBuilder

Returns:

The serviceInstance.

getServiceInstanceBytes

public com.google.protobuf.ByteString getServiceInstanceBytes()

 [Optional] **Service Instance**. Each individual workload in the Service group is known as an instance. Like `pods` in Kubernetes, it
 doesn't need to be a single OS process, however, if you are using instrument agents, an instance is actually a real OS process.
 The logic name represents the service instance. This would show as a separate node in the instance relationship.
 The metrics analyzed from the spans, would be aggregated for this entity as the service instance level.
 

string serviceInstance = 3;

Specified by:

getServiceInstanceBytes in interface LogDataOrBuilder

Returns:

The bytes for serviceInstance.

getEndpoint

public String getEndpoint()

 [Optional] **Endpoint**. A path in a service for incoming requests, such as an HTTP URI path or a gRPC service class + method signature.
 The logic name represents the endpoint, which logs belong.
 

string endpoint = 4;

Specified by:

getEndpoint in interface LogDataOrBuilder

Returns:

The endpoint.

getEndpointBytes

public com.google.protobuf.ByteString getEndpointBytes()

 [Optional] **Endpoint**. A path in a service for incoming requests, such as an HTTP URI path or a gRPC service class + method signature.
 The logic name represents the endpoint, which logs belong.
 

string endpoint = 4;

Specified by:

getEndpointBytes in interface LogDataOrBuilder

Returns:

The bytes for endpoint.

hasBody

public boolean hasBody()

 [Required] The content of the log.
 

.skywalking.v3.LogDataBody body = 5;

Specified by:

hasBody in interface LogDataOrBuilder

Returns:

Whether the body field is set.

getBody

public LogDataBody getBody()

 [Required] The content of the log.
 

.skywalking.v3.LogDataBody body = 5;

Specified by:

getBody in interface LogDataOrBuilder

Returns:

The body.

getBodyOrBuilder

public LogDataBodyOrBuilder getBodyOrBuilder()

 [Required] The content of the log.
 

.skywalking.v3.LogDataBody body = 5;

Specified by:

getBodyOrBuilder in interface LogDataOrBuilder

hasTraceContext

public boolean hasTraceContext()

 [Optional] Logs with trace context
 

.skywalking.v3.TraceContext traceContext = 6;

Specified by:

hasTraceContext in interface LogDataOrBuilder

Returns:

Whether the traceContext field is set.

getTraceContext

public TraceContext getTraceContext()

 [Optional] Logs with trace context
 

.skywalking.v3.TraceContext traceContext = 6;

Specified by:

getTraceContext in interface LogDataOrBuilder

Returns:

The traceContext.

getTraceContextOrBuilder

public TraceContextOrBuilder getTraceContextOrBuilder()

 [Optional] Logs with trace context
 

.skywalking.v3.TraceContext traceContext = 6;

Specified by:

getTraceContextOrBuilder in interface LogDataOrBuilder

hasTags

public boolean hasTags()

 [Optional] The available tags. OAP server could provide search/analysis capabilities based on these.
 

.skywalking.v3.LogTags tags = 7;

Specified by:

hasTags in interface LogDataOrBuilder

Returns:

Whether the tags field is set.

getTags

public LogTags getTags()

 [Optional] The available tags. OAP server could provide search/analysis capabilities based on these.
 

.skywalking.v3.LogTags tags = 7;

Specified by:

getTags in interface LogDataOrBuilder

Returns:

The tags.

getTagsOrBuilder

public LogTagsOrBuilder getTagsOrBuilder()

 [Optional] The available tags. OAP server could provide search/analysis capabilities based on these.
 

.skywalking.v3.LogTags tags = 7;

Specified by:

getTagsOrBuilder in interface LogDataOrBuilder

getLayer

public String getLayer()

 [Optional] Since 9.0.0
 The layer of the service and servce instance. If absent, the OAP would set `layer`=`ID: 2, NAME: general`
 

string layer = 8;

Specified by:

getLayer in interface LogDataOrBuilder

Returns:

The layer.

getLayerBytes

public com.google.protobuf.ByteString getLayerBytes()

 [Optional] Since 9.0.0
 The layer of the service and servce instance. If absent, the OAP would set `layer`=`ID: 2, NAME: general`
 

string layer = 8;

Specified by:

getLayerBytes in interface LogDataOrBuilder

Returns:

The bytes for layer.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static LogData parseFrom(ByteBuffer data)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LogData parseFrom(ByteBuffer data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LogData parseFrom(com.google.protobuf.ByteString data)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LogData parseFrom(com.google.protobuf.ByteString data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LogData parseFrom(byte[] data)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LogData parseFrom(byte[] data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LogData parseFrom(InputStream input)
                         throws IOException

Throws:

IOException

parseFrom

public static LogData parseFrom(InputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static LogData parseDelimitedFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static LogData parseDelimitedFrom(InputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

parseFrom

public static LogData parseFrom(com.google.protobuf.CodedInputStream input)
                         throws IOException

Throws:

IOException

parseFrom

public static LogData parseFrom(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException

Throws:

IOException

newBuilderForType

public LogData.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static LogData.Builder newBuilder()

newBuilder

public static LogData.Builder newBuilder(LogData prototype)

toBuilder

public LogData.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected LogData.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static LogData getDefaultInstance()

parser

public static com.google.protobuf.Parser<LogData> parser()

getParserForType

public com.google.protobuf.Parser<LogData> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public LogData getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder