Package com.linecorp.armeria.common.logback

Enum BuiltInProperty

    • Enum Constant Detail

      • REMOTE_HOST

        public static final BuiltInProperty REMOTE_HOST
        "remote.host" - the host name part of the remote socket address. Unavailable if the connection is not established yet.

      • REMOTE_IP

        public static final BuiltInProperty REMOTE_IP
        "remote.ip" - the IP address part of the remote socket address. Unavailable if the connection is not established yet.

      • REMOTE_PORT

        public static final BuiltInProperty REMOTE_PORT
        "remote.port" - the port number part of the remote socket address. Unavailable if the connection is not established yet.

      • LOCAL_HOST

        public static final BuiltInProperty LOCAL_HOST
        "local.host" - the host name part of the local socket address. Unavailable if the connection is not established yet.

      • LOCAL_IP

        public static final BuiltInProperty LOCAL_IP
        "local.ip" - the IP address part of the local socket address. Unavailable if the connection is not established yet.

      • LOCAL_PORT

        public static final BuiltInProperty LOCAL_PORT
        "local.port" - the port number part of the local socket address. Unavailable if the connection is not established yet.

      • CLIENT_IP

        public static final BuiltInProperty CLIENT_IP
        "client.ip" - the IP address who initiated a request. Unavailable if the connection is not established yet.

      • SCHEME

        public static final BuiltInProperty SCHEME
        "scheme" - the scheme of the request, represented by Scheme.uriText(). e.g. "tbinary+h2"

      • ELAPSED_NANOS

        public static final BuiltInProperty ELAPSED_NANOS
        "elapsed_nanos" - the amount of time in nanoseconds taken to handle the request. Unavailable if the request was not handled completely yet.

      • REQ_DIRECTION

        public static final BuiltInProperty REQ_DIRECTION
        "req.direction" - the direction of the request, which is "INBOUND" for servers and "OUTBOUND" for clients.

      • REQ_AUTHORITY

        public static final BuiltInProperty REQ_AUTHORITY
        "req.authority" - the authority of the request, represented as "<hostname>[:<port>]". The port number is omitted when it is same with the default port number of the current Scheme.

      • REQ_PATH

        public static final BuiltInProperty REQ_PATH
        "req.path" - the path of the request.

      • REQ_QUERY

        public static final BuiltInProperty REQ_QUERY
        "req.query" - the query of the request.

      • REQ_METHOD

        public static final BuiltInProperty REQ_METHOD
        "req.method" - the method name of the request. e.g. "GET" and "POST"

      • REQ_RPC_METHOD

        public static final BuiltInProperty REQ_RPC_METHOD
        "req.rpc_method" - the RPC method name of the request. Unavailable if the current request is not an RPC request or is not decoded yet.

      • REQ_RPC_PARAMS

        public static final BuiltInProperty REQ_RPC_PARAMS
        "req.rpc_params" - the RPC parameter list, represented by Arrays.toString(Object...). Unavailable if the current request is not an RPC request or is not decoded yet.

      • REQ_CONTENT_LENGTH

        public static final BuiltInProperty REQ_CONTENT_LENGTH
        "req.content_length" - the byte-length of the request content. Unavailable if the current request is not fully received yet.

      • RES_STATUS_CODE

        public static final BuiltInProperty RES_STATUS_CODE
        "res.status_code" - the protocol-specific integer representation of the response status code. Unavailable if the current response is not fully sent yet.

      • RES_RPC_RESULT

        public static final BuiltInProperty RES_RPC_RESULT
        "res.rpc_result" - the RPC result value of the response. Unavailable if the current response is not fully sent yet.

      • RES_CONTENT_LENGTH

        public static final BuiltInProperty RES_CONTENT_LENGTH
        "res.content_length" - the byte-length of the response content. Unavailable if the current response is not fully sent yet.

      • TLS_SESSION_ID

        public static final BuiltInProperty TLS_SESSION_ID
        "tls.session_id" - the hexadecimal representation of the current TLS session ID. Unavailable if TLS handshake is not finished or the connection is not a TLS connection.

      • TLS_CIPHER

        public static final BuiltInProperty TLS_CIPHER
        "tls.cipher" - the current TLS cipher suite. Unavailable if TLS handshake is not finished or the connection is not a TLS connection. e.g. "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384"

      • TLS_PROTO

        public static final BuiltInProperty TLS_PROTO
        "tls.proto" - the current SSLSession.getProtocol() TLS protocol}. Unavailable if TLS handshake is not finished or the connection is not a TLS connection. e.g. "TLSv1.2"

    • Method Detail

      • values

        public static BuiltInProperty[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (BuiltInProperty c : BuiltInProperty.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static BuiltInProperty valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null