Package io.envoyproxy.envoy.data.accesslog.v3

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 Detail

      • 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

        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;

      • getFilterStateObjectsMap

        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;

      • 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

        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;

      • 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

        boolean containsCustomTags​(String key)
         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;

      • getCustomTagsMap

        Map<String,​String> 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

        String getCustomTagsOrDefault​(String key,
                              String defaultValue)
         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

        String getCustomTagsOrThrow​(String key)
         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;