OpenTelemetry: Add Principal attributes to metrics - Plugin

Add Principal attributes to metricsv3.16+

Add authenticated Principal attributes to the OTEL plugin’s request count and bandwidth metrics by enabling enable_principal_attribute.

In the example:

enable_request_metrics adds request count metrics.
enable_bandwidth_metrics adds request and response size metrics.
enable_principal_attribute adds authenticated Principal attributes to the enabled metrics.

When a request carries an authenticated Principal managed by Kong Identity, the plugin exports http.server.request.count, http.server.request.size, and http.server.response.size with the kong.auth.principal.id and kong.auth.principal.display_name attributes.

Prerequisites

An OpenTelemetry backend
An authentication plugin configured with Principals enabled, such as Key Auth or Basic Auth

Set up the plugin

Add this section to your kong.yaml configuration file:

decK

kong.yaml

Copied!

_format_version: "3.0"
plugins:
  - name: opentelemetry
    config:
      metrics:
        endpoint: http://localhost:4318/v1/metrics
        push_interval: 10
        enable_request_metrics: true
        enable_bandwidth_metrics: true
        enable_principal_attribute: true

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": {
        "metrics": {
          "endpoint": "http://localhost:4318/v1/metrics",
          "push_interval": 10,
          "enable_request_metrics": true,
          "enable_bandwidth_metrics": true,
          "enable_principal_attribute": true
        }
      }
    }
    '

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": {
        "metrics": {
          "endpoint": "http://localhost:4318/v1/metrics",
          "push_interval": 10,
          "enable_request_metrics": true,
          "enable_bandwidth_metrics": true,
          "enable_principal_attribute": true
        }
      }
    }
    '

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 Control Planes Config 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
  labels:
    global: 'true'
config:
  metrics:
    endpoint: http://localhost:4318/v1/metrics
    push_interval: 10
    enable_request_metrics: true
    enable_bandwidth_metrics: true
    enable_principal_attribute: true
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 = {

    metrics = {
      endpoint = "http://localhost:4318/v1/metrics"
      push_interval = 10
      enable_request_metrics = true
      enable_bandwidth_metrics = true
      enable_principal_attribute = true
    }
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}

Copied!

Add this section to your kong.yaml configuration file:

decK

kong.yaml

Copied!

_format_version: "3.0"
plugins:
  - name: opentelemetry
    service: serviceName|Id
    config:
      metrics:
        endpoint: http://localhost:4318/v1/metrics
        push_interval: 10
        enable_request_metrics: true
        enable_bandwidth_metrics: true
        enable_principal_attribute: true

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": {
        "metrics": {
          "endpoint": "http://localhost:4318/v1/metrics",
          "push_interval": 10,
          "enable_request_metrics": true,
          "enable_bandwidth_metrics": true,
          "enable_principal_attribute": true
        }
      }
    }
    '

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": {
        "metrics": {
          "endpoint": "http://localhost:4318/v1/metrics",
          "push_interval": 10,
          "enable_request_metrics": true,
          "enable_bandwidth_metrics": true,
          "enable_principal_attribute": true
        }
      }
    }
    '

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 Control Planes Config 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
config:
  metrics:
    endpoint: http://localhost:4318/v1/metrics
    push_interval: 10
    enable_request_metrics: true
    enable_bandwidth_metrics: true
    enable_principal_attribute: true
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 = {

    metrics = {
      endpoint = "http://localhost:4318/v1/metrics"
      push_interval = 10
      enable_request_metrics = true
      enable_bandwidth_metrics = true
      enable_principal_attribute = true
    }
  }

  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:

decK

kong.yaml

Copied!

_format_version: "3.0"
plugins:
  - name: opentelemetry
    route: routeName|Id
    config:
      metrics:
        endpoint: http://localhost:4318/v1/metrics
        push_interval: 10
        enable_request_metrics: true
        enable_bandwidth_metrics: true
        enable_principal_attribute: true

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": {
        "metrics": {
          "endpoint": "http://localhost:4318/v1/metrics",
          "push_interval": 10,
          "enable_request_metrics": true,
          "enable_bandwidth_metrics": true,
          "enable_principal_attribute": true
        }
      }
    }
    '

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": {
        "metrics": {
          "endpoint": "http://localhost:4318/v1/metrics",
          "push_interval": 10,
          "enable_request_metrics": true,
          "enable_bandwidth_metrics": true,
          "enable_principal_attribute": true
        }
      }
    }
    '

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 Control Planes Config 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
config:
  metrics:
    endpoint: http://localhost:4318/v1/metrics
    push_interval: 10
    enable_request_metrics: true
    enable_bandwidth_metrics: true
    enable_principal_attribute: true
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 = {

    metrics = {
      endpoint = "http://localhost:4318/v1/metrics"
      push_interval = 10
      enable_request_metrics = true
      enable_bandwidth_metrics = true
      enable_principal_attribute = true
    }
  }

  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:

decK

kong.yaml

Copied!

_format_version: "3.0"
plugins:
  - name: opentelemetry
    consumer: consumerName|Id
    config:
      metrics:
        endpoint: http://localhost:4318/v1/metrics
        push_interval: 10
        enable_request_metrics: true
        enable_bandwidth_metrics: true
        enable_principal_attribute: true

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": {
        "metrics": {
          "endpoint": "http://localhost:4318/v1/metrics",
          "push_interval": 10,
          "enable_request_metrics": true,
          "enable_bandwidth_metrics": true,
          "enable_principal_attribute": true
        }
      }
    }
    '

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": {
        "metrics": {
          "endpoint": "http://localhost:4318/v1/metrics",
          "push_interval": 10,
          "enable_request_metrics": true,
          "enable_bandwidth_metrics": true,
          "enable_principal_attribute": true
        }
      }
    }
    '

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 Control Planes Config 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
config:
  metrics:
    endpoint: http://localhost:4318/v1/metrics
    push_interval: 10
    enable_request_metrics: true
    enable_bandwidth_metrics: true
    enable_principal_attribute: true
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 = {

    metrics = {
      endpoint = "http://localhost:4318/v1/metrics"
      push_interval = 10
      enable_request_metrics = true
      enable_bandwidth_metrics = true
      enable_principal_attribute = true
    }
  }

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

Copied!

OpenTelemetry

Add Principal attributes to metricsv3.16+

Prerequisites

Set up the plugin

Help us make these docs great!

Still need help?