OpenTelemetry: Add custom attributes to your access logs - Plugin

Add custom attributes to your access logsv3.14+

Add custom attributes to your access logs using the OpenTelemetry plugin.

Using the config.access_logs.custom_attributes_by_lua configuration, define multiple key-value pairs, where each key represents an attribute name and each value is dynamically computed using Lua code.

Prerequisites

An OpenTelemetry backend

Set up the plugin

Add this section to your kong.yaml configuration file:

kong.yaml

Copied!

_format_version: "3.0"
plugins:
  - name: opentelemetry
    config:
      access_logs:
        endpoint: http://localhost:4318/v1/logs
        custom_attributes_by_lua:
          foo: return "bar"
          kong.workspace.name: return "updated by custom Lua code"
          kong.version: return kong.version
          upstream_host: return ngx.var.upstream_host or "unknown"
          upstream_addr: return ngx.var.upstream_addr or "unknown"

Make the following request:

curl -i -X POST http://localhost:8001/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "opentelemetry",
      "config": {
        "access_logs": {
          "endpoint": "http://localhost:4318/v1/logs",
          "custom_attributes_by_lua": {
            "foo": "return \"bar\"",
            "kong.workspace.name": "return \"updated by custom Lua code\"",
            "kong.version": "return kong.version",
            "upstream_host": "return ngx.var.upstream_host or \"unknown\"",
            "upstream_addr": "return ngx.var.upstream_addr or \"unknown\""
          }
        }
      },
      "tags": []
    }
    '

Copied!

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "opentelemetry",
      "config": {
        "access_logs": {
          "endpoint": "http://localhost:4318/v1/logs",
          "custom_attributes_by_lua": {
            "foo": "return \"bar\"",
            "kong.workspace.name": "return \"updated by custom Lua code\"",
            "kong.version": "return kong.version",
            "upstream_host": "return ngx.var.upstream_host or \"unknown\"",
            "upstream_addr": "return ngx.var.upstream_addr or \"unknown\""
          }
        }
      },
      "tags": []
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
controlPlaneId: The id of the control plane.

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: opentelemetry
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
    konghq.com/tags: ''
  labels:
    global: 'true'
config:
  access_logs:
    endpoint: http://localhost:4318/v1/logs
    custom_attributes_by_lua:
      foo: return 'bar'
      kong.workspace.name: return 'updated by custom Lua code'
      kong.version: return kong.version
      upstream_host: return ngx.var.upstream_host or 'unknown'
      upstream_addr: return ngx.var.upstream_addr or 'unknown'
plugin: opentelemetry
" | kubectl apply -f -

Copied!

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Copied!

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_opentelemetry" "my_opentelemetry" {
  enabled = true

  config = {

    access_logs = {
      endpoint = "http://localhost:4318/v1/logs"

      custom_attributes_by_lua = {
        foo = "return \"bar\""
        kong.workspace.name = "return \"updated by custom Lua code\""
        kong.version = "return kong.version"
        upstream_host = "return ngx.var.upstream_host or \"unknown\""
        upstream_addr = "return ngx.var.upstream_addr or \"unknown\""
      }
    }
  }
  tags = []

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}

Copied!

Add this section to your kong.yaml configuration file:

kong.yaml

Copied!

_format_version: "3.0"
plugins:
  - name: opentelemetry
    service: serviceName|Id
    config:
      access_logs:
        endpoint: http://localhost:4318/v1/logs
        custom_attributes_by_lua:
          foo: return "bar"
          kong.workspace.name: return "updated by custom Lua code"
          kong.version: return kong.version
          upstream_host: return ngx.var.upstream_host or "unknown"
          upstream_addr: return ngx.var.upstream_addr or "unknown"

Make sure to replace the following placeholders with your own values:

serviceName|Id: The id or name of the service the plugin configuration will target.

Make the following request:

curl -i -X POST http://localhost:8001/services/{serviceName|Id}/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "opentelemetry",
      "config": {
        "access_logs": {
          "endpoint": "http://localhost:4318/v1/logs",
          "custom_attributes_by_lua": {
            "foo": "return \"bar\"",
            "kong.workspace.name": "return \"updated by custom Lua code\"",
            "kong.version": "return kong.version",
            "upstream_host": "return ngx.var.upstream_host or \"unknown\"",
            "upstream_addr": "return ngx.var.upstream_addr or \"unknown\""
          }
        }
      },
      "tags": []
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

serviceName|Id: The id or name of the service the plugin configuration will target.

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/services/{serviceId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "opentelemetry",
      "config": {
        "access_logs": {
          "endpoint": "http://localhost:4318/v1/logs",
          "custom_attributes_by_lua": {
            "foo": "return \"bar\"",
            "kong.workspace.name": "return \"updated by custom Lua code\"",
            "kong.version": "return kong.version",
            "upstream_host": "return ngx.var.upstream_host or \"unknown\"",
            "upstream_addr": "return ngx.var.upstream_addr or \"unknown\""
          }
        }
      },
      "tags": []
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
controlPlaneId: The id of the control plane.
serviceId: The id of the service the plugin configuration will target.

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: opentelemetry
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
    konghq.com/tags: ''
config:
  access_logs:
    endpoint: http://localhost:4318/v1/logs
    custom_attributes_by_lua:
      foo: return 'bar'
      kong.workspace.name: return 'updated by custom Lua code'
      kong.version: return kong.version
      upstream_host: return ngx.var.upstream_host or 'unknown'
      upstream_addr: return ngx.var.upstream_addr or 'unknown'
plugin: opentelemetry
" | kubectl apply -f -

Copied!

Next, apply the KongPlugin resource by annotating the service resource:

kubectl annotate -n kong service SERVICE_NAME konghq.com/plugins=opentelemetry

Copied!

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Copied!

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_opentelemetry" "my_opentelemetry" {
  enabled = true

  config = {

    access_logs = {
      endpoint = "http://localhost:4318/v1/logs"

      custom_attributes_by_lua = {
        foo = "return \"bar\""
        kong.workspace.name = "return \"updated by custom Lua code\""
        kong.version = "return kong.version"
        upstream_host = "return ngx.var.upstream_host or \"unknown\""
        upstream_addr = "return ngx.var.upstream_addr or \"unknown\""
      }
    }
  }
  tags = []

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  service = {
    id = konnect_gateway_service.my_service.id
  }
}

Copied!

Add this section to your kong.yaml configuration file:

kong.yaml

Copied!

_format_version: "3.0"
plugins:
  - name: opentelemetry
    route: routeName|Id
    config:
      access_logs:
        endpoint: http://localhost:4318/v1/logs
        custom_attributes_by_lua:
          foo: return "bar"
          kong.workspace.name: return "updated by custom Lua code"
          kong.version: return kong.version
          upstream_host: return ngx.var.upstream_host or "unknown"
          upstream_addr: return ngx.var.upstream_addr or "unknown"

Make sure to replace the following placeholders with your own values:

routeName|Id: The id or name of the route the plugin configuration will target.

Make the following request:

curl -i -X POST http://localhost:8001/routes/{routeName|Id}/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "opentelemetry",
      "config": {
        "access_logs": {
          "endpoint": "http://localhost:4318/v1/logs",
          "custom_attributes_by_lua": {
            "foo": "return \"bar\"",
            "kong.workspace.name": "return \"updated by custom Lua code\"",
            "kong.version": "return kong.version",
            "upstream_host": "return ngx.var.upstream_host or \"unknown\"",
            "upstream_addr": "return ngx.var.upstream_addr or \"unknown\""
          }
        }
      },
      "tags": []
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

routeName|Id: The id or name of the route the plugin configuration will target.

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/routes/{routeId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "opentelemetry",
      "config": {
        "access_logs": {
          "endpoint": "http://localhost:4318/v1/logs",
          "custom_attributes_by_lua": {
            "foo": "return \"bar\"",
            "kong.workspace.name": "return \"updated by custom Lua code\"",
            "kong.version": "return kong.version",
            "upstream_host": "return ngx.var.upstream_host or \"unknown\"",
            "upstream_addr": "return ngx.var.upstream_addr or \"unknown\""
          }
        }
      },
      "tags": []
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
controlPlaneId: The id of the control plane.
routeId: The id of the route the plugin configuration will target.

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: opentelemetry
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
    konghq.com/tags: ''
config:
  access_logs:
    endpoint: http://localhost:4318/v1/logs
    custom_attributes_by_lua:
      foo: return 'bar'
      kong.workspace.name: return 'updated by custom Lua code'
      kong.version: return kong.version
      upstream_host: return ngx.var.upstream_host or 'unknown'
      upstream_addr: return ngx.var.upstream_addr or 'unknown'
plugin: opentelemetry
" | kubectl apply -f -

Copied!

Next, apply the KongPlugin resource by annotating the httproute or ingress resource:

kubectl annotate -n kong httproute  konghq.com/plugins=opentelemetry

Copied!

kubectl annotate -n kong ingress  konghq.com/plugins=opentelemetry

Copied!

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Copied!

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_opentelemetry" "my_opentelemetry" {
  enabled = true

  config = {

    access_logs = {
      endpoint = "http://localhost:4318/v1/logs"

      custom_attributes_by_lua = {
        foo = "return \"bar\""
        kong.workspace.name = "return \"updated by custom Lua code\""
        kong.version = "return kong.version"
        upstream_host = "return ngx.var.upstream_host or \"unknown\""
        upstream_addr = "return ngx.var.upstream_addr or \"unknown\""
      }
    }
  }
  tags = []

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  route = {
    id = konnect_gateway_route.my_route.id
  }
}

Copied!

Add this section to your kong.yaml configuration file:

kong.yaml

Copied!

_format_version: "3.0"
plugins:
  - name: opentelemetry
    consumer: consumerName|Id
    config:
      access_logs:
        endpoint: http://localhost:4318/v1/logs
        custom_attributes_by_lua:
          foo: return "bar"
          kong.workspace.name: return "updated by custom Lua code"
          kong.version: return kong.version
          upstream_host: return ngx.var.upstream_host or "unknown"
          upstream_addr: return ngx.var.upstream_addr or "unknown"

Make sure to replace the following placeholders with your own values:

consumerName|Id: The id or name of the consumer the plugin configuration will target.

Make the following request:

curl -i -X POST http://localhost:8001/consumers/{consumerName|Id}/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "opentelemetry",
      "config": {
        "access_logs": {
          "endpoint": "http://localhost:4318/v1/logs",
          "custom_attributes_by_lua": {
            "foo": "return \"bar\"",
            "kong.workspace.name": "return \"updated by custom Lua code\"",
            "kong.version": "return kong.version",
            "upstream_host": "return ngx.var.upstream_host or \"unknown\"",
            "upstream_addr": "return ngx.var.upstream_addr or \"unknown\""
          }
        }
      },
      "tags": []
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

consumerName|Id: The id or name of the consumer the plugin configuration will target.

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/consumers/{consumerId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "opentelemetry",
      "config": {
        "access_logs": {
          "endpoint": "http://localhost:4318/v1/logs",
          "custom_attributes_by_lua": {
            "foo": "return \"bar\"",
            "kong.workspace.name": "return \"updated by custom Lua code\"",
            "kong.version": "return kong.version",
            "upstream_host": "return ngx.var.upstream_host or \"unknown\"",
            "upstream_addr": "return ngx.var.upstream_addr or \"unknown\""
          }
        }
      },
      "tags": []
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
controlPlaneId: The id of the control plane.
consumerId: The id of the consumer the plugin configuration will target.

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: opentelemetry
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
    konghq.com/tags: ''
config:
  access_logs:
    endpoint: http://localhost:4318/v1/logs
    custom_attributes_by_lua:
      foo: return 'bar'
      kong.workspace.name: return 'updated by custom Lua code'
      kong.version: return kong.version
      upstream_host: return ngx.var.upstream_host or 'unknown'
      upstream_addr: return ngx.var.upstream_addr or 'unknown'
plugin: opentelemetry
" | kubectl apply -f -

Copied!

Next, apply the KongPlugin resource by annotating the KongConsumer resource:

kubectl annotate -n kong kongconsumer CONSUMER_NAME konghq.com/plugins=opentelemetry

Copied!

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Copied!

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_opentelemetry" "my_opentelemetry" {
  enabled = true

  config = {

    access_logs = {
      endpoint = "http://localhost:4318/v1/logs"

      custom_attributes_by_lua = {
        foo = "return \"bar\""
        kong.workspace.name = "return \"updated by custom Lua code\""
        kong.version = "return kong.version"
        upstream_host = "return ngx.var.upstream_host or \"unknown\""
        upstream_addr = "return ngx.var.upstream_addr or \"unknown\""
      }
    }
  }
  tags = []

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  consumer = {
    id = konnect_gateway_consumer.my_consumer.id
  }
}

Copied!

OpenTelemetry

Add custom attributes to your access logsv3.14+

Prerequisites

Set up the plugin

Help us make these docs great!

Still need help?