Class: Google::Cloud::Logging::Type::HttpRequest
- Inherits:
-
Object
- Object
- Google::Cloud::Logging::Type::HttpRequest
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/logging/type/http_request.rb
Overview
A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message.
Instance Attribute Summary collapse
-
#cache_fill_bytes ⇒ ::Integer
The number of HTTP response bytes inserted into cache.
-
#cache_hit ⇒ ::Boolean
Whether or not an entity was served from cache (with or without validation).
-
#cache_lookup ⇒ ::Boolean
Whether or not a cache lookup was attempted.
-
#cache_validated_with_origin_server ⇒ ::Boolean
Whether or not the response was validated with the origin server before being served from cache.
-
#latency ⇒ ::Google::Protobuf::Duration
The request processing latency on the server, from the time the request was received until the response was sent.
-
#protocol ⇒ ::String
Protocol used for the request.
-
#referer ⇒ ::String
The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions.
-
#remote_ip ⇒ ::String
The IP address (IPv4 or IPv6) of the client that issued the HTTP request.
-
#request_method ⇒ ::String
The request method.
-
#request_size ⇒ ::Integer
The size of the HTTP request message in bytes, including the request headers and the request body.
-
#request_url ⇒ ::String
The scheme (http, https), the host name, the path and the query portion of the URL that was requested.
-
#response_size ⇒ ::Integer
The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.
-
#server_ip ⇒ ::String
The IP address (IPv4 or IPv6) of the origin server that the request was sent to.
-
#status ⇒ ::Integer
The response code indicating the status of response.
-
#user_agent ⇒ ::String
The user agent sent by the client.
Instance Attribute Details
#cache_fill_bytes ⇒ ::Integer
Returns The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.
90 91 92 93 |
# File 'proto_docs/google/logging/type/http_request.rb', line 90 class HttpRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#cache_hit ⇒ ::Boolean
Returns Whether or not an entity was served from cache (with or without validation).
90 91 92 93 |
# File 'proto_docs/google/logging/type/http_request.rb', line 90 class HttpRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#cache_lookup ⇒ ::Boolean
Returns Whether or not a cache lookup was attempted.
90 91 92 93 |
# File 'proto_docs/google/logging/type/http_request.rb', line 90 class HttpRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#cache_validated_with_origin_server ⇒ ::Boolean
Returns Whether or not the response was validated with the origin server before
being served from cache. This field is only meaningful if cache_hit
is
True.
90 91 92 93 |
# File 'proto_docs/google/logging/type/http_request.rb', line 90 class HttpRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#latency ⇒ ::Google::Protobuf::Duration
Returns The request processing latency on the server, from the time the request was received until the response was sent.
90 91 92 93 |
# File 'proto_docs/google/logging/type/http_request.rb', line 90 class HttpRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#protocol ⇒ ::String
Returns Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket".
90 91 92 93 |
# File 'proto_docs/google/logging/type/http_request.rb', line 90 class HttpRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#referer ⇒ ::String
Returns The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions.
90 91 92 93 |
# File 'proto_docs/google/logging/type/http_request.rb', line 90 class HttpRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#remote_ip ⇒ ::String
Returns The IP address (IPv4 or IPv6) of the client that issued the HTTP
request. This field can include port information. Examples:
"192.168.1.1"
, "10.0.0.1:80"
, "FE80::0202:B3FF:FE1E:8329"
.
90 91 92 93 |
# File 'proto_docs/google/logging/type/http_request.rb', line 90 class HttpRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#request_method ⇒ ::String
Returns The request method. Examples: "GET"
, "HEAD"
, "PUT"
, "POST"
.
90 91 92 93 |
# File 'proto_docs/google/logging/type/http_request.rb', line 90 class HttpRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#request_size ⇒ ::Integer
Returns The size of the HTTP request message in bytes, including the request headers and the request body.
90 91 92 93 |
# File 'proto_docs/google/logging/type/http_request.rb', line 90 class HttpRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#request_url ⇒ ::String
Returns The scheme (http, https), the host name, the path and the query
portion of the URL that was requested.
Example: "http://example.com/some/info?color=red"
.
90 91 92 93 |
# File 'proto_docs/google/logging/type/http_request.rb', line 90 class HttpRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#response_size ⇒ ::Integer
Returns The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.
90 91 92 93 |
# File 'proto_docs/google/logging/type/http_request.rb', line 90 class HttpRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#server_ip ⇒ ::String
Returns The IP address (IPv4 or IPv6) of the origin server that the request was
sent to. This field can include port information. Examples:
"192.168.1.1"
, "10.0.0.1:80"
, "FE80::0202:B3FF:FE1E:8329"
.
90 91 92 93 |
# File 'proto_docs/google/logging/type/http_request.rb', line 90 class HttpRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#status ⇒ ::Integer
Returns The response code indicating the status of response. Examples: 200, 404.
90 91 92 93 |
# File 'proto_docs/google/logging/type/http_request.rb', line 90 class HttpRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#user_agent ⇒ ::String
Returns The user agent sent by the client. Example:
"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET
CLR 1.0.3705)"
.
90 91 92 93 |
# File 'proto_docs/google/logging/type/http_request.rb', line 90 class HttpRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |