Interface AccessLogCommonOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
AccessLogCommon
,AccessLogCommon.Builder
public interface AccessLogCommonOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
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.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.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.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.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.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.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getSampleRate
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) = { ... }
- Returns:
- The sampleRate.
-
hasDownstreamRemoteAddress
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;
- Returns:
- Whether the downstreamRemoteAddress field is set.
-
getDownstreamRemoteAddress
Address 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;
- Returns:
- The downstreamRemoteAddress.
-
getDownstreamRemoteAddressOrBuilder
AddressOrBuilder 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;
-
hasDownstreamLocalAddress
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;
- Returns:
- Whether the downstreamLocalAddress field is set.
-
getDownstreamLocalAddress
Address 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;
- Returns:
- The downstreamLocalAddress.
-
getDownstreamLocalAddressOrBuilder
AddressOrBuilder 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;
-
hasTlsProperties
boolean hasTlsProperties()If the connection is secure,S this field will contain TLS properties.
.envoy.data.accesslog.v3.TLSProperties tls_properties = 4;
- Returns:
- Whether the tlsProperties field is set.
-
getTlsProperties
TLSProperties getTlsProperties()If the connection is secure,S this field will contain TLS properties.
.envoy.data.accesslog.v3.TLSProperties tls_properties = 4;
- Returns:
- The tlsProperties.
-
getTlsPropertiesOrBuilder
TLSPropertiesOrBuilder getTlsPropertiesOrBuilder()If the connection is secure,S this field will contain TLS properties.
.envoy.data.accesslog.v3.TLSProperties tls_properties = 4;
-
hasStartTime
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;
- Returns:
- Whether the startTime field is set.
-
getStartTime
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;
- Returns:
- The startTime.
-
getStartTimeOrBuilder
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;
-
hasTimeToLastRxByte
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;
- Returns:
- Whether the timeToLastRxByte field is set.
-
getTimeToLastRxByte
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;
- Returns:
- The timeToLastRxByte.
-
getTimeToLastRxByteOrBuilder
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;
-
hasTimeToFirstUpstreamTxByte
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;
- Returns:
- Whether the timeToFirstUpstreamTxByte field is set.
-
getTimeToFirstUpstreamTxByte
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;
- Returns:
- The timeToFirstUpstreamTxByte.
-
getTimeToFirstUpstreamTxByteOrBuilder
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;
-
hasTimeToLastUpstreamTxByte
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;
- Returns:
- Whether the timeToLastUpstreamTxByte field is set.
-
getTimeToLastUpstreamTxByte
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;
- Returns:
- The timeToLastUpstreamTxByte.
-
getTimeToLastUpstreamTxByteOrBuilder
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;
-
hasTimeToFirstUpstreamRxByte
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;
- Returns:
- Whether the timeToFirstUpstreamRxByte field is set.
-
getTimeToFirstUpstreamRxByte
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;
- Returns:
- The timeToFirstUpstreamRxByte.
-
getTimeToFirstUpstreamRxByteOrBuilder
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;
-
hasTimeToLastUpstreamRxByte
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;
- Returns:
- Whether the timeToLastUpstreamRxByte field is set.
-
getTimeToLastUpstreamRxByte
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;
- Returns:
- The timeToLastUpstreamRxByte.
-
getTimeToLastUpstreamRxByteOrBuilder
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;
-
hasTimeToFirstDownstreamTxByte
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;
- Returns:
- Whether the timeToFirstDownstreamTxByte field is set.
-
getTimeToFirstDownstreamTxByte
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;
- Returns:
- The timeToFirstDownstreamTxByte.
-
getTimeToFirstDownstreamTxByteOrBuilder
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;
-
hasTimeToLastDownstreamTxByte
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;
- Returns:
- Whether the timeToLastDownstreamTxByte field is set.
-
getTimeToLastDownstreamTxByte
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;
- Returns:
- The timeToLastDownstreamTxByte.
-
getTimeToLastDownstreamTxByteOrBuilder
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;
-
hasUpstreamRemoteAddress
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;
- Returns:
- Whether the upstreamRemoteAddress field is set.
-
getUpstreamRemoteAddress
Address getUpstreamRemoteAddress()The upstream remote/destination address that handles this exchange. This does not include retries.
.envoy.config.core.v3.Address upstream_remote_address = 13;
- Returns:
- The upstreamRemoteAddress.
-
getUpstreamRemoteAddressOrBuilder
AddressOrBuilder getUpstreamRemoteAddressOrBuilder()The upstream remote/destination address that handles this exchange. This does not include retries.
.envoy.config.core.v3.Address upstream_remote_address = 13;
-
hasUpstreamLocalAddress
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;
- Returns:
- Whether the upstreamLocalAddress field is set.
-
getUpstreamLocalAddress
Address getUpstreamLocalAddress()The upstream local/origin address that handles this exchange. This does not include retries.
.envoy.config.core.v3.Address upstream_local_address = 14;
- Returns:
- The upstreamLocalAddress.
-
getUpstreamLocalAddressOrBuilder
AddressOrBuilder getUpstreamLocalAddressOrBuilder()The upstream local/origin address that handles this exchange. This does not include retries.
.envoy.config.core.v3.Address upstream_local_address = 14;
-
getUpstreamCluster
String getUpstreamCluster()The upstream cluster that ``upstream_remote_address`` belongs to.
string upstream_cluster = 15;
- Returns:
- The upstreamCluster.
-
getUpstreamClusterBytes
com.google.protobuf.ByteString getUpstreamClusterBytes()The upstream cluster that ``upstream_remote_address`` belongs to.
string upstream_cluster = 15;
- Returns:
- The bytes for upstreamCluster.
-
hasResponseFlags
boolean hasResponseFlags()Flags indicating occurrences during request/response processing.
.envoy.data.accesslog.v3.ResponseFlags response_flags = 16;
- Returns:
- Whether the responseFlags field is set.
-
getResponseFlags
ResponseFlags getResponseFlags()Flags indicating occurrences during request/response processing.
.envoy.data.accesslog.v3.ResponseFlags response_flags = 16;
- Returns:
- The responseFlags.
-
getResponseFlagsOrBuilder
ResponseFlagsOrBuilder getResponseFlagsOrBuilder()Flags indicating occurrences during request/response processing.
.envoy.data.accesslog.v3.ResponseFlags response_flags = 16;
-
hasMetadata
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;
- Returns:
- Whether the metadata field is set.
-
getMetadata
Metadata 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;
- Returns:
- The metadata.
-
getMetadataOrBuilder
MetadataOrBuilder 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;
-
getUpstreamTransportFailureReason
String 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;
- Returns:
- The upstreamTransportFailureReason.
-
getUpstreamTransportFailureReasonBytes
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;
- Returns:
- The bytes for upstreamTransportFailureReason.
-
getRouteName
String getRouteName()The name of the route
string route_name = 19;
- Returns:
- The routeName.
-
getRouteNameBytes
com.google.protobuf.ByteString getRouteNameBytes()The name of the route
string route_name = 19;
- Returns:
- The bytes for routeName.
-
hasDownstreamDirectRemoteAddress
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;
- Returns:
- Whether the downstreamDirectRemoteAddress field is set.
-
getDownstreamDirectRemoteAddress
Address 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;
- Returns:
- The downstreamDirectRemoteAddress.
-
getDownstreamDirectRemoteAddressOrBuilder
AddressOrBuilder 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;
-
getFilterStateObjectsCount
int getFilterStateObjectsCount()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;
-
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;
-
getFilterStateObjects
Deprecated.UsegetFilterStateObjectsMap()
instead. -
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;
-
getFilterStateObjectsOrDefault
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;
-
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;
-
getCustomTagsCount
int getCustomTagsCount()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;
-
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;
-
getCustomTags
Deprecated.UsegetCustomTagsMap()
instead. -
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;
-
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;
-
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;
-
hasDuration
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;
- Returns:
- Whether the duration field is set.
-
getDuration
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;
- Returns:
- The duration.
-
getDurationOrBuilder
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;
-
getUpstreamRequestAttemptCount
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;
- Returns:
- The upstreamRequestAttemptCount.
-
getConnectionTerminationDetails
String getConnectionTerminationDetails()Connection termination details may provide additional information about why the connection was terminated by Envoy for L4 reasons.
string connection_termination_details = 25;
- Returns:
- The connectionTerminationDetails.
-
getConnectionTerminationDetailsBytes
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;
- Returns:
- The bytes for connectionTerminationDetails.
-
getStreamId
String 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;
- Returns:
- The streamId.
-
getStreamIdBytes
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;
- 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"];
- Returns:
- The intermediateLogEntry.
-
getDownstreamTransportFailureReason
String 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;
- Returns:
- The downstreamTransportFailureReason.
-
getDownstreamTransportFailureReasonBytes
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;
- Returns:
- The bytes for downstreamTransportFailureReason.
-
getDownstreamWireBytesSent
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;
- Returns:
- The downstreamWireBytesSent.
-
getDownstreamWireBytesReceived
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;
- Returns:
- The downstreamWireBytesReceived.
-
getUpstreamWireBytesSent
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;
- Returns:
- The upstreamWireBytesSent.
-
getUpstreamWireBytesReceived
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;
- Returns:
- The upstreamWireBytesReceived.
-
getAccessLogTypeValue
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;
- Returns:
- The enum numeric value on the wire for accessLogType.
-
getAccessLogType
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;
- Returns:
- The accessLogType.
-