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
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 class
Defines fields that are shared by all Envoy access logs.private static final class
private static final class
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
private int
private int
static final int
private Object
static final int
private static final AccessLogCommon
static final int
static final int
static final int
static final int
static final int
static final int
private Address
private Address
private Address
private Object
private long
private long
private com.google.protobuf.Duration
static final int
static final int
private com.google.protobuf.MapField
<String, com.google.protobuf.Any> static final int
private boolean
private byte
private Metadata
static final int
private static final com.google.protobuf.Parser
<AccessLogCommon> static final int
private ResponseFlags
static final int
private Object
static final int
private double
private static final long
static final int
private com.google.protobuf.Timestamp
static final int
private Object
static final int
static final int
static final int
static final int
static final int
static final int
static final int
private com.google.protobuf.Duration
private com.google.protobuf.Duration
private com.google.protobuf.Duration
private com.google.protobuf.Duration
private com.google.protobuf.Duration
private com.google.protobuf.Duration
private com.google.protobuf.Duration
static final int
private TLSProperties
static final int
static final int
static final int
static final int
static final int
static final int
static final int
private Object
private Address
private Address
private int
private Object
private long
private long
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
private
AccessLogCommon
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
containsCustomTags
(String key) A list of custom tags, which annotate logs with additional information.boolean
Map of filter state in stream info that have been configured to be logged.boolean
The type of the access log, which indicates when the log was recorded.int
The 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.ByteString
Connection termination details may provide additional information about why the connection was terminated by Envoy for L4 reasons.Deprecated.int
A 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 AccessLogCommon
static final com.google.protobuf.Descriptors.Descriptor
This 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.ByteString
If downstream connection in listener failed due to transport socket (e.g.long
For HTTP: Total number of bytes received from the downstream by the http stream.long
For HTTP: Total number of bytes sent to the downstream by the http stream.com.google.protobuf.Duration
For HTTP: Total duration in milliseconds of the request from the start time to the last byte out.com.google.protobuf.DurationOrBuilder
For HTTP: Total duration in milliseconds of the request from the start time to the last byte out.Deprecated.int
Map 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.Any
getFilterStateObjectsOrDefault
(String key, com.google.protobuf.Any defaultValue) Map of filter state in stream info that have been configured to be logged.com.google.protobuf.Any
Map of filter state in stream info that have been configured to be logged.boolean
Deprecated.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.ByteString
The name of the routedouble
[#not-implemented-hide:] This field indicates the rate at which this log entry was sampled.int
com.google.protobuf.Timestamp
The time that Envoy started servicing this request.com.google.protobuf.TimestampOrBuilder
The 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.ByteString
Optional unique id of stream (TCP connection, long-live HTTP2 stream, HTTP request) for logging and tracing.com.google.protobuf.Duration
Interval between the first downstream byte received and the first downstream byte sent.com.google.protobuf.DurationOrBuilder
Interval between the first downstream byte received and the first downstream byte sent.com.google.protobuf.Duration
Interval between the first downstream byte received and the first upstream byte received (i.e.com.google.protobuf.DurationOrBuilder
Interval between the first downstream byte received and the first upstream byte received (i.e.com.google.protobuf.Duration
Interval between the first downstream byte received and the first upstream byte sent.com.google.protobuf.DurationOrBuilder
Interval between the first downstream byte received and the first upstream byte sent.com.google.protobuf.Duration
Interval between the first downstream byte received and the last downstream byte sent.com.google.protobuf.DurationOrBuilder
Interval between the first downstream byte received and the last downstream byte sent.com.google.protobuf.Duration
Interval between the first downstream byte received and the last downstream byte received (i.e.com.google.protobuf.DurationOrBuilder
Interval between the first downstream byte received and the last downstream byte received (i.e.com.google.protobuf.Duration
Interval between the first downstream byte received and the last upstream byte received (i.e.com.google.protobuf.DurationOrBuilder
Interval between the first downstream byte received and the last upstream byte received (i.e.com.google.protobuf.Duration
Interval between the first downstream byte received and the last upstream byte sent.com.google.protobuf.DurationOrBuilder
Interval 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.ByteString
The 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.int
For HTTP: Number of times the request is attempted upstream.If upstream connection failed due to transport socket (e.g.com.google.protobuf.ByteString
If upstream connection failed due to transport socket (e.g.long
For HTTP: Total number of bytes received from the upstream by the http stream.long
For HTTP: Total number of bytes sent to the upstream by the http stream.boolean
This field is the downstream direct remote address on which the request from the user was received.boolean
This field is the local/destination address on which the request from the user was received.boolean
This field is the remote/origin address on which the request from the user was received.boolean
For HTTP: Total duration in milliseconds of the request from the start time to the last byte out.int
hashCode()
boolean
All metadata encountered during request processing, including endpoint selection.boolean
Flags indicating occurrences during request/response processing.boolean
The time that Envoy started servicing this request.boolean
Interval between the first downstream byte received and the first downstream byte sent.boolean
Interval between the first downstream byte received and the first upstream byte received (i.e.boolean
Interval between the first downstream byte received and the first upstream byte sent.boolean
Interval between the first downstream byte received and the last downstream byte sent.boolean
Interval between the first downstream byte received and the last downstream byte received (i.e.boolean
Interval between the first downstream byte received and the last upstream byte received (i.e.boolean
Interval between the first downstream byte received and the last upstream byte sent.boolean
If the connection is secure,S this field will contain TLS properties.boolean
The upstream local/origin address that handles this exchange.boolean
The upstream remote/destination address that handles this exchange.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
private com.google.protobuf.MapField
<String, com.google.protobuf.Any> protected com.google.protobuf.MapFieldReflectionAccessor
internalGetMapFieldReflection
(int number) final boolean
static AccessLogCommon.Builder
static AccessLogCommon.Builder
newBuilder
(AccessLogCommon prototype) protected AccessLogCommon.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) static AccessLogCommon
parseDelimitedFrom
(InputStream input) static AccessLogCommon
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AccessLogCommon
parseFrom
(byte[] data) static AccessLogCommon
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AccessLogCommon
parseFrom
(com.google.protobuf.ByteString data) static AccessLogCommon
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AccessLogCommon
parseFrom
(com.google.protobuf.CodedInputStream input) static AccessLogCommon
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AccessLogCommon
parseFrom
(InputStream input) static AccessLogCommon
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AccessLogCommon
parseFrom
(ByteBuffer data) static AccessLogCommon
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<AccessLogCommon> parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
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.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, 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() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflection
in classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in 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:
getSampleRate
in 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:
hasDownstreamRemoteAddress
in 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:
getDownstreamRemoteAddress
in 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:
getDownstreamRemoteAddressOrBuilder
in 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:
hasDownstreamLocalAddress
in 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:
getDownstreamLocalAddress
in 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:
getDownstreamLocalAddressOrBuilder
in 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:
hasTlsProperties
in 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:
getTlsProperties
in 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:
getTlsPropertiesOrBuilder
in 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:
hasStartTime
in 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:
getStartTime
in 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:
getStartTimeOrBuilder
in 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:
hasTimeToLastRxByte
in 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:
getTimeToLastRxByte
in 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:
getTimeToLastRxByteOrBuilder
in 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:
hasTimeToFirstUpstreamTxByte
in 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:
getTimeToFirstUpstreamTxByte
in 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:
getTimeToFirstUpstreamTxByteOrBuilder
in 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:
hasTimeToLastUpstreamTxByte
in 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:
getTimeToLastUpstreamTxByte
in 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:
getTimeToLastUpstreamTxByteOrBuilder
in 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:
hasTimeToFirstUpstreamRxByte
in 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:
getTimeToFirstUpstreamRxByte
in 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:
getTimeToFirstUpstreamRxByteOrBuilder
in 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:
hasTimeToLastUpstreamRxByte
in 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:
getTimeToLastUpstreamRxByte
in 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:
getTimeToLastUpstreamRxByteOrBuilder
in 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:
hasTimeToFirstDownstreamTxByte
in 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:
getTimeToFirstDownstreamTxByte
in 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:
getTimeToFirstDownstreamTxByteOrBuilder
in 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:
hasTimeToLastDownstreamTxByte
in 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:
getTimeToLastDownstreamTxByte
in 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:
getTimeToLastDownstreamTxByteOrBuilder
in 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:
hasUpstreamRemoteAddress
in 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:
getUpstreamRemoteAddress
in 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:
getUpstreamRemoteAddressOrBuilder
in 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:
hasUpstreamLocalAddress
in 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:
getUpstreamLocalAddress
in 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:
getUpstreamLocalAddressOrBuilder
in interfaceAccessLogCommonOrBuilder
-
getUpstreamCluster
The upstream cluster that ``upstream_remote_address`` belongs to.
string upstream_cluster = 15;
- Specified by:
getUpstreamCluster
in 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:
getUpstreamClusterBytes
in 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:
hasResponseFlags
in 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:
getResponseFlags
in interfaceAccessLogCommonOrBuilder
- Returns:
- The responseFlags.
-
getResponseFlagsOrBuilder
Flags indicating occurrences during request/response processing.
.envoy.data.accesslog.v3.ResponseFlags response_flags = 16;
- Specified by:
getResponseFlagsOrBuilder
in 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:
hasMetadata
in 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:
getMetadata
in 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:
getMetadataOrBuilder
in 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:
getUpstreamTransportFailureReason
in 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:
getUpstreamTransportFailureReasonBytes
in interfaceAccessLogCommonOrBuilder
- Returns:
- The bytes for upstreamTransportFailureReason.
-
getRouteName
The name of the route
string route_name = 19;
- Specified by:
getRouteName
in interfaceAccessLogCommonOrBuilder
- Returns:
- The routeName.
-
getRouteNameBytes
public com.google.protobuf.ByteString getRouteNameBytes()The name of the route
string route_name = 19;
- Specified by:
getRouteNameBytes
in 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:
hasDownstreamDirectRemoteAddress
in 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:
getDownstreamDirectRemoteAddress
in 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:
getDownstreamDirectRemoteAddressOrBuilder
in interfaceAccessLogCommonOrBuilder
-
internalGetFilterStateObjects
private com.google.protobuf.MapField<String,com.google.protobuf.Any> internalGetFilterStateObjects() -
getFilterStateObjectsCount
public int getFilterStateObjectsCount()Description copied from interface:AccessLogCommonOrBuilder
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:
getFilterStateObjectsCount
in 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:
containsFilterStateObjects
in interfaceAccessLogCommonOrBuilder
-
getFilterStateObjects
Deprecated.UsegetFilterStateObjectsMap()
instead.- Specified by:
getFilterStateObjects
in 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:
getFilterStateObjectsMap
in 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:
getFilterStateObjectsOrDefault
in 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:
getFilterStateObjectsOrThrow
in interfaceAccessLogCommonOrBuilder
-
internalGetCustomTags
-
getCustomTagsCount
public int getCustomTagsCount()Description copied from interface:AccessLogCommonOrBuilder
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:
getCustomTagsCount
in 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:
containsCustomTags
in interfaceAccessLogCommonOrBuilder
-
getCustomTags
Deprecated.UsegetCustomTagsMap()
instead.- Specified by:
getCustomTags
in 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:
getCustomTagsMap
in 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:
getCustomTagsOrDefault
in 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:
getCustomTagsOrThrow
in 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:
hasDuration
in 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:
getDuration
in 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:
getDurationOrBuilder
in 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:
getUpstreamRequestAttemptCount
in 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:
getConnectionTerminationDetails
in 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:
getConnectionTerminationDetailsBytes
in 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:
getStreamId
in 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:
getStreamIdBytes
in 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:
getIntermediateLogEntry
in 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:
getDownstreamTransportFailureReason
in 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:
getDownstreamTransportFailureReasonBytes
in 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:
getDownstreamWireBytesSent
in 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:
getDownstreamWireBytesReceived
in 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:
getUpstreamWireBytesSent
in 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:
getUpstreamWireBytesReceived
in 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:
getAccessLogTypeValue
in 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:
getAccessLogType
in interfaceAccessLogCommonOrBuilder
- Returns:
- The accessLogType.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in 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:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected AccessLogCommon.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-