Enable the OTEL plugin for metrics, traces and logs
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:
Prerequisites
-
An OpenTelemetry backend
-
To enable tracing, set
tracing_instrumentations = allandtracing_sampling_rate = 1.0inkong.conf
Add this section to your kong.yaml configuration file:
_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": []
}
'
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": []
}
'
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: Theidof 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 -
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/"
}
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
}
Add this section to your kong.yaml configuration file:
_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: Theidornameof 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": []
}
'
Make sure to replace the following placeholders with your own values:
-
serviceName|Id: Theidornameof 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": []
}
'
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: Theidof the control plane. -
serviceId: Theidof 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 -
Next, apply the KongPlugin resource by annotating the service resource:
kubectl annotate -n kong service SERVICE_NAME konghq.com/plugins=opentelemetry
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/"
}
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
}
}
Add this section to your kong.yaml configuration file:
_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: Theidornameof 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": []
}
'
Make sure to replace the following placeholders with your own values:
-
routeName|Id: Theidornameof 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": []
}
'
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: Theidof the control plane. -
routeId: Theidof 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 -
Next, apply the KongPlugin resource by annotating the httproute or ingress resource:
kubectl annotate -n kong httproute konghq.com/plugins=opentelemetry
kubectl annotate -n kong ingress konghq.com/plugins=opentelemetry
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/"
}
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
}
}
Add this section to your kong.yaml configuration file:
_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: Theidornameof 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": []
}
'
Make sure to replace the following placeholders with your own values:
-
consumerName|Id: Theidornameof 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": []
}
'
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: Theidof the control plane. -
consumerId: Theidof 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 -
Next, apply the KongPlugin resource by annotating the KongConsumer resource:
kubectl annotate -n kong kongconsumer CONSUMER_NAME konghq.com/plugins=opentelemetry
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/"
}
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
}
}