OpenTelemetry: Enable the OTEL plugin for metrics, traces and logs - Plugin

Enable the OTEL plugin for metrics, traces and logsv3.14+

Enables the OTEL plugin with endpoints for metrics, tracing and logs. It also adds the X-Auth-Token header in the HTTP request sent to the OTLP server. For complete tutorials with OpenTelemetry Collector and Grafana, see:

If you are running Kong Gateway in 3.13, use access_logs_endpoint instead of access_logs.endpoint.

Prerequisites

An OpenTelemetry backend
To enable tracing, set tracing_instrumentations = all and tracing_sampling_rate = 1.0 in kong.conf

Set up the plugin

Add this section to your kong.yaml configuration file:

kong.yaml

Copied!

_format_version: "3.0"
plugins:
  - name: opentelemetry
    config:
      traces_endpoint: http://localhost:4318/v1/traces
      logs_endpoint: http://localhost:4318/v1/logs
      access_logs:
        endpoint: http://localhost:4318/v1/logs
      metrics:
        endpoint: http://localhost:4318/v1/metrics
      headers:
        X-Auth-Token: secret-token

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": {
        "traces_endpoint": "http://localhost:4318/v1/traces",
        "logs_endpoint": "http://localhost:4318/v1/logs",
        "access_logs": {
          "endpoint": "http://localhost:4318/v1/logs"
        },
        "metrics": {
          "endpoint": "http://localhost:4318/v1/metrics"
        },
        "headers": {
          "X-Auth-Token": "secret-token"
        }
      },
      "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": {
        "traces_endpoint": "http://localhost:4318/v1/traces",
        "logs_endpoint": "http://localhost:4318/v1/logs",
        "access_logs": {
          "endpoint": "http://localhost:4318/v1/logs"
        },
        "metrics": {
          "endpoint": "http://localhost:4318/v1/metrics"
        },
        "headers": {
          "X-Auth-Token": "secret-token"
        }
      },
      "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:
  traces_endpoint: http://localhost:4318/v1/traces
  logs_endpoint: http://localhost:4318/v1/logs
  access_logs:
    endpoint: http://localhost:4318/v1/logs
  metrics:
    endpoint: http://localhost:4318/v1/metrics
  headers:
    X-Auth-Token: secret-token
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 = {
    traces_endpoint = "http://localhost:4318/v1/traces"
    logs_endpoint = "http://localhost:4318/v1/logs"

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

    metrics = {
      endpoint = "http://localhost:4318/v1/metrics"
    }

    headers = {
      X-Auth-Token = "secret-token"
    }
  }
  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:
      traces_endpoint: http://localhost:4318/v1/traces
      logs_endpoint: http://localhost:4318/v1/logs
      access_logs:
        endpoint: http://localhost:4318/v1/logs
      metrics:
        endpoint: http://localhost:4318/v1/metrics
      headers:
        X-Auth-Token: secret-token

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": {
        "traces_endpoint": "http://localhost:4318/v1/traces",
        "logs_endpoint": "http://localhost:4318/v1/logs",
        "access_logs": {
          "endpoint": "http://localhost:4318/v1/logs"
        },
        "metrics": {
          "endpoint": "http://localhost:4318/v1/metrics"
        },
        "headers": {
          "X-Auth-Token": "secret-token"
        }
      },
      "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": {
        "traces_endpoint": "http://localhost:4318/v1/traces",
        "logs_endpoint": "http://localhost:4318/v1/logs",
        "access_logs": {
          "endpoint": "http://localhost:4318/v1/logs"
        },
        "metrics": {
          "endpoint": "http://localhost:4318/v1/metrics"
        },
        "headers": {
          "X-Auth-Token": "secret-token"
        }
      },
      "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:
  traces_endpoint: http://localhost:4318/v1/traces
  logs_endpoint: http://localhost:4318/v1/logs
  access_logs:
    endpoint: http://localhost:4318/v1/logs
  metrics:
    endpoint: http://localhost:4318/v1/metrics
  headers:
    X-Auth-Token: secret-token
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 = {
    traces_endpoint = "http://localhost:4318/v1/traces"
    logs_endpoint = "http://localhost:4318/v1/logs"

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

    metrics = {
      endpoint = "http://localhost:4318/v1/metrics"
    }

    headers = {
      X-Auth-Token = "secret-token"
    }
  }
  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:
      traces_endpoint: http://localhost:4318/v1/traces
      logs_endpoint: http://localhost:4318/v1/logs
      access_logs:
        endpoint: http://localhost:4318/v1/logs
      metrics:
        endpoint: http://localhost:4318/v1/metrics
      headers:
        X-Auth-Token: secret-token

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": {
        "traces_endpoint": "http://localhost:4318/v1/traces",
        "logs_endpoint": "http://localhost:4318/v1/logs",
        "access_logs": {
          "endpoint": "http://localhost:4318/v1/logs"
        },
        "metrics": {
          "endpoint": "http://localhost:4318/v1/metrics"
        },
        "headers": {
          "X-Auth-Token": "secret-token"
        }
      },
      "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": {
        "traces_endpoint": "http://localhost:4318/v1/traces",
        "logs_endpoint": "http://localhost:4318/v1/logs",
        "access_logs": {
          "endpoint": "http://localhost:4318/v1/logs"
        },
        "metrics": {
          "endpoint": "http://localhost:4318/v1/metrics"
        },
        "headers": {
          "X-Auth-Token": "secret-token"
        }
      },
      "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:
  traces_endpoint: http://localhost:4318/v1/traces
  logs_endpoint: http://localhost:4318/v1/logs
  access_logs:
    endpoint: http://localhost:4318/v1/logs
  metrics:
    endpoint: http://localhost:4318/v1/metrics
  headers:
    X-Auth-Token: secret-token
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 = {
    traces_endpoint = "http://localhost:4318/v1/traces"
    logs_endpoint = "http://localhost:4318/v1/logs"

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

    metrics = {
      endpoint = "http://localhost:4318/v1/metrics"
    }

    headers = {
      X-Auth-Token = "secret-token"
    }
  }
  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:
      traces_endpoint: http://localhost:4318/v1/traces
      logs_endpoint: http://localhost:4318/v1/logs
      access_logs:
        endpoint: http://localhost:4318/v1/logs
      metrics:
        endpoint: http://localhost:4318/v1/metrics
      headers:
        X-Auth-Token: secret-token

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": {
        "traces_endpoint": "http://localhost:4318/v1/traces",
        "logs_endpoint": "http://localhost:4318/v1/logs",
        "access_logs": {
          "endpoint": "http://localhost:4318/v1/logs"
        },
        "metrics": {
          "endpoint": "http://localhost:4318/v1/metrics"
        },
        "headers": {
          "X-Auth-Token": "secret-token"
        }
      },
      "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": {
        "traces_endpoint": "http://localhost:4318/v1/traces",
        "logs_endpoint": "http://localhost:4318/v1/logs",
        "access_logs": {
          "endpoint": "http://localhost:4318/v1/logs"
        },
        "metrics": {
          "endpoint": "http://localhost:4318/v1/metrics"
        },
        "headers": {
          "X-Auth-Token": "secret-token"
        }
      },
      "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:
  traces_endpoint: http://localhost:4318/v1/traces
  logs_endpoint: http://localhost:4318/v1/logs
  access_logs:
    endpoint: http://localhost:4318/v1/logs
  metrics:
    endpoint: http://localhost:4318/v1/metrics
  headers:
    X-Auth-Token: secret-token
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 = {
    traces_endpoint = "http://localhost:4318/v1/traces"
    logs_endpoint = "http://localhost:4318/v1/logs"

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

    metrics = {
      endpoint = "http://localhost:4318/v1/metrics"
    }

    headers = {
      X-Auth-Token = "secret-token"
    }
  }
  tags = []

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

Copied!

OpenTelemetry

Enable the OTEL plugin for metrics, traces and logsv3.14+

Prerequisites

Set up the plugin

Help us make these docs great!

Still need help?