Skip to content
agentgateway has joined the Agentic AI FoundationLearn more

For the complete documentation index, see llms.txt. Markdown versions of all docs pages are available by appending .md to any docs URL.

View and customize access logs

Page as Markdown

Configure per-request structured access logs with CEL-based filtering and field enrichment.

About access logging

Access logs, sometimes referred to as audit logs, represent all traffic requests that pass through the gateway proxy. The access log entries can be customized to include data from the request, the routing destination, and the response.

Data that can be logged

Access log content is controlled by CEL (Common Expression Language) expressions. You can filter which requests are logged and define custom attributes from the request and response.

For logging, CEL exposes these variable groups when enabled or applicable:

  • request: method, URI, host, path, headers, body, and timing
  • response: status code, headers, and body
  • source: client address, port, and TLS identity
  • backend: backend name, type, and protocol
  • Auth and metadata: jwt, apiKey, or basicAuth, plus extauthz and extproc metadata
  • LLM: model, provider, token counts, and optional prompt/completion
  • MCP: tool, prompt, and resource name and target
  • Guardrails: guardrails, with one entry per prompt-guard intervention naming the phase, the guard, and the action

Use the filter field in the AgentgatewayPolicy to filter which requests are logged by path, response code, or any other request attribute. Use the attributes list to add or remove log fields by using CEL expressions. For the full variable table, available functions, and examples, see the CEL expressions reference.

Before you begin

  1. Set up an agentgateway proxy.
  2. Install the httpbin sample app.
  1. Set up the OTel stack to export logs to an OTel collector and forward them to Loki.

Enable access logs

Access logs are written to stdout automatically for every request that passes through the gateway proxy. No policy configuration is required to enable them.

  1. Send a request to the httpbin app on the www.example.com domain.

    curl -i http://$INGRESS_GW_ADDRESS:80/get -H "host: www.example.com"
  2. Check the gateway logs to see the access log entry for the request.

    kubectl -n agentgateway-system logs deployments/agentgateway-proxy | tail -1

    Example output:

    info	request gateway=agentgateway-system/agentgateway-proxy
    listener=http route=httpbin/httpbin endpoint=10.244.0.4:8080
    src.addr=127.0.0.1:46886 http.method=GET http.host=www.example.com
    http.path=/get http.version=HTTP/1.1 http.status=200
    protocol=http duration=0ms
    

To filter which requests are logged or customize log fields, see Filter access logs and Add and remove log fields. To export access logs to an external backend over OTLP, see Export logs over OTLP.

Use OpenTelemetry field names

By default, the stdout access log uses short, human-oriented field names, such as http.path. To rename the built-in HTTP fields to their OpenTelemetry semantic convention equivalents, such as url.path, set preset: Otel in the access log policy.

Use this preset when you ship stdout logs to a pipeline that already expects semantic convention attribute names, so that you do not have to rename the fields downstream.

  1. Create an AgentgatewayPolicy resource that sets the preset.

    kubectl apply -f- <<EOF
    apiVersion: agentgateway.dev/v1alpha1
    kind: AgentgatewayPolicy
    metadata:
      name: access-logs-otel
      namespace: agentgateway-system
    spec:
      targetRefs:
      - group: gateway.networking.k8s.io
        kind: Gateway
        name: agentgateway-proxy
      frontend:
        accessLog:
          preset: Otel
    EOF
  2. Send a request that includes a query string, such as /get?foo=bar, and check the gateway logs. The built-in HTTP fields now use semantic convention names.

    info	request gateway=agentgateway-system/agentgateway-proxy
    listener=http route=httpbin/httpbin endpoint=10.244.0.7:8080
    client.address=127.0.0.1 http.request.method=GET server.address=www.example.com
    url.path=/get network.protocol.version=1.1 http.response.status_code=200
    protocol=http duration=0ms url.scheme=http url.query=foo=bar
    

The preset renames the following built-in fields.

Default fieldField with preset: Otel
src.addrclient.address. The value is the client IP address without the port.
http.methodhttp.request.method
http.hostserver.address
http.pathurl.path. The value is the path only. Any query string moves to a separate url.query field instead of staying on the path.
http.versionnetwork.protocol.version. The value is the bare version, such as 1.1 instead of HTTP/1.1.
http.statushttp.response.status_code

The preset also adds url.scheme, and it adds server.port and url.query when the request supplies them. These added fields are appended to the end of the log line, after duration, rather than placed next to the other HTTP fields.

Fields that you add yourself with the attributes field are not renamed, so choose semantic convention names for them if you want the whole line to be consistent. Fields that are not part of the HTTP field set, such as gateway, route, and duration, keep their names.

Note

The preset changes only the stdout access log, and only for HTTP traffic. A TCP listener has no HTTP field set to rename, so the preset has no effect there. An OTLP export already uses semantic convention attribute names, so it is unaffected. For more information, see Export logs over OTLP.

Filter access logs

Use a CEL expression to log only a subset of requests. Requests that do not match the expression are not logged.

  1. Create an AgentgatewayPolicy resource with a filter expression. The following example produces access logs only for requests with a response code of 400 or greater.

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    
    kubectl apply -f- <<EOF
    apiVersion: agentgateway.dev/v1alpha1
    kind: AgentgatewayPolicy
    metadata:
      name: access-logs
      namespace: agentgateway-system
    spec:
      targetRefs:
      - group: gateway.networking.k8s.io
        kind: Gateway
        name: agentgateway-proxy
      frontend:
        accessLog:
          filter: 'response.code >= 400'
    EOF
  2. Send a request that returns a 400 response code.

    curl -i http://$INGRESS_GW_ADDRESS:80/status/400 -H "host: www.example.com"
  3. Check the gateway logs and verify that an access log entry was written for the 400 request.

    kubectl -n agentgateway-system logs deployments/agentgateway-proxy | tail -1

    Example output:

    info	request gateway=agentgateway-system/agentgateway-proxy
    listener=http route=httpbin/httpbin endpoint=10.244.0.4:8080
    src.addr=127.0.0.1:46886 http.method=GET http.host=www.example.com
    http.path=/status/400 http.version=HTTP/1.1 http.status=400
    protocol=http duration=0ms
    
  4. Send a successful request.

    curl -i http://$INGRESS_GW_ADDRESS:80/get -H "host: www.example.com"
  5. Check the logs again and verify that no new entry appears. Because the response code was 200, the filter expression response.code >= 400 does not match and no log is written.

    kubectl -n agentgateway-system logs deployments/agentgateway-proxy | tail -1

    Example output (the last entry is still the 400 request from step 2):

    info	request gateway=agentgateway-system/agentgateway-proxy
    listener=http route=httpbin/httpbin endpoint=10.244.0.4:8080
    src.addr=127.0.0.1:46886 http.method=GET http.host=www.example.com
    http.path=/status/400 http.version=HTTP/1.1 http.status=400
    protocol=http duration=0ms
    

Add and remove log fields

You can add custom fields to every access log line by using CEL expressions that are evaluated against the request and response context. You can also remove default fields that you do not need.

  1. Create an AgentgatewayPolicy resource that adds custom attributes and removes a default field. The following example adds 3 fields to every access log entry:

    • user_id: Extracts the value of the x-user-id request header.
    • env: Adds a static string of production.

    The example also removes the http.host default field.

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    
    kubectl apply -f- <<EOF
    apiVersion: agentgateway.dev/v1alpha1
    kind: AgentgatewayPolicy
    metadata:
      name: access-logs
      namespace: agentgateway-system
    spec:
      targetRefs:
      - group: gateway.networking.k8s.io
        kind: Gateway
        name: agentgateway-proxy
      frontend:
        accessLog:
          attributes:
            add:
            - name: user_id
              expression: 'request.headers["x-user-id"]'
            - name: env
              expression: '"production"'
            remove:
            - http.host
    EOF
  2. Send a request with an x-user-id header.

    curl -i http://$INGRESS_GW_ADDRESS:80/get -H "host: www.example.com" -H "x-user-id: user-123"
  3. Check the gateway logs and verify you can see the custom fields in your log entry, and that the http.host field is absent.

    kubectl -n agentgateway-system logs deployments/agentgateway-proxy | tail -1

    Example output:

    info	request gateway=agentgateway-system/agentgateway-proxy
    listener=http route=httpbin/httpbin endpoint=10.244.0.4:8080
    src.addr=127.0.0.1:46886 http.method=GET http.path=/get
    http.version=HTTP/1.1 http.status=200 protocol=http duration=0ms
    user_id="user-123" env="production"
    

Log guardrail interventions

A prompt guard that masks or rejects content records what it did in the request’s dynamic metadata, under the guardrails variable. Add that variable to an access log field to keep an audit trail of every intervention, including which guard acted and why.

The variable holds one entry per intervention, in either the request or the response phase, so a request that both a request guard and a response guard act on produces two entries.

FieldDescription
guardrails[].phaseThe phase that the guardrail intervened in, either request or response.
guardrails[].guardThe guard kind that intervened, such as regex, webhook, openAIModeration, bedrockGuardrails, googleModelArmor, or azureContentSafety.
guardrails[].actionThe action that the guardrail took, one of mask, reject, audit, or failOpen.
guardrails[].guardrailIdThe configured guardrail identifier.
guardrails[].guardrailVersionThe configured guardrail version.
guardrails[].actionReasonThe reason that the guardrail reported for its action.
guardrails[].assessmentsThe assessment detail that the guardrail provider reported, redacted to metadata only. Content-bearing fields, such as the matched text, are never included.

Note

Only CEL that runs after the request completes, such as an access log field or a metric field, receives the guardrails variable. An authorization or transformation expression that runs mid-request never sees it.

The following AgentgatewayPolicy adds the whole list as one log field, and filters the log down to the requests that a guardrail acted on. To record a single value instead, use an expression such as guardrails[0].action.

kubectl apply -f- <<EOF
apiVersion: agentgateway.dev/v1alpha1
kind: AgentgatewayPolicy
metadata:
  name: guardrail-access-logs
  namespace: agentgateway-system
spec:
  targetRefs:
  - group: gateway.networking.k8s.io
    kind: Gateway
    name: agentgateway-proxy
  frontend:
    accessLog:
      filter: guardrails.size() > 0
      attributes:
        add:
        - name: guardrails
          expression: guardrails
EOF

Access logging is a frontend policy, so it attaches to a Gateway rather than to the LLM backend that the prompt guard attaches to. To set up a guard that produces these entries, see the guardrails docs.

View access logs in Loki

If you set up the OTel stack, the opentelemetry-collector-logs deployment is ready to receive access logs via OTLPs. Configure the agentgateway proxy to send access logs to it, then query them in Grafana through Loki.

  1. Create a AgentgatewayPolicy resource that points the agentgateway proxy at the OTel collector.

    kubectl apply -f- <<EOF
    apiVersion: agentgateway.dev/v1alpha1
    kind: AgentgatewayPolicy
    metadata:
      name: access-logs
      namespace: agentgateway-system
    spec:
      targetRefs:
      - group: gateway.networking.k8s.io
        kind: Gateway
        name: agentgateway-proxy
      frontend:
        accessLog:
          otlp:
            backendRef:
              name: opentelemetry-collector-logs
              namespace: telemetry
              port: 4317
            protocol: GRPC
    EOF

    Tip

    To filter which logs are exported, add custom fields, or send logs to a different backend, see Export logs over OTLP.

  2. Open Grafana.

    1. Port-forward the Grafana service.

      kubectl port-forward svc/kube-prometheus-stack-grafana -n telemetry 3000:80
    2. Open Grafana at http://localhost:3000.

    3. Log in to Grafana with the admin username prom-operator password .

  3. Go to Explore and select Loki as the data source.

  4. Use the Label browser to find your log stream, then add filters to narrow results. Each proxied request is stored as a log entry with structured metadata attributes such as http.method, http.path, and http.status. Use the following filter patterns:

    GoalLogQL filter
    Requests to a specific path| http_path="/get"
    Error responses (4xx/5xx)| http_status="400" or | http_status="500"
    Logs from a specific gateway| gateway="agentgateway-system/agentgateway-proxy"

Cleanup

You can remove the resources that you created in this guide. Run the following command.

kubectl delete AgentgatewayPolicy access-logs -n agentgateway-system
Was this page helpful?
Agentgateway assistant

Ask me anything about agentgateway configuration, features, or usage.

Note: AI-generated content might contain errors; please verify and test all returned information.

Tip: one topic per conversation gives the best results. Use the + button in the chat header to start a new conversation.

Switching topics? Starting a new conversation improves accuracy.
↑↓ navigate select esc dismiss

What could be improved?

Your feedback helps us improve assistant answers and identify docs gaps we should fix.

Need more help? Join us on Discord: https://discord.gg/y9efgEmppm

Want to use your own agent? Add the Solo MCP server to query our docs directly. Get started here: https://search.solo.io/.