Class AccessLogCommon
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.data.accesslog.v3.AccessLogCommon
- All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, AccessLogCommonOrBuilder, Serializable
@Generated
public final class AccessLogCommon
extends com.google.protobuf.GeneratedMessage
implements AccessLogCommonOrBuilder
Defines fields that are shared by all Envoy access logs. [#next-free-field: 34]Protobuf type
envoy.data.accesslog.v3.AccessLogCommon- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classDefines fields that are shared by all Envoy access logs.private static final classprivate static final classNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intprivate intprivate intstatic final intprivate Objectstatic final intprivate static final AccessLogCommonstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intprivate Addressprivate Addressprivate Addressprivate Objectprivate longprivate longprivate com.google.protobuf.Durationstatic final intstatic final intprivate com.google.protobuf.MapField<String, com.google.protobuf.Any> static final intprivate booleanprivate byteprivate Metadatastatic final intprivate static final com.google.protobuf.Parser<AccessLogCommon> static final intprivate ResponseFlagsstatic final intprivate Objectstatic final intprivate doubleprivate static final longstatic final intprivate com.google.protobuf.Timestampstatic final intprivate Objectstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intprivate com.google.protobuf.Durationprivate com.google.protobuf.Durationprivate com.google.protobuf.Durationprivate com.google.protobuf.Durationprivate com.google.protobuf.Durationprivate com.google.protobuf.Durationprivate com.google.protobuf.Durationstatic final intprivate TLSPropertiesstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intprivate Objectprivate Addressprivate Addressprivate intprivate Objectprivate longprivate longFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivateprivateAccessLogCommon(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionbooleancontainsCustomTags(String key) A list of custom tags, which annotate logs with additional information.booleanMap of filter state in stream info that have been configured to be logged.booleanThe type of the access log, which indicates when the log was recorded.intThe type of the access log, which indicates when the log was recorded.Connection termination details may provide additional information about why the connection was terminated by Envoy for L4 reasons.com.google.protobuf.ByteStringConnection termination details may provide additional information about why the connection was terminated by Envoy for L4 reasons.Deprecated.intA list of custom tags, which annotate logs with additional information.A list of custom tags, which annotate logs with additional information.getCustomTagsOrDefault(String key, String defaultValue) A list of custom tags, which annotate logs with additional information.A list of custom tags, which annotate logs with additional information.static AccessLogCommonstatic final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorThis field is the downstream direct remote address on which the request from the user was received.This field is the downstream direct remote address on which the request from the user was received.This field is the local/destination address on which the request from the user was received.This field is the local/destination address on which the request from the user was received.This field is the remote/origin address on which the request from the user was received.This field is the remote/origin address on which the request from the user was received.If downstream connection in listener failed due to transport socket (e.g.com.google.protobuf.ByteStringIf downstream connection in listener failed due to transport socket (e.g.longFor HTTP: Total number of bytes received from the downstream by the http stream.longFor HTTP: Total number of bytes sent to the downstream by the http stream.com.google.protobuf.DurationFor HTTP: Total duration in milliseconds of the request from the start time to the last byte out.com.google.protobuf.DurationOrBuilderFor HTTP: Total duration in milliseconds of the request from the start time to the last byte out.Deprecated.intMap of filter state in stream info that have been configured to be logged.Map of filter state in stream info that have been configured to be logged.com.google.protobuf.AnygetFilterStateObjectsOrDefault(String key, com.google.protobuf.Any defaultValue) Map of filter state in stream info that have been configured to be logged.com.google.protobuf.AnyMap of filter state in stream info that have been configured to be logged.booleanDeprecated.envoy.data.accesslog.v3.AccessLogCommon.intermediate_log_entry is deprecated.All metadata encountered during request processing, including endpoint selection.All metadata encountered during request processing, including endpoint selection.com.google.protobuf.Parser<AccessLogCommon> Flags indicating occurrences during request/response processing.Flags indicating occurrences during request/response processing.The name of the routecom.google.protobuf.ByteStringThe name of the routedouble[#not-implemented-hide:] This field indicates the rate at which this log entry was sampled.intcom.google.protobuf.TimestampThe time that Envoy started servicing this request.com.google.protobuf.TimestampOrBuilderThe time that Envoy started servicing this request.Optional unique id of stream (TCP connection, long-live HTTP2 stream, HTTP request) for logging and tracing.com.google.protobuf.ByteStringOptional unique id of stream (TCP connection, long-live HTTP2 stream, HTTP request) for logging and tracing.com.google.protobuf.DurationInterval between the first downstream byte received and the first downstream byte sent.com.google.protobuf.DurationOrBuilderInterval between the first downstream byte received and the first downstream byte sent.com.google.protobuf.DurationInterval between the first downstream byte received and the first upstream byte received (i.e.com.google.protobuf.DurationOrBuilderInterval between the first downstream byte received and the first upstream byte received (i.e.com.google.protobuf.DurationInterval between the first downstream byte received and the first upstream byte sent.com.google.protobuf.DurationOrBuilderInterval between the first downstream byte received and the first upstream byte sent.com.google.protobuf.DurationInterval between the first downstream byte received and the last downstream byte sent.com.google.protobuf.DurationOrBuilderInterval between the first downstream byte received and the last downstream byte sent.com.google.protobuf.DurationInterval between the first downstream byte received and the last downstream byte received (i.e.com.google.protobuf.DurationOrBuilderInterval between the first downstream byte received and the last downstream byte received (i.e.com.google.protobuf.DurationInterval between the first downstream byte received and the last upstream byte received (i.e.com.google.protobuf.DurationOrBuilderInterval between the first downstream byte received and the last upstream byte received (i.e.com.google.protobuf.DurationInterval between the first downstream byte received and the last upstream byte sent.com.google.protobuf.DurationOrBuilderInterval between the first downstream byte received and the last upstream byte sent.If the connection is secure,S this field will contain TLS properties.If the connection is secure,S this field will contain TLS properties.The upstream cluster that ``upstream_remote_address`` belongs to.com.google.protobuf.ByteStringThe upstream cluster that ``upstream_remote_address`` belongs to.The upstream local/origin address that handles this exchange.The upstream local/origin address that handles this exchange.The upstream remote/destination address that handles this exchange.The upstream remote/destination address that handles this exchange.intFor HTTP: Number of times the request is attempted upstream.If upstream connection failed due to transport socket (e.g.com.google.protobuf.ByteStringIf upstream connection failed due to transport socket (e.g.longFor HTTP: Total number of bytes received from the upstream by the http stream.longFor HTTP: Total number of bytes sent to the upstream by the http stream.booleanThis field is the downstream direct remote address on which the request from the user was received.booleanThis field is the local/destination address on which the request from the user was received.booleanThis field is the remote/origin address on which the request from the user was received.booleanFor HTTP: Total duration in milliseconds of the request from the start time to the last byte out.inthashCode()booleanAll metadata encountered during request processing, including endpoint selection.booleanFlags indicating occurrences during request/response processing.booleanThe time that Envoy started servicing this request.booleanInterval between the first downstream byte received and the first downstream byte sent.booleanInterval between the first downstream byte received and the first upstream byte received (i.e.booleanInterval between the first downstream byte received and the first upstream byte sent.booleanInterval between the first downstream byte received and the last downstream byte sent.booleanInterval between the first downstream byte received and the last downstream byte received (i.e.booleanInterval between the first downstream byte received and the last upstream byte received (i.e.booleanInterval between the first downstream byte received and the last upstream byte sent.booleanIf the connection is secure,S this field will contain TLS properties.booleanThe upstream local/origin address that handles this exchange.booleanThe upstream remote/destination address that handles this exchange.protected com.google.protobuf.GeneratedMessage.FieldAccessorTableprivate com.google.protobuf.MapField<String, com.google.protobuf.Any> protected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number) final booleanstatic AccessLogCommon.Builderstatic AccessLogCommon.BuildernewBuilder(AccessLogCommon prototype) protected AccessLogCommon.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static AccessLogCommonparseDelimitedFrom(InputStream input) static AccessLogCommonparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AccessLogCommonparseFrom(byte[] data) static AccessLogCommonparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AccessLogCommonparseFrom(com.google.protobuf.ByteString data) static AccessLogCommonparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AccessLogCommonparseFrom(com.google.protobuf.CodedInputStream input) static AccessLogCommonparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AccessLogCommonparseFrom(InputStream input) static AccessLogCommonparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AccessLogCommonparseFrom(ByteBuffer data) static AccessLogCommonparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<AccessLogCommon> parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
bitField0_
private int bitField0_ -
SAMPLE_RATE_FIELD_NUMBER
public static final int SAMPLE_RATE_FIELD_NUMBER- See Also:
-
sampleRate_
private double sampleRate_ -
DOWNSTREAM_REMOTE_ADDRESS_FIELD_NUMBER
public static final int DOWNSTREAM_REMOTE_ADDRESS_FIELD_NUMBER- See Also:
-
downstreamRemoteAddress_
-
DOWNSTREAM_LOCAL_ADDRESS_FIELD_NUMBER
public static final int DOWNSTREAM_LOCAL_ADDRESS_FIELD_NUMBER- See Also:
-
downstreamLocalAddress_
-
TLS_PROPERTIES_FIELD_NUMBER
public static final int TLS_PROPERTIES_FIELD_NUMBER- See Also:
-
tlsProperties_
-
START_TIME_FIELD_NUMBER
public static final int START_TIME_FIELD_NUMBER- See Also:
-
startTime_
private com.google.protobuf.Timestamp startTime_ -
TIME_TO_LAST_RX_BYTE_FIELD_NUMBER
public static final int TIME_TO_LAST_RX_BYTE_FIELD_NUMBER- See Also:
-
timeToLastRxByte_
private com.google.protobuf.Duration timeToLastRxByte_ -
TIME_TO_FIRST_UPSTREAM_TX_BYTE_FIELD_NUMBER
public static final int TIME_TO_FIRST_UPSTREAM_TX_BYTE_FIELD_NUMBER- See Also:
-
timeToFirstUpstreamTxByte_
private com.google.protobuf.Duration timeToFirstUpstreamTxByte_ -
TIME_TO_LAST_UPSTREAM_TX_BYTE_FIELD_NUMBER
public static final int TIME_TO_LAST_UPSTREAM_TX_BYTE_FIELD_NUMBER- See Also:
-
timeToLastUpstreamTxByte_
private com.google.protobuf.Duration timeToLastUpstreamTxByte_ -
TIME_TO_FIRST_UPSTREAM_RX_BYTE_FIELD_NUMBER
public static final int TIME_TO_FIRST_UPSTREAM_RX_BYTE_FIELD_NUMBER- See Also:
-
timeToFirstUpstreamRxByte_
private com.google.protobuf.Duration timeToFirstUpstreamRxByte_ -
TIME_TO_LAST_UPSTREAM_RX_BYTE_FIELD_NUMBER
public static final int TIME_TO_LAST_UPSTREAM_RX_BYTE_FIELD_NUMBER- See Also:
-
timeToLastUpstreamRxByte_
private com.google.protobuf.Duration timeToLastUpstreamRxByte_ -
TIME_TO_FIRST_DOWNSTREAM_TX_BYTE_FIELD_NUMBER
public static final int TIME_TO_FIRST_DOWNSTREAM_TX_BYTE_FIELD_NUMBER- See Also:
-
timeToFirstDownstreamTxByte_
private com.google.protobuf.Duration timeToFirstDownstreamTxByte_ -
TIME_TO_LAST_DOWNSTREAM_TX_BYTE_FIELD_NUMBER
public static final int TIME_TO_LAST_DOWNSTREAM_TX_BYTE_FIELD_NUMBER- See Also:
-
timeToLastDownstreamTxByte_
private com.google.protobuf.Duration timeToLastDownstreamTxByte_ -
UPSTREAM_REMOTE_ADDRESS_FIELD_NUMBER
public static final int UPSTREAM_REMOTE_ADDRESS_FIELD_NUMBER- See Also:
-
upstreamRemoteAddress_
-
UPSTREAM_LOCAL_ADDRESS_FIELD_NUMBER
public static final int UPSTREAM_LOCAL_ADDRESS_FIELD_NUMBER- See Also:
-
upstreamLocalAddress_
-
UPSTREAM_CLUSTER_FIELD_NUMBER
public static final int UPSTREAM_CLUSTER_FIELD_NUMBER- See Also:
-
upstreamCluster_
-
RESPONSE_FLAGS_FIELD_NUMBER
public static final int RESPONSE_FLAGS_FIELD_NUMBER- See Also:
-
responseFlags_
-
METADATA_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER- See Also:
-
metadata_
-
UPSTREAM_TRANSPORT_FAILURE_REASON_FIELD_NUMBER
public static final int UPSTREAM_TRANSPORT_FAILURE_REASON_FIELD_NUMBER- See Also:
-
upstreamTransportFailureReason_
-
ROUTE_NAME_FIELD_NUMBER
public static final int ROUTE_NAME_FIELD_NUMBER- See Also:
-
routeName_
-
DOWNSTREAM_DIRECT_REMOTE_ADDRESS_FIELD_NUMBER
public static final int DOWNSTREAM_DIRECT_REMOTE_ADDRESS_FIELD_NUMBER- See Also:
-
downstreamDirectRemoteAddress_
-
FILTER_STATE_OBJECTS_FIELD_NUMBER
public static final int FILTER_STATE_OBJECTS_FIELD_NUMBER- See Also:
-
filterStateObjects_
-
CUSTOM_TAGS_FIELD_NUMBER
public static final int CUSTOM_TAGS_FIELD_NUMBER- See Also:
-
customTags_
-
DURATION_FIELD_NUMBER
public static final int DURATION_FIELD_NUMBER- See Also:
-
duration_
private com.google.protobuf.Duration duration_ -
UPSTREAM_REQUEST_ATTEMPT_COUNT_FIELD_NUMBER
public static final int UPSTREAM_REQUEST_ATTEMPT_COUNT_FIELD_NUMBER- See Also:
-
upstreamRequestAttemptCount_
private int upstreamRequestAttemptCount_ -
CONNECTION_TERMINATION_DETAILS_FIELD_NUMBER
public static final int CONNECTION_TERMINATION_DETAILS_FIELD_NUMBER- See Also:
-
connectionTerminationDetails_
-
STREAM_ID_FIELD_NUMBER
public static final int STREAM_ID_FIELD_NUMBER- See Also:
-
streamId_
-
INTERMEDIATE_LOG_ENTRY_FIELD_NUMBER
public static final int INTERMEDIATE_LOG_ENTRY_FIELD_NUMBER- See Also:
-
intermediateLogEntry_
private boolean intermediateLogEntry_ -
DOWNSTREAM_TRANSPORT_FAILURE_REASON_FIELD_NUMBER
public static final int DOWNSTREAM_TRANSPORT_FAILURE_REASON_FIELD_NUMBER- See Also:
-
downstreamTransportFailureReason_
-
DOWNSTREAM_WIRE_BYTES_SENT_FIELD_NUMBER
public static final int DOWNSTREAM_WIRE_BYTES_SENT_FIELD_NUMBER- See Also:
-
downstreamWireBytesSent_
private long downstreamWireBytesSent_ -
DOWNSTREAM_WIRE_BYTES_RECEIVED_FIELD_NUMBER
public static final int DOWNSTREAM_WIRE_BYTES_RECEIVED_FIELD_NUMBER- See Also:
-
downstreamWireBytesReceived_
private long downstreamWireBytesReceived_ -
UPSTREAM_WIRE_BYTES_SENT_FIELD_NUMBER
public static final int UPSTREAM_WIRE_BYTES_SENT_FIELD_NUMBER- See Also:
-
upstreamWireBytesSent_
private long upstreamWireBytesSent_ -
UPSTREAM_WIRE_BYTES_RECEIVED_FIELD_NUMBER
public static final int UPSTREAM_WIRE_BYTES_RECEIVED_FIELD_NUMBER- See Also:
-
upstreamWireBytesReceived_
private long upstreamWireBytesReceived_ -
ACCESS_LOG_TYPE_FIELD_NUMBER
public static final int ACCESS_LOG_TYPE_FIELD_NUMBER- See Also:
-
accessLogType_
private int accessLogType_ -
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
AccessLogCommon
private AccessLogCommon(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
AccessLogCommon
private AccessLogCommon()
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage
-
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getSampleRate
public double getSampleRate()[#not-implemented-hide:] This field indicates the rate at which this log entry was sampled. Valid range is (0.0, 1.0].
double sample_rate = 1 [(.validate.rules) = { ... }- Specified by:
getSampleRatein interfaceAccessLogCommonOrBuilder- Returns:
- The sampleRate.
-
hasDownstreamRemoteAddress
public boolean hasDownstreamRemoteAddress()This field is the remote/origin address on which the request from the user was received. Note: This may not be the physical peer. E.g, if the remote address is inferred from for example the x-forwarder-for header, proxy protocol, etc.
.envoy.config.core.v3.Address downstream_remote_address = 2;- Specified by:
hasDownstreamRemoteAddressin interfaceAccessLogCommonOrBuilder- Returns:
- Whether the downstreamRemoteAddress field is set.
-
getDownstreamRemoteAddress
This field is the remote/origin address on which the request from the user was received. Note: This may not be the physical peer. E.g, if the remote address is inferred from for example the x-forwarder-for header, proxy protocol, etc.
.envoy.config.core.v3.Address downstream_remote_address = 2;- Specified by:
getDownstreamRemoteAddressin interfaceAccessLogCommonOrBuilder- Returns:
- The downstreamRemoteAddress.
-
getDownstreamRemoteAddressOrBuilder
This field is the remote/origin address on which the request from the user was received. Note: This may not be the physical peer. E.g, if the remote address is inferred from for example the x-forwarder-for header, proxy protocol, etc.
.envoy.config.core.v3.Address downstream_remote_address = 2;- Specified by:
getDownstreamRemoteAddressOrBuilderin interfaceAccessLogCommonOrBuilder
-
hasDownstreamLocalAddress
public boolean hasDownstreamLocalAddress()This field is the local/destination address on which the request from the user was received.
.envoy.config.core.v3.Address downstream_local_address = 3;- Specified by:
hasDownstreamLocalAddressin interfaceAccessLogCommonOrBuilder- Returns:
- Whether the downstreamLocalAddress field is set.
-
getDownstreamLocalAddress
This field is the local/destination address on which the request from the user was received.
.envoy.config.core.v3.Address downstream_local_address = 3;- Specified by:
getDownstreamLocalAddressin interfaceAccessLogCommonOrBuilder- Returns:
- The downstreamLocalAddress.
-
getDownstreamLocalAddressOrBuilder
This field is the local/destination address on which the request from the user was received.
.envoy.config.core.v3.Address downstream_local_address = 3;- Specified by:
getDownstreamLocalAddressOrBuilderin interfaceAccessLogCommonOrBuilder
-
hasTlsProperties
public boolean hasTlsProperties()If the connection is secure,S this field will contain TLS properties.
.envoy.data.accesslog.v3.TLSProperties tls_properties = 4;- Specified by:
hasTlsPropertiesin interfaceAccessLogCommonOrBuilder- Returns:
- Whether the tlsProperties field is set.
-
getTlsProperties
If the connection is secure,S this field will contain TLS properties.
.envoy.data.accesslog.v3.TLSProperties tls_properties = 4;- Specified by:
getTlsPropertiesin interfaceAccessLogCommonOrBuilder- Returns:
- The tlsProperties.
-
getTlsPropertiesOrBuilder
If the connection is secure,S this field will contain TLS properties.
.envoy.data.accesslog.v3.TLSProperties tls_properties = 4;- Specified by:
getTlsPropertiesOrBuilderin interfaceAccessLogCommonOrBuilder
-
hasStartTime
public boolean hasStartTime()The time that Envoy started servicing this request. This is effectively the time that the first downstream byte is received.
.google.protobuf.Timestamp start_time = 5;- Specified by:
hasStartTimein interfaceAccessLogCommonOrBuilder- Returns:
- Whether the startTime field is set.
-
getStartTime
public com.google.protobuf.Timestamp getStartTime()The time that Envoy started servicing this request. This is effectively the time that the first downstream byte is received.
.google.protobuf.Timestamp start_time = 5;- Specified by:
getStartTimein interfaceAccessLogCommonOrBuilder- Returns:
- The startTime.
-
getStartTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()The time that Envoy started servicing this request. This is effectively the time that the first downstream byte is received.
.google.protobuf.Timestamp start_time = 5;- Specified by:
getStartTimeOrBuilderin interfaceAccessLogCommonOrBuilder
-
hasTimeToLastRxByte
public boolean hasTimeToLastRxByte()Interval between the first downstream byte received and the last downstream byte received (i.e. time it takes to receive a request).
.google.protobuf.Duration time_to_last_rx_byte = 6;- Specified by:
hasTimeToLastRxBytein interfaceAccessLogCommonOrBuilder- Returns:
- Whether the timeToLastRxByte field is set.
-
getTimeToLastRxByte
public com.google.protobuf.Duration getTimeToLastRxByte()Interval between the first downstream byte received and the last downstream byte received (i.e. time it takes to receive a request).
.google.protobuf.Duration time_to_last_rx_byte = 6;- Specified by:
getTimeToLastRxBytein interfaceAccessLogCommonOrBuilder- Returns:
- The timeToLastRxByte.
-
getTimeToLastRxByteOrBuilder
public com.google.protobuf.DurationOrBuilder getTimeToLastRxByteOrBuilder()Interval between the first downstream byte received and the last downstream byte received (i.e. time it takes to receive a request).
.google.protobuf.Duration time_to_last_rx_byte = 6;- Specified by:
getTimeToLastRxByteOrBuilderin interfaceAccessLogCommonOrBuilder
-
hasTimeToFirstUpstreamTxByte
public boolean hasTimeToFirstUpstreamTxByte()Interval between the first downstream byte received and the first upstream byte sent. There may by considerable delta between ``time_to_last_rx_byte`` and this value due to filters. Additionally, the same caveats apply as documented in ``time_to_last_downstream_tx_byte`` about not accounting for kernel socket buffer time, etc.
.google.protobuf.Duration time_to_first_upstream_tx_byte = 7;- Specified by:
hasTimeToFirstUpstreamTxBytein interfaceAccessLogCommonOrBuilder- Returns:
- Whether the timeToFirstUpstreamTxByte field is set.
-
getTimeToFirstUpstreamTxByte
public com.google.protobuf.Duration getTimeToFirstUpstreamTxByte()Interval between the first downstream byte received and the first upstream byte sent. There may by considerable delta between ``time_to_last_rx_byte`` and this value due to filters. Additionally, the same caveats apply as documented in ``time_to_last_downstream_tx_byte`` about not accounting for kernel socket buffer time, etc.
.google.protobuf.Duration time_to_first_upstream_tx_byte = 7;- Specified by:
getTimeToFirstUpstreamTxBytein interfaceAccessLogCommonOrBuilder- Returns:
- The timeToFirstUpstreamTxByte.
-
getTimeToFirstUpstreamTxByteOrBuilder
public com.google.protobuf.DurationOrBuilder getTimeToFirstUpstreamTxByteOrBuilder()Interval between the first downstream byte received and the first upstream byte sent. There may by considerable delta between ``time_to_last_rx_byte`` and this value due to filters. Additionally, the same caveats apply as documented in ``time_to_last_downstream_tx_byte`` about not accounting for kernel socket buffer time, etc.
.google.protobuf.Duration time_to_first_upstream_tx_byte = 7;- Specified by:
getTimeToFirstUpstreamTxByteOrBuilderin interfaceAccessLogCommonOrBuilder
-
hasTimeToLastUpstreamTxByte
public boolean hasTimeToLastUpstreamTxByte()Interval between the first downstream byte received and the last upstream byte sent. There may by considerable delta between ``time_to_last_rx_byte`` and this value due to filters. Additionally, the same caveats apply as documented in ``time_to_last_downstream_tx_byte`` about not accounting for kernel socket buffer time, etc.
.google.protobuf.Duration time_to_last_upstream_tx_byte = 8;- Specified by:
hasTimeToLastUpstreamTxBytein interfaceAccessLogCommonOrBuilder- Returns:
- Whether the timeToLastUpstreamTxByte field is set.
-
getTimeToLastUpstreamTxByte
public com.google.protobuf.Duration getTimeToLastUpstreamTxByte()Interval between the first downstream byte received and the last upstream byte sent. There may by considerable delta between ``time_to_last_rx_byte`` and this value due to filters. Additionally, the same caveats apply as documented in ``time_to_last_downstream_tx_byte`` about not accounting for kernel socket buffer time, etc.
.google.protobuf.Duration time_to_last_upstream_tx_byte = 8;- Specified by:
getTimeToLastUpstreamTxBytein interfaceAccessLogCommonOrBuilder- Returns:
- The timeToLastUpstreamTxByte.
-
getTimeToLastUpstreamTxByteOrBuilder
public com.google.protobuf.DurationOrBuilder getTimeToLastUpstreamTxByteOrBuilder()Interval between the first downstream byte received and the last upstream byte sent. There may by considerable delta between ``time_to_last_rx_byte`` and this value due to filters. Additionally, the same caveats apply as documented in ``time_to_last_downstream_tx_byte`` about not accounting for kernel socket buffer time, etc.
.google.protobuf.Duration time_to_last_upstream_tx_byte = 8;- Specified by:
getTimeToLastUpstreamTxByteOrBuilderin interfaceAccessLogCommonOrBuilder
-
hasTimeToFirstUpstreamRxByte
public boolean hasTimeToFirstUpstreamRxByte()Interval between the first downstream byte received and the first upstream byte received (i.e. time it takes to start receiving a response).
.google.protobuf.Duration time_to_first_upstream_rx_byte = 9;- Specified by:
hasTimeToFirstUpstreamRxBytein interfaceAccessLogCommonOrBuilder- Returns:
- Whether the timeToFirstUpstreamRxByte field is set.
-
getTimeToFirstUpstreamRxByte
public com.google.protobuf.Duration getTimeToFirstUpstreamRxByte()Interval between the first downstream byte received and the first upstream byte received (i.e. time it takes to start receiving a response).
.google.protobuf.Duration time_to_first_upstream_rx_byte = 9;- Specified by:
getTimeToFirstUpstreamRxBytein interfaceAccessLogCommonOrBuilder- Returns:
- The timeToFirstUpstreamRxByte.
-
getTimeToFirstUpstreamRxByteOrBuilder
public com.google.protobuf.DurationOrBuilder getTimeToFirstUpstreamRxByteOrBuilder()Interval between the first downstream byte received and the first upstream byte received (i.e. time it takes to start receiving a response).
.google.protobuf.Duration time_to_first_upstream_rx_byte = 9;- Specified by:
getTimeToFirstUpstreamRxByteOrBuilderin interfaceAccessLogCommonOrBuilder
-
hasTimeToLastUpstreamRxByte
public boolean hasTimeToLastUpstreamRxByte()Interval between the first downstream byte received and the last upstream byte received (i.e. time it takes to receive a complete response).
.google.protobuf.Duration time_to_last_upstream_rx_byte = 10;- Specified by:
hasTimeToLastUpstreamRxBytein interfaceAccessLogCommonOrBuilder- Returns:
- Whether the timeToLastUpstreamRxByte field is set.
-
getTimeToLastUpstreamRxByte
public com.google.protobuf.Duration getTimeToLastUpstreamRxByte()Interval between the first downstream byte received and the last upstream byte received (i.e. time it takes to receive a complete response).
.google.protobuf.Duration time_to_last_upstream_rx_byte = 10;- Specified by:
getTimeToLastUpstreamRxBytein interfaceAccessLogCommonOrBuilder- Returns:
- The timeToLastUpstreamRxByte.
-
getTimeToLastUpstreamRxByteOrBuilder
public com.google.protobuf.DurationOrBuilder getTimeToLastUpstreamRxByteOrBuilder()Interval between the first downstream byte received and the last upstream byte received (i.e. time it takes to receive a complete response).
.google.protobuf.Duration time_to_last_upstream_rx_byte = 10;- Specified by:
getTimeToLastUpstreamRxByteOrBuilderin interfaceAccessLogCommonOrBuilder
-
hasTimeToFirstDownstreamTxByte
public boolean hasTimeToFirstDownstreamTxByte()Interval between the first downstream byte received and the first downstream byte sent. There may be a considerable delta between the ``time_to_first_upstream_rx_byte`` and this field due to filters. Additionally, the same caveats apply as documented in ``time_to_last_downstream_tx_byte`` about not accounting for kernel socket buffer time, etc.
.google.protobuf.Duration time_to_first_downstream_tx_byte = 11;- Specified by:
hasTimeToFirstDownstreamTxBytein interfaceAccessLogCommonOrBuilder- Returns:
- Whether the timeToFirstDownstreamTxByte field is set.
-
getTimeToFirstDownstreamTxByte
public com.google.protobuf.Duration getTimeToFirstDownstreamTxByte()Interval between the first downstream byte received and the first downstream byte sent. There may be a considerable delta between the ``time_to_first_upstream_rx_byte`` and this field due to filters. Additionally, the same caveats apply as documented in ``time_to_last_downstream_tx_byte`` about not accounting for kernel socket buffer time, etc.
.google.protobuf.Duration time_to_first_downstream_tx_byte = 11;- Specified by:
getTimeToFirstDownstreamTxBytein interfaceAccessLogCommonOrBuilder- Returns:
- The timeToFirstDownstreamTxByte.
-
getTimeToFirstDownstreamTxByteOrBuilder
public com.google.protobuf.DurationOrBuilder getTimeToFirstDownstreamTxByteOrBuilder()Interval between the first downstream byte received and the first downstream byte sent. There may be a considerable delta between the ``time_to_first_upstream_rx_byte`` and this field due to filters. Additionally, the same caveats apply as documented in ``time_to_last_downstream_tx_byte`` about not accounting for kernel socket buffer time, etc.
.google.protobuf.Duration time_to_first_downstream_tx_byte = 11;- Specified by:
getTimeToFirstDownstreamTxByteOrBuilderin interfaceAccessLogCommonOrBuilder
-
hasTimeToLastDownstreamTxByte
public boolean hasTimeToLastDownstreamTxByte()Interval between the first downstream byte received and the last downstream byte sent. Depending on protocol, buffering, windowing, filters, etc. there may be a considerable delta between ``time_to_last_upstream_rx_byte`` and this field. Note also that this is an approximate time. In the current implementation it does not include kernel socket buffer time. In the current implementation it also does not include send window buffering inside the HTTP/2 codec. In the future it is likely that work will be done to make this duration more accurate.
.google.protobuf.Duration time_to_last_downstream_tx_byte = 12;- Specified by:
hasTimeToLastDownstreamTxBytein interfaceAccessLogCommonOrBuilder- Returns:
- Whether the timeToLastDownstreamTxByte field is set.
-
getTimeToLastDownstreamTxByte
public com.google.protobuf.Duration getTimeToLastDownstreamTxByte()Interval between the first downstream byte received and the last downstream byte sent. Depending on protocol, buffering, windowing, filters, etc. there may be a considerable delta between ``time_to_last_upstream_rx_byte`` and this field. Note also that this is an approximate time. In the current implementation it does not include kernel socket buffer time. In the current implementation it also does not include send window buffering inside the HTTP/2 codec. In the future it is likely that work will be done to make this duration more accurate.
.google.protobuf.Duration time_to_last_downstream_tx_byte = 12;- Specified by:
getTimeToLastDownstreamTxBytein interfaceAccessLogCommonOrBuilder- Returns:
- The timeToLastDownstreamTxByte.
-
getTimeToLastDownstreamTxByteOrBuilder
public com.google.protobuf.DurationOrBuilder getTimeToLastDownstreamTxByteOrBuilder()Interval between the first downstream byte received and the last downstream byte sent. Depending on protocol, buffering, windowing, filters, etc. there may be a considerable delta between ``time_to_last_upstream_rx_byte`` and this field. Note also that this is an approximate time. In the current implementation it does not include kernel socket buffer time. In the current implementation it also does not include send window buffering inside the HTTP/2 codec. In the future it is likely that work will be done to make this duration more accurate.
.google.protobuf.Duration time_to_last_downstream_tx_byte = 12;- Specified by:
getTimeToLastDownstreamTxByteOrBuilderin interfaceAccessLogCommonOrBuilder
-
hasUpstreamRemoteAddress
public boolean hasUpstreamRemoteAddress()The upstream remote/destination address that handles this exchange. This does not include retries.
.envoy.config.core.v3.Address upstream_remote_address = 13;- Specified by:
hasUpstreamRemoteAddressin interfaceAccessLogCommonOrBuilder- Returns:
- Whether the upstreamRemoteAddress field is set.
-
getUpstreamRemoteAddress
The upstream remote/destination address that handles this exchange. This does not include retries.
.envoy.config.core.v3.Address upstream_remote_address = 13;- Specified by:
getUpstreamRemoteAddressin interfaceAccessLogCommonOrBuilder- Returns:
- The upstreamRemoteAddress.
-
getUpstreamRemoteAddressOrBuilder
The upstream remote/destination address that handles this exchange. This does not include retries.
.envoy.config.core.v3.Address upstream_remote_address = 13;- Specified by:
getUpstreamRemoteAddressOrBuilderin interfaceAccessLogCommonOrBuilder
-
hasUpstreamLocalAddress
public boolean hasUpstreamLocalAddress()The upstream local/origin address that handles this exchange. This does not include retries.
.envoy.config.core.v3.Address upstream_local_address = 14;- Specified by:
hasUpstreamLocalAddressin interfaceAccessLogCommonOrBuilder- Returns:
- Whether the upstreamLocalAddress field is set.
-
getUpstreamLocalAddress
The upstream local/origin address that handles this exchange. This does not include retries.
.envoy.config.core.v3.Address upstream_local_address = 14;- Specified by:
getUpstreamLocalAddressin interfaceAccessLogCommonOrBuilder- Returns:
- The upstreamLocalAddress.
-
getUpstreamLocalAddressOrBuilder
The upstream local/origin address that handles this exchange. This does not include retries.
.envoy.config.core.v3.Address upstream_local_address = 14;- Specified by:
getUpstreamLocalAddressOrBuilderin interfaceAccessLogCommonOrBuilder
-
getUpstreamCluster
The upstream cluster that ``upstream_remote_address`` belongs to.
string upstream_cluster = 15;- Specified by:
getUpstreamClusterin interfaceAccessLogCommonOrBuilder- Returns:
- The upstreamCluster.
-
getUpstreamClusterBytes
public com.google.protobuf.ByteString getUpstreamClusterBytes()The upstream cluster that ``upstream_remote_address`` belongs to.
string upstream_cluster = 15;- Specified by:
getUpstreamClusterBytesin interfaceAccessLogCommonOrBuilder- Returns:
- The bytes for upstreamCluster.
-
hasResponseFlags
public boolean hasResponseFlags()Flags indicating occurrences during request/response processing.
.envoy.data.accesslog.v3.ResponseFlags response_flags = 16;- Specified by:
hasResponseFlagsin interfaceAccessLogCommonOrBuilder- Returns:
- Whether the responseFlags field is set.
-
getResponseFlags
Flags indicating occurrences during request/response processing.
.envoy.data.accesslog.v3.ResponseFlags response_flags = 16;- Specified by:
getResponseFlagsin interfaceAccessLogCommonOrBuilder- Returns:
- The responseFlags.
-
getResponseFlagsOrBuilder
Flags indicating occurrences during request/response processing.
.envoy.data.accesslog.v3.ResponseFlags response_flags = 16;- Specified by:
getResponseFlagsOrBuilderin interfaceAccessLogCommonOrBuilder
-
hasMetadata
public boolean hasMetadata()All metadata encountered during request processing, including endpoint selection. This can be used to associate IDs attached to the various configurations used to process this request with the access log entry. For example, a route created from a higher level forwarding rule with some ID can place that ID in this field and cross reference later. It can also be used to determine if a canary endpoint was used or not.
.envoy.config.core.v3.Metadata metadata = 17;- Specified by:
hasMetadatain interfaceAccessLogCommonOrBuilder- Returns:
- Whether the metadata field is set.
-
getMetadata
All metadata encountered during request processing, including endpoint selection. This can be used to associate IDs attached to the various configurations used to process this request with the access log entry. For example, a route created from a higher level forwarding rule with some ID can place that ID in this field and cross reference later. It can also be used to determine if a canary endpoint was used or not.
.envoy.config.core.v3.Metadata metadata = 17;- Specified by:
getMetadatain interfaceAccessLogCommonOrBuilder- Returns:
- The metadata.
-
getMetadataOrBuilder
All metadata encountered during request processing, including endpoint selection. This can be used to associate IDs attached to the various configurations used to process this request with the access log entry. For example, a route created from a higher level forwarding rule with some ID can place that ID in this field and cross reference later. It can also be used to determine if a canary endpoint was used or not.
.envoy.config.core.v3.Metadata metadata = 17;- Specified by:
getMetadataOrBuilderin interfaceAccessLogCommonOrBuilder
-
getUpstreamTransportFailureReason
If upstream connection failed due to transport socket (e.g. TLS handshake), provides the failure reason from the transport socket. The format of this field depends on the configured upstream transport socket. Common TLS failures are in :ref:`TLS trouble shooting <arch_overview_ssl_trouble_shooting>`.
string upstream_transport_failure_reason = 18;- Specified by:
getUpstreamTransportFailureReasonin interfaceAccessLogCommonOrBuilder- Returns:
- The upstreamTransportFailureReason.
-
getUpstreamTransportFailureReasonBytes
public com.google.protobuf.ByteString getUpstreamTransportFailureReasonBytes()If upstream connection failed due to transport socket (e.g. TLS handshake), provides the failure reason from the transport socket. The format of this field depends on the configured upstream transport socket. Common TLS failures are in :ref:`TLS trouble shooting <arch_overview_ssl_trouble_shooting>`.
string upstream_transport_failure_reason = 18;- Specified by:
getUpstreamTransportFailureReasonBytesin interfaceAccessLogCommonOrBuilder- Returns:
- The bytes for upstreamTransportFailureReason.
-
getRouteName
The name of the route
string route_name = 19;- Specified by:
getRouteNamein interfaceAccessLogCommonOrBuilder- Returns:
- The routeName.
-
getRouteNameBytes
public com.google.protobuf.ByteString getRouteNameBytes()The name of the route
string route_name = 19;- Specified by:
getRouteNameBytesin interfaceAccessLogCommonOrBuilder- Returns:
- The bytes for routeName.
-
hasDownstreamDirectRemoteAddress
public boolean hasDownstreamDirectRemoteAddress()This field is the downstream direct remote address on which the request from the user was received. Note: This is always the physical peer, even if the remote address is inferred from for example the x-forwarder-for header, proxy protocol, etc.
.envoy.config.core.v3.Address downstream_direct_remote_address = 20;- Specified by:
hasDownstreamDirectRemoteAddressin interfaceAccessLogCommonOrBuilder- Returns:
- Whether the downstreamDirectRemoteAddress field is set.
-
getDownstreamDirectRemoteAddress
This field is the downstream direct remote address on which the request from the user was received. Note: This is always the physical peer, even if the remote address is inferred from for example the x-forwarder-for header, proxy protocol, etc.
.envoy.config.core.v3.Address downstream_direct_remote_address = 20;- Specified by:
getDownstreamDirectRemoteAddressin interfaceAccessLogCommonOrBuilder- Returns:
- The downstreamDirectRemoteAddress.
-
getDownstreamDirectRemoteAddressOrBuilder
This field is the downstream direct remote address on which the request from the user was received. Note: This is always the physical peer, even if the remote address is inferred from for example the x-forwarder-for header, proxy protocol, etc.
.envoy.config.core.v3.Address downstream_direct_remote_address = 20;- Specified by:
getDownstreamDirectRemoteAddressOrBuilderin interfaceAccessLogCommonOrBuilder
-
internalGetFilterStateObjects
private com.google.protobuf.MapField<String, com.google.protobuf.Any> internalGetFilterStateObjects() -
getFilterStateObjectsCount
public int getFilterStateObjectsCount()Description copied from interface:AccessLogCommonOrBuilderMap of filter state in stream info that have been configured to be logged. If the filter state serialized to any message other than ``google.protobuf.Any`` it will be packed into ``google.protobuf.Any``.
map<string, .google.protobuf.Any> filter_state_objects = 21;- Specified by:
getFilterStateObjectsCountin interfaceAccessLogCommonOrBuilder
-
containsFilterStateObjects
Map of filter state in stream info that have been configured to be logged. If the filter state serialized to any message other than ``google.protobuf.Any`` it will be packed into ``google.protobuf.Any``.
map<string, .google.protobuf.Any> filter_state_objects = 21;- Specified by:
containsFilterStateObjectsin interfaceAccessLogCommonOrBuilder
-
getFilterStateObjects
Deprecated.UsegetFilterStateObjectsMap()instead.- Specified by:
getFilterStateObjectsin interfaceAccessLogCommonOrBuilder
-
getFilterStateObjectsMap
Map of filter state in stream info that have been configured to be logged. If the filter state serialized to any message other than ``google.protobuf.Any`` it will be packed into ``google.protobuf.Any``.
map<string, .google.protobuf.Any> filter_state_objects = 21;- Specified by:
getFilterStateObjectsMapin interfaceAccessLogCommonOrBuilder
-
getFilterStateObjectsOrDefault
public com.google.protobuf.Any getFilterStateObjectsOrDefault(String key, com.google.protobuf.Any defaultValue) Map of filter state in stream info that have been configured to be logged. If the filter state serialized to any message other than ``google.protobuf.Any`` it will be packed into ``google.protobuf.Any``.
map<string, .google.protobuf.Any> filter_state_objects = 21;- Specified by:
getFilterStateObjectsOrDefaultin interfaceAccessLogCommonOrBuilder
-
getFilterStateObjectsOrThrow
Map of filter state in stream info that have been configured to be logged. If the filter state serialized to any message other than ``google.protobuf.Any`` it will be packed into ``google.protobuf.Any``.
map<string, .google.protobuf.Any> filter_state_objects = 21;- Specified by:
getFilterStateObjectsOrThrowin interfaceAccessLogCommonOrBuilder
-
internalGetCustomTags
-
getCustomTagsCount
public int getCustomTagsCount()Description copied from interface:AccessLogCommonOrBuilderA list of custom tags, which annotate logs with additional information. To configure this value, users should configure :ref:`custom_tags <envoy_v3_api_field_extensions.access_loggers.grpc.v3.CommonGrpcAccessLogConfig.custom_tags>`.
map<string, string> custom_tags = 22;- Specified by:
getCustomTagsCountin interfaceAccessLogCommonOrBuilder
-
containsCustomTags
A list of custom tags, which annotate logs with additional information. To configure this value, users should configure :ref:`custom_tags <envoy_v3_api_field_extensions.access_loggers.grpc.v3.CommonGrpcAccessLogConfig.custom_tags>`.
map<string, string> custom_tags = 22;- Specified by:
containsCustomTagsin interfaceAccessLogCommonOrBuilder
-
getCustomTags
Deprecated.UsegetCustomTagsMap()instead.- Specified by:
getCustomTagsin interfaceAccessLogCommonOrBuilder
-
getCustomTagsMap
A list of custom tags, which annotate logs with additional information. To configure this value, users should configure :ref:`custom_tags <envoy_v3_api_field_extensions.access_loggers.grpc.v3.CommonGrpcAccessLogConfig.custom_tags>`.
map<string, string> custom_tags = 22;- Specified by:
getCustomTagsMapin interfaceAccessLogCommonOrBuilder
-
getCustomTagsOrDefault
A list of custom tags, which annotate logs with additional information. To configure this value, users should configure :ref:`custom_tags <envoy_v3_api_field_extensions.access_loggers.grpc.v3.CommonGrpcAccessLogConfig.custom_tags>`.
map<string, string> custom_tags = 22;- Specified by:
getCustomTagsOrDefaultin interfaceAccessLogCommonOrBuilder
-
getCustomTagsOrThrow
A list of custom tags, which annotate logs with additional information. To configure this value, users should configure :ref:`custom_tags <envoy_v3_api_field_extensions.access_loggers.grpc.v3.CommonGrpcAccessLogConfig.custom_tags>`.
map<string, string> custom_tags = 22;- Specified by:
getCustomTagsOrThrowin interfaceAccessLogCommonOrBuilder
-
hasDuration
public boolean hasDuration()For HTTP: Total duration in milliseconds of the request from the start time to the last byte out. For TCP: Total duration in milliseconds of the downstream connection. This is the total duration of the request (i.e., when the request's ActiveStream is destroyed) and may be longer than ``time_to_last_downstream_tx_byte``.
.google.protobuf.Duration duration = 23;- Specified by:
hasDurationin interfaceAccessLogCommonOrBuilder- Returns:
- Whether the duration field is set.
-
getDuration
public com.google.protobuf.Duration getDuration()For HTTP: Total duration in milliseconds of the request from the start time to the last byte out. For TCP: Total duration in milliseconds of the downstream connection. This is the total duration of the request (i.e., when the request's ActiveStream is destroyed) and may be longer than ``time_to_last_downstream_tx_byte``.
.google.protobuf.Duration duration = 23;- Specified by:
getDurationin interfaceAccessLogCommonOrBuilder- Returns:
- The duration.
-
getDurationOrBuilder
public com.google.protobuf.DurationOrBuilder getDurationOrBuilder()For HTTP: Total duration in milliseconds of the request from the start time to the last byte out. For TCP: Total duration in milliseconds of the downstream connection. This is the total duration of the request (i.e., when the request's ActiveStream is destroyed) and may be longer than ``time_to_last_downstream_tx_byte``.
.google.protobuf.Duration duration = 23;- Specified by:
getDurationOrBuilderin interfaceAccessLogCommonOrBuilder
-
getUpstreamRequestAttemptCount
public int getUpstreamRequestAttemptCount()For HTTP: Number of times the request is attempted upstream. Note that the field is omitted when the request was never attempted upstream. For TCP: Number of times the connection request is attempted upstream. Note that the field is omitted when the connect request was never attempted upstream.
uint32 upstream_request_attempt_count = 24;- Specified by:
getUpstreamRequestAttemptCountin interfaceAccessLogCommonOrBuilder- Returns:
- The upstreamRequestAttemptCount.
-
getConnectionTerminationDetails
Connection termination details may provide additional information about why the connection was terminated by Envoy for L4 reasons.
string connection_termination_details = 25;- Specified by:
getConnectionTerminationDetailsin interfaceAccessLogCommonOrBuilder- Returns:
- The connectionTerminationDetails.
-
getConnectionTerminationDetailsBytes
public com.google.protobuf.ByteString getConnectionTerminationDetailsBytes()Connection termination details may provide additional information about why the connection was terminated by Envoy for L4 reasons.
string connection_termination_details = 25;- Specified by:
getConnectionTerminationDetailsBytesin interfaceAccessLogCommonOrBuilder- Returns:
- The bytes for connectionTerminationDetails.
-
getStreamId
Optional unique id of stream (TCP connection, long-live HTTP2 stream, HTTP request) for logging and tracing. This could be any format string that could be used to identify one stream.
string stream_id = 26;- Specified by:
getStreamIdin interfaceAccessLogCommonOrBuilder- Returns:
- The streamId.
-
getStreamIdBytes
public com.google.protobuf.ByteString getStreamIdBytes()Optional unique id of stream (TCP connection, long-live HTTP2 stream, HTTP request) for logging and tracing. This could be any format string that could be used to identify one stream.
string stream_id = 26;- Specified by:
getStreamIdBytesin interfaceAccessLogCommonOrBuilder- Returns:
- The bytes for streamId.
-
getIntermediateLogEntry
Deprecated.envoy.data.accesslog.v3.AccessLogCommon.intermediate_log_entry is deprecated. See envoy/data/accesslog/v3/accesslog.proto;l=239If this log entry is final log entry that flushed after the stream completed or intermediate log entry that flushed periodically during the stream. There may be multiple intermediate log entries and only one final log entry for each long-live stream (TCP connection, long-live HTTP2 stream). And if it is necessary, unique ID or identifier can be added to the log entry :ref:`stream_id <envoy_v3_api_field_data.accesslog.v3.AccessLogCommon.stream_id>` to correlate all these intermediate log entries and final log entry. .. attention:: This field is deprecated in favor of ``access_log_type`` for better indication of the type of the access log record.
bool intermediate_log_entry = 27 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];- Specified by:
getIntermediateLogEntryin interfaceAccessLogCommonOrBuilder- Returns:
- The intermediateLogEntry.
-
getDownstreamTransportFailureReason
If downstream connection in listener failed due to transport socket (e.g. TLS handshake), provides the failure reason from the transport socket. The format of this field depends on the configured downstream transport socket. Common TLS failures are in :ref:`TLS trouble shooting <arch_overview_ssl_trouble_shooting>`.
string downstream_transport_failure_reason = 28;- Specified by:
getDownstreamTransportFailureReasonin interfaceAccessLogCommonOrBuilder- Returns:
- The downstreamTransportFailureReason.
-
getDownstreamTransportFailureReasonBytes
public com.google.protobuf.ByteString getDownstreamTransportFailureReasonBytes()If downstream connection in listener failed due to transport socket (e.g. TLS handshake), provides the failure reason from the transport socket. The format of this field depends on the configured downstream transport socket. Common TLS failures are in :ref:`TLS trouble shooting <arch_overview_ssl_trouble_shooting>`.
string downstream_transport_failure_reason = 28;- Specified by:
getDownstreamTransportFailureReasonBytesin interfaceAccessLogCommonOrBuilder- Returns:
- The bytes for downstreamTransportFailureReason.
-
getDownstreamWireBytesSent
public long getDownstreamWireBytesSent()For HTTP: Total number of bytes sent to the downstream by the http stream. For TCP: Total number of bytes sent to the downstream by the tcp proxy.
uint64 downstream_wire_bytes_sent = 29;- Specified by:
getDownstreamWireBytesSentin interfaceAccessLogCommonOrBuilder- Returns:
- The downstreamWireBytesSent.
-
getDownstreamWireBytesReceived
public long getDownstreamWireBytesReceived()For HTTP: Total number of bytes received from the downstream by the http stream. Envoy over counts sizes of received HTTP/1.1 pipelined requests by adding up bytes of requests in the pipeline to the one currently being processed. For TCP: Total number of bytes received from the downstream by the tcp proxy.
uint64 downstream_wire_bytes_received = 30;- Specified by:
getDownstreamWireBytesReceivedin interfaceAccessLogCommonOrBuilder- Returns:
- The downstreamWireBytesReceived.
-
getUpstreamWireBytesSent
public long getUpstreamWireBytesSent()For HTTP: Total number of bytes sent to the upstream by the http stream. This value accumulates during upstream retries. For TCP: Total number of bytes sent to the upstream by the tcp proxy.
uint64 upstream_wire_bytes_sent = 31;- Specified by:
getUpstreamWireBytesSentin interfaceAccessLogCommonOrBuilder- Returns:
- The upstreamWireBytesSent.
-
getUpstreamWireBytesReceived
public long getUpstreamWireBytesReceived()For HTTP: Total number of bytes received from the upstream by the http stream. For TCP: Total number of bytes sent to the upstream by the tcp proxy.
uint64 upstream_wire_bytes_received = 32;- Specified by:
getUpstreamWireBytesReceivedin interfaceAccessLogCommonOrBuilder- Returns:
- The upstreamWireBytesReceived.
-
getAccessLogTypeValue
public int getAccessLogTypeValue()The type of the access log, which indicates when the log was recorded. See :ref:`ACCESS_LOG_TYPE <config_access_log_format_access_log_type>` for the available values. In case the access log was recorded by a flow which does not correspond to one of the supported values, then the default value will be ``NotSet``. For more information about how access log behaves and when it is being recorded, please refer to :ref:`access logging <arch_overview_access_logs>`.
.envoy.data.accesslog.v3.AccessLogType access_log_type = 33;- Specified by:
getAccessLogTypeValuein interfaceAccessLogCommonOrBuilder- Returns:
- The enum numeric value on the wire for accessLogType.
-
getAccessLogType
The type of the access log, which indicates when the log was recorded. See :ref:`ACCESS_LOG_TYPE <config_access_log_format_access_log_type>` for the available values. In case the access log was recorded by a flow which does not correspond to one of the supported values, then the default value will be ``NotSet``. For more information about how access log behaves and when it is being recorded, please refer to :ref:`access logging <arch_overview_access_logs>`.
.envoy.data.accesslog.v3.AccessLogType access_log_type = 33;- Specified by:
getAccessLogTypein interfaceAccessLogCommonOrBuilder- Returns:
- The accessLogType.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
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 AccessLogCommon parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static AccessLogCommon parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static AccessLogCommon parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static AccessLogCommon parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static AccessLogCommon parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static AccessLogCommon parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static AccessLogCommon parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static AccessLogCommon parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static AccessLogCommon parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static AccessLogCommon 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 AccessLogCommon.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-