public interface AccessLogCommonOrBuilder
extends com.google.protobuf.MessageOrBuilder
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsFilterStateObjects(String key)
Map of filter state in stream info that have been configured to be logged.
|
Address |
getDownstreamDirectRemoteAddress()
This field is the downstream direct remote address on which the request from the user was
received.
|
AddressOrBuilder |
getDownstreamDirectRemoteAddressOrBuilder()
This field is the downstream direct remote address on which the request from the user was
received.
|
Address |
getDownstreamLocalAddress()
This field is the local/destination address on which the request from the user was received.
|
AddressOrBuilder |
getDownstreamLocalAddressOrBuilder()
This field is the local/destination address on which the request from the user was received.
|
Address |
getDownstreamRemoteAddress()
This field is the remote/origin address on which the request from the user was received.
|
AddressOrBuilder |
getDownstreamRemoteAddressOrBuilder()
This field is the remote/origin address on which the request from the user was received.
|
Map<String,com.google.protobuf.Any> |
getFilterStateObjects()
Deprecated.
|
int |
getFilterStateObjectsCount()
Map of filter state in stream info that have been configured to be logged.
|
Map<String,com.google.protobuf.Any> |
getFilterStateObjectsMap()
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 |
getFilterStateObjectsOrThrow(String key)
Map of filter state in stream info that have been configured to be logged.
|
Metadata |
getMetadata()
All metadata encountered during request processing, including endpoint
selection.
|
MetadataOrBuilder |
getMetadataOrBuilder()
All metadata encountered during request processing, including endpoint
selection.
|
ResponseFlags |
getResponseFlags()
Flags indicating occurrences during request/response processing.
|
ResponseFlagsOrBuilder |
getResponseFlagsOrBuilder()
Flags indicating occurrences during request/response processing.
|
String |
getRouteName()
The name of the route
string route_name = 19; |
com.google.protobuf.ByteString |
getRouteNameBytes()
The name of the route
string route_name = 19; |
double |
getSampleRate()
[#not-implemented-hide:]
This field indicates the rate at which this log entry was sampled.
|
com.google.protobuf.Timestamp |
getStartTime()
The time that Envoy started servicing this request.
|
com.google.protobuf.TimestampOrBuilder |
getStartTimeOrBuilder()
The time that Envoy started servicing this request.
|
com.google.protobuf.Duration |
getTimeToFirstDownstreamTxByte()
Interval between the first downstream byte received and the first downstream byte sent.
|
com.google.protobuf.DurationOrBuilder |
getTimeToFirstDownstreamTxByteOrBuilder()
Interval between the first downstream byte received and the first downstream byte sent.
|
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).
|
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).
|
com.google.protobuf.Duration |
getTimeToFirstUpstreamTxByte()
Interval between the first downstream byte received and the first upstream byte sent.
|
com.google.protobuf.DurationOrBuilder |
getTimeToFirstUpstreamTxByteOrBuilder()
Interval between the first downstream byte received and the first upstream byte sent.
|
com.google.protobuf.Duration |
getTimeToLastDownstreamTxByte()
Interval between the first downstream byte received and the last downstream byte sent.
|
com.google.protobuf.DurationOrBuilder |
getTimeToLastDownstreamTxByteOrBuilder()
Interval between the first downstream byte received and the last downstream byte sent.
|
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).
|
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).
|
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).
|
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).
|
com.google.protobuf.Duration |
getTimeToLastUpstreamTxByte()
Interval between the first downstream byte received and the last upstream byte sent.
|
com.google.protobuf.DurationOrBuilder |
getTimeToLastUpstreamTxByteOrBuilder()
Interval between the first downstream byte received and the last upstream byte sent.
|
TLSProperties |
getTlsProperties()
If the connection is secure,S this field will contain TLS properties.
|
TLSPropertiesOrBuilder |
getTlsPropertiesOrBuilder()
If the connection is secure,S this field will contain TLS properties.
|
String |
getUpstreamCluster()
The upstream cluster that *upstream_remote_address* belongs to.
|
com.google.protobuf.ByteString |
getUpstreamClusterBytes()
The upstream cluster that *upstream_remote_address* belongs to.
|
Address |
getUpstreamLocalAddress()
The upstream local/origin address that handles this exchange.
|
AddressOrBuilder |
getUpstreamLocalAddressOrBuilder()
The upstream local/origin address that handles this exchange.
|
Address |
getUpstreamRemoteAddress()
The upstream remote/destination address that handles this exchange.
|
AddressOrBuilder |
getUpstreamRemoteAddressOrBuilder()
The upstream remote/destination address that handles this exchange.
|
String |
getUpstreamTransportFailureReason()
If upstream connection failed due to transport socket (e.g.
|
com.google.protobuf.ByteString |
getUpstreamTransportFailureReasonBytes()
If upstream connection failed due to transport socket (e.g.
|
boolean |
hasDownstreamDirectRemoteAddress()
This field is the downstream direct remote address on which the request from the user was
received.
|
boolean |
hasDownstreamLocalAddress()
This field is the local/destination address on which the request from the user was received.
|
boolean |
hasDownstreamRemoteAddress()
This field is the remote/origin address on which the request from the user was received.
|
boolean |
hasMetadata()
All metadata encountered during request processing, including endpoint
selection.
|
boolean |
hasResponseFlags()
Flags indicating occurrences during request/response processing.
|
boolean |
hasStartTime()
The time that Envoy started servicing this request.
|
boolean |
hasTimeToFirstDownstreamTxByte()
Interval between the first downstream byte received and the first downstream byte sent.
|
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).
|
boolean |
hasTimeToFirstUpstreamTxByte()
Interval between the first downstream byte received and the first upstream byte sent.
|
boolean |
hasTimeToLastDownstreamTxByte()
Interval between the first downstream byte received and the last downstream byte sent.
|
boolean |
hasTimeToLastRxByte()
Interval between the first downstream byte received and the last
downstream byte received (i.e. time it takes to receive a request).
|
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).
|
boolean |
hasTimeToLastUpstreamTxByte()
Interval between the first downstream byte received and the last upstream byte sent.
|
boolean |
hasTlsProperties()
If the connection is secure,S this field will contain TLS properties.
|
boolean |
hasUpstreamLocalAddress()
The upstream local/origin address that handles this exchange.
|
boolean |
hasUpstreamRemoteAddress()
The upstream remote/destination address that handles this exchange.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofdouble 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) = { ... }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.api.v2.core.Address downstream_remote_address = 2;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.api.v2.core.Address downstream_remote_address = 2;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.api.v2.core.Address downstream_remote_address = 2;boolean hasDownstreamLocalAddress()
This field is the local/destination address on which the request from the user was received.
.envoy.api.v2.core.Address downstream_local_address = 3;Address getDownstreamLocalAddress()
This field is the local/destination address on which the request from the user was received.
.envoy.api.v2.core.Address downstream_local_address = 3;AddressOrBuilder getDownstreamLocalAddressOrBuilder()
This field is the local/destination address on which the request from the user was received.
.envoy.api.v2.core.Address downstream_local_address = 3;boolean hasTlsProperties()
If the connection is secure,S this field will contain TLS properties.
.envoy.data.accesslog.v2.TLSProperties tls_properties = 4;TLSProperties getTlsProperties()
If the connection is secure,S this field will contain TLS properties.
.envoy.data.accesslog.v2.TLSProperties tls_properties = 4;TLSPropertiesOrBuilder getTlsPropertiesOrBuilder()
If the connection is secure,S this field will contain TLS properties.
.envoy.data.accesslog.v2.TLSProperties tls_properties = 4;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;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;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;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;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;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;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;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;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;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;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;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;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;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;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;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;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;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;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;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;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;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;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;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;boolean hasUpstreamRemoteAddress()
The upstream remote/destination address that handles this exchange. This does not include retries.
.envoy.api.v2.core.Address upstream_remote_address = 13;Address getUpstreamRemoteAddress()
The upstream remote/destination address that handles this exchange. This does not include retries.
.envoy.api.v2.core.Address upstream_remote_address = 13;AddressOrBuilder getUpstreamRemoteAddressOrBuilder()
The upstream remote/destination address that handles this exchange. This does not include retries.
.envoy.api.v2.core.Address upstream_remote_address = 13;boolean hasUpstreamLocalAddress()
The upstream local/origin address that handles this exchange. This does not include retries.
.envoy.api.v2.core.Address upstream_local_address = 14;Address getUpstreamLocalAddress()
The upstream local/origin address that handles this exchange. This does not include retries.
.envoy.api.v2.core.Address upstream_local_address = 14;AddressOrBuilder getUpstreamLocalAddressOrBuilder()
The upstream local/origin address that handles this exchange. This does not include retries.
.envoy.api.v2.core.Address upstream_local_address = 14;String getUpstreamCluster()
The upstream cluster that *upstream_remote_address* belongs to.
string upstream_cluster = 15;com.google.protobuf.ByteString getUpstreamClusterBytes()
The upstream cluster that *upstream_remote_address* belongs to.
string upstream_cluster = 15;boolean hasResponseFlags()
Flags indicating occurrences during request/response processing.
.envoy.data.accesslog.v2.ResponseFlags response_flags = 16;ResponseFlags getResponseFlags()
Flags indicating occurrences during request/response processing.
.envoy.data.accesslog.v2.ResponseFlags response_flags = 16;ResponseFlagsOrBuilder getResponseFlagsOrBuilder()
Flags indicating occurrences during request/response processing.
.envoy.data.accesslog.v2.ResponseFlags response_flags = 16;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.api.v2.core.Metadata metadata = 17;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.api.v2.core.Metadata metadata = 17;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.api.v2.core.Metadata metadata = 17;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;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;String getRouteName()
The name of the route
string route_name = 19;com.google.protobuf.ByteString getRouteNameBytes()
The name of the route
string route_name = 19;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.api.v2.core.Address downstream_direct_remote_address = 20;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.api.v2.core.Address downstream_direct_remote_address = 20;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.api.v2.core.Address downstream_direct_remote_address = 20;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;boolean containsFilterStateObjects(String key)
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;@Deprecated Map<String,com.google.protobuf.Any> getFilterStateObjects()
getFilterStateObjectsMap() instead.Map<String,com.google.protobuf.Any> 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;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;com.google.protobuf.Any getFilterStateObjectsOrThrow(String key)
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;Copyright © 2018–2021 The Envoy Project. All rights reserved.