Zipkin: Preserve incoming format - Plugin

Preserve incoming format

Configure the Zipkin plugin to extract tracing context and inject it in the same type, preserving the format. The configuration takes the following form:

Extracts the tracing context using order of precedence: w3c > b3 > jaeger > ot > aws > datadog
Injects the tracing context in the extracted header type
Defaults to w3c for context injection if none of the extract header types were found in the request

Set up the plugin

Add this section to your declarative configuration file:

_format_version: "3.0"
plugins:
  - name: zipkin
    config:
      propagation:
        extract:
        - w3c
        - b3
        - jaeger
        - ot
        - aws
        - datadog
        inject:
        - preserve
        default_format: w3c

Make the following request:

curl -i -X POST http://localhost:8001/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "zipkin",
      "config": {
        "propagation": {
          "extract": [
            "w3c",
            "b3",
            "jaeger",
            "ot",
            "aws",
            "datadog"
          ],
          "inject": [
            "preserve"
          ],
          "default_format": "w3c"
        }
      }
    }
    '

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": "zipkin",
      "config": {
        "propagation": {
          "extract": [
            "w3c",
            "b3",
            "jaeger",
            "ot",
            "aws",
            "datadog"
          ],
          "inject": [
            "preserve"
          ],
          "default_format": "w3c"
        }
      }
    }
    '

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

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

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: zipkin
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: 'true'
config:
  propagation:
    extract:
    - w3c
    - b3
    - jaeger
    - ot
    - aws
    - datadog
    inject:
    - preserve
    default_format: w3c
plugin: zipkin
" | 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_zipkin" "my_zipkin" {
  enabled = true

  config = {

    propagation = {
      extract = ["w3c", "b3", "jaeger", "ot", "aws", "datadog"]
      inject = ["preserve"]
      default_format = "w3c"
    }
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}

Add this section to your declarative configuration file:

_format_version: "3.0"
plugins:
  - name: zipkin
    service: serviceName|Id
    config:
      propagation:
        extract:
        - w3c
        - b3
        - jaeger
        - ot
        - aws
        - datadog
        inject:
        - preserve
        default_format: w3c

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": "zipkin",
      "config": {
        "propagation": {
          "extract": [
            "w3c",
            "b3",
            "jaeger",
            "ot",
            "aws",
            "datadog"
          ],
          "inject": [
            "preserve"
          ],
          "default_format": "w3c"
        }
      }
    }
    '

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": "zipkin",
      "config": {
        "propagation": {
          "extract": [
            "w3c",
            "b3",
            "jaeger",
            "ot",
            "aws",
            "datadog"
          ],
          "inject": [
            "preserve"
          ],
          "default_format": "w3c"
        }
      }
    }
    '

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

region: Geographic region where your Kong Konnect is hosted and operates.
controlPlaneId: The id of the control plane.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
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: zipkin
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
config:
  propagation:
    extract:
    - w3c
    - b3
    - jaeger
    - ot
    - aws
    - datadog
    inject:
    - preserve
    default_format: w3c
plugin: zipkin
" | kubectl apply -f -

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

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

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_zipkin" "my_zipkin" {
  enabled = true

  config = {

    propagation = {
      extract = ["w3c", "b3", "jaeger", "ot", "aws", "datadog"]
      inject = ["preserve"]
      default_format = "w3c"
    }
  }

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

Add this section to your declarative configuration file:

_format_version: "3.0"
plugins:
  - name: zipkin
    route: routeName|Id
    config:
      propagation:
        extract:
        - w3c
        - b3
        - jaeger
        - ot
        - aws
        - datadog
        inject:
        - preserve
        default_format: w3c

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": "zipkin",
      "config": {
        "propagation": {
          "extract": [
            "w3c",
            "b3",
            "jaeger",
            "ot",
            "aws",
            "datadog"
          ],
          "inject": [
            "preserve"
          ],
          "default_format": "w3c"
        }
      }
    }
    '

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": "zipkin",
      "config": {
        "propagation": {
          "extract": [
            "w3c",
            "b3",
            "jaeger",
            "ot",
            "aws",
            "datadog"
          ],
          "inject": [
            "preserve"
          ],
          "default_format": "w3c"
        }
      }
    }
    '

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

region: Geographic region where your Kong Konnect is hosted and operates.
controlPlaneId: The id of the control plane.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
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: zipkin
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
config:
  propagation:
    extract:
    - w3c
    - b3
    - jaeger
    - ot
    - aws
    - datadog
    inject:
    - preserve
    default_format: w3c
plugin: zipkin
" | kubectl apply -f -

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

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

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

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_zipkin" "my_zipkin" {
  enabled = true

  config = {

    propagation = {
      extract = ["w3c", "b3", "jaeger", "ot", "aws", "datadog"]
      inject = ["preserve"]
      default_format = "w3c"
    }
  }

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

Add this section to your declarative configuration file:

_format_version: "3.0"
plugins:
  - name: zipkin
    consumer: consumerName|Id
    config:
      propagation:
        extract:
        - w3c
        - b3
        - jaeger
        - ot
        - aws
        - datadog
        inject:
        - preserve
        default_format: w3c

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": "zipkin",
      "config": {
        "propagation": {
          "extract": [
            "w3c",
            "b3",
            "jaeger",
            "ot",
            "aws",
            "datadog"
          ],
          "inject": [
            "preserve"
          ],
          "default_format": "w3c"
        }
      }
    }
    '

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": "zipkin",
      "config": {
        "propagation": {
          "extract": [
            "w3c",
            "b3",
            "jaeger",
            "ot",
            "aws",
            "datadog"
          ],
          "inject": [
            "preserve"
          ],
          "default_format": "w3c"
        }
      }
    }
    '

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

region: Geographic region where your Kong Konnect is hosted and operates.
controlPlaneId: The id of the control plane.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
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: zipkin
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
config:
  propagation:
    extract:
    - w3c
    - b3
    - jaeger
    - ot
    - aws
    - datadog
    inject:
    - preserve
    default_format: w3c
plugin: zipkin
" | kubectl apply -f -

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

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

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_zipkin" "my_zipkin" {
  enabled = true

  config = {

    propagation = {
      extract = ["w3c", "b3", "jaeger", "ot", "aws", "datadog"]
      inject = ["preserve"]
      default_format = "w3c"
    }
  }

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

Zipkin

Preserve incoming format

Set up the plugin

Help us make these docs great!

Still need help