How to log the pod name of the Kong Gateway node that processed a request

Uses: Kong Ingress Controller

TL;DR

How do I add the data plane pod name to the log produced by a Kong Gateway logging plugin to identify which Kong Gateway pod processed the request?

In a Kubernetes environment, the container exposes a HOSTNAME variable set to the pod the container runs on. Using the environment variable Vault secret management backend, add this variable to the log plugin output by adding a new field to the plugin’s config.custom_fields_by_lua property.

Steps

In a Kubernetes environment, a container has a HOSTNAME variable set to the name of the pod it runs on. Using the environment variable Vault secret management backend, you can expose this variable in log plugin output by adding a field to the plugin’s config.custom_fields_by_lua property.

The following examples use the File Log plugin.

curl -X POST http://localhost:8001/WORKSPACE/plugins \
  -H "Kong-Admin-Token: $KONG_ADMIN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "file-log",
    "config": {
      "custom_fields_by_lua": {
        "x-pod-name": "return kong.vault.get(\"{vault://env/hostname}\")"
      },
      "path": "/tmp/file.log"
    }
  }'

Copied!

plugins:
- name: file-log
  enabled: true
  config:
    custom_fields_by_lua:
      x-pod-name: return kong.vault.get("{vault://env/hostname}")
    path: /tmp/file.log
    reopen: false

Copied!

How to log the pod name of the Kong Gateway node that processed a request

Steps

Help us make these docs great!

Still need help?