kong open telemetry plugin header_type datadog not valid option and rejected by admission webhook

[zackery-parkhurst]

Is there an existing issue for this?

• I have searched the existing issues

Current Behavior

When I set config.header_type: datadog In the opentelemetry plugin config the request is rejected and I cannot set the setting.

Expected Behavior

When I set config.header_type: datadog In the opentelemetry plugin config kong should allow me to create the plugin, As datadog is supposed to be a valid option according to the kong plugin documentation

Steps To Reproduce

1. Install KIC version via helm. Chart Version: 2.36.0
2. Try to install the open telemetry plugin with config.header_type: datadog

apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
 name: <global-opentelemetry>
 annotations:
   kubernetes.io/ingress.class: kong
 labels:
   global: "true"
config:
 endpoint: http://opentelemetry.collector:4318/v1/traces
 header_type: datadog
plugin: opentelemetry

3. Observe failure

### Kong Ingress Controller version

```shell
Chart Version: 2.36.0
App Version: 3.5

Kubernetes version

1.27

Anything else?

No response

[randmonkey]

@zackery-parkhurst Looks like you are using version 3.5 of your gateway, and the opentelemetry plugin in Kong 3.5 does not support datadog in config.header_type:

{
  "default": "preserve",
  "one_of": [
    "preserve",
    "ignore",
    "b3",
    "b3-single",
    "w3c",
    "jaeger",
    "ot",
    "aws",
    "gcp"
  ],
  "required": false,
  "type": "string"
}

You can run kong:3.5 in docker with this command

docker run -e"KONG_DATABASE=off" -e"KONG_ADMIN_LISTEN=0.0.0.0:8001"  -p"8001:8001" kong:3.5

Then you fetch the header_type of config by:

curl 127.1:8001/schemas/plugins/opentelemetry | jq .fields[1].config.fields[10].header_type

You can see the result above. This does not include datadog.

Can you try to paste your helm command to install KIC? I can help you to replace the Kong gateway version to 3.6.

[zackery-parkhurst]

@zackery-parkhurst Looks like you are using version 3.5 of your gateway, and the opentelemetry plugin in Kong 3.5 does not support datadog in config.header_type:

{
  "default": "preserve",
  "one_of": [
    "preserve",
    "ignore",
    "b3",
    "b3-single",
    "w3c",
    "jaeger",
    "ot",
    "aws",
    "gcp"
  ],
  "required": false,
  "type": "string"
}

You can run kong:3.5 in docker with this command

docker run -e"KONG_DATABASE=off" -e"KONG_ADMIN_LISTEN=0.0.0.0:8001"  -p"8001:8001" kong:3.5

Then you fetch the header_type of config by:

curl 127.1:8001/schemas/plugins/opentelemetry | jq .fields[1].config.fields[10].header_type

You can see the result above. This does not include datadog.

Can you try to paste your helm command to install KIC? I can help you to replace the Kong gateway version to 3.6.

@randmonkey I Install Gateway + KIC via terraform. Here is my install command:

resource "helm_release" "kong" {
  name       = var.kong_gateway_name
  repository = "https://charts.konghq.com"
  chart      = "kong"
  namespace  = var.kong_gateway_namespace
  version    = "2.36.0" 
  values = [
      <<EOF
      ....... 

I am installing version 2.36.0 of the KIC helm chart.

Thank you for informing me that the plugin does not support Datadog header in the gateway version 3.5.

I was just going by what the documentation for the plugin version 3.5 stated:

I was also referencing the kong gateway changelog. Which stated that in version 3.5.0.0 the datadog header_type was added.

Is the version of gateway:3.5. Not the same version that is referenced in the documentation I have linked? I was a little confused when the plugin documentation for 3.5 and kong gateway changelog for version 3.5 both said the header_type was released in 3.5, but when I installed gateway version 3.5 it was not present.

I can try updating to a version of the chart that has kong3.6. Which looks like versions > 2.37.0 will install kong 3.6.

[randmonkey]

You can also change the values in your file referred in your values section if you have one, or add a set section like this

esource "helm_release" "kong" {
  name       = var.kong_gateway_name
  repository = "https://charts.konghq.com"
  chart      = "kong"
  namespace  = var.kong_gateway_namespace
  version    = "2.36.0" 
  values = [
      <<EOF
      ....... ]
set {
  name = image.tag
  value = 3.6
}

As I checked with the gateway team, the datadog in config.header_type is only available with Kong enterprise edition. Please create an issue in the repo kong or docs to tell the mistake in the docs.

[zackery-parkhurst]

@randmonkey

As I checked with the gateway team, the datadog in config.header_type is only available with Kong enterprise edition.

Oh, this is new information. So your saying if I am using OSS I can't use the datadog in config.header_type regardless of what version of kong gateway I am on?

[randmonkey]

@randmonkey

As I checked with the gateway team, the datadog in config.header_type is only available with Kong enterprise edition.

Oh, this is new information. So your saying if I am using OSS I can't use the datadog in config.header_type regardless of what version of kong gateway I am on?

In Kong OSS 3.7 (will soon be released), we can use datadog in config.header_type. For Kong gateway 3.5 and 3.6, it is only available in Kong Enterprise but not OSS.

[zackery-parkhurst]

@randmonkey Thank you for this information. I will try again when 3.7 is released. I will go ahead and close this issue out!