Log format

You are browsing documentation for an outdated plugin version.

Looking for the plugin's configuration parameters? You can find them in the HTTP Log configuration reference doc.

Note: If the max_batch_size argument > 1, a request is logged as an array of JSON objects.

Every request is logged separately in a JSON object, separated by a new line \n, with the following format:

{
    "response": {
        "size": 9982,
        "headers": {
            "access-control-allow-origin": "*",
            "content-length": "9593",
            "date": "Thu, 19 Sep 2024 22:10:39 GMT",
            "content-type": "text/html; charset=utf-8",
            "via": "1.1 kong/3.8.0.0-enterprise-edition",
            "connection": "close",
            "server": "gunicorn/19.9.0",
            "access-control-allow-credentials": "true",
            "x-kong-upstream-latency": "171",
            "x-kong-proxy-latency": "1",
            "x-kong-request-id": "2f6946328ffc4946b8c9120704a4a155"
        },
        "status": 200
    },
    "route": {
        "updated_at": 1726782477,
        "tags": [],
        "response_buffering": true,
        "path_handling": "v0",
        "protocols": [
            "http",
            "https"
        ],
        "service": {
            "id": "fb4eecf8-dec2-40ef-b779-16de7e2384c7"
        },
        "https_redirect_status_code": 426,
        "regex_priority": 0,
        "name": "example_route",
        "id": "0f1a4101-3327-4274-b1e4-484a4ab0c030",
        "strip_path": true,
        "preserve_host": false,
        "created_at": 1726782477,
        "request_buffering": true,
        "ws_id": "f381e34e-5c25-4e65-b91b-3c0a86cfc393",
        "paths": [
            "/example-route"
        ]
    },
    "workspace": "f381e34e-5c25-4e65-b91b-3c0a86cfc393",
    "workspace_name": "default",
    "tries": [
        {
            "balancer_start": 1726783839539,
            "balancer_start_ns": 1.7267838395395e+18,
            "ip": "34.237.204.224",
            "balancer_latency": 0,
            "port": 80,
            "balancer_latency_ns": 27904
        }
    ],
    "client_ip": "192.168.65.1",
    "request": {
        "id": "2f6946328ffc4946b8c9120704a4a155",
        "headers": {
            "accept": "*/*",
            "user-agent": "HTTPie/3.2.3",
            "host": "localhost:8000",
            "connection": "keep-alive",
            "accept-encoding": "gzip, deflate"
        },
        "uri": "/example-route",
        "size": 139,
        "method": "GET",
        "querystring": {},
        "url": "http://localhost:8000/example-route"
    },
    "upstream_uri": "/",
    "started_at": 1726783839538,
    "source": "upstream",
    "upstream_status": "200",
    "latencies": {
        "kong": 1,
        "proxy": 171,
        "request": 173,
        "receive": 1
    },
    "service": {
        "write_timeout": 60000,
        "read_timeout": 60000,
        "updated_at": 1726782459,
        "host": "httpbin.konghq.com",
        "name": "example_service",
        "id": "fb4eecf8-dec2-40ef-b779-16de7e2384c7",
        "port": 80,
        "enabled": true,
        "created_at": 1726782459,
        "protocol": "http",
        "ws_id": "f381e34e-5c25-4e65-b91b-3c0a86cfc393",
        "connect_timeout": 60000,
        "retries": 5
    }
}

JSON object descriptions

service: Properties about the service associated with the requested route.
route: Properties about the specific route requested.
request: Properties about the request sent by the client.
response: Properties about the response sent to the client.
latencies: Latency data.
- kong: The internal Kong Gateway latency, in milliseconds, that it takes to process the request.
  - For requests that are proxied to an upstream, it is equivalent to the X-Kong-Proxy-Latency response header.
  - For requests that generate a response within Kong Gateway (typically the result of an error or a plugin-generated response), it is equivalent to the X-Kong-Response-Latency response header.
- request: The time in milliseconds that has elapsed between when the first bytes were read from the client and the last byte was sent to the client. This is useful for detecting slow clients.
- proxy: The time in milliseconds that it took for the upstream to process the request. In other words, it’s the time elapsed between transferring the request to the final service and when Kong Gateway starts receiving the response.
- receive: The time in milliseconds that it took to receive and process the response (headers and body) from the upstream.
tries: a list of iterations made by the load balancer for this request.
- balancer_start: A Unix timestamp for when the balancer started.
- ip: The IP address of the contacted balancer.
- port: The port number of the contacted balancer.
- balancer_latency: The latency of the balancer expressed in milliseconds.
client_ip: The original client IP address.
workspace: The UUID of the workspace associated with this request.
workspace_name: The name of the workspace associated with this request.
upstream_uri: The URI, including query parameters, for the configured upstream.
authenticated_entity: Properties about the authenticated credential (if an authentication plugin has been enabled).
consumer: The authenticated consumer (if an authentication plugin has been enabled).
started_at: The unix timestamp of when the request has started to be processed.
source: Indicates whether the response is generated by kong or upstream.
upstream_status: The status code received from the upstream in the response.

Log plugins enabled on services and routes contain information about the service or route.

Previous HTTP Log

Next Custom fields and headers