HTTP Log: Send HTTP logs with custom header - Plugin

Send HTTP logs with custom header

Send HTTP logs to a log server while specifying a custom header. Custom headers are often used for authorization.

Prerequisites

You have a log server that you want to send Kong Gateway logs to.

Environment variables

LOG_SERVER_URL: The endpoint of the log server that will receive Kong Gateway logs.
AUTH_TOKEN: The token for your custom authorization header.

Set up the plugin

Add this section to your declarative configuration file:

_format_version: "3.0"
plugins:
  - name: http-log
    config:
      http_endpoint: ${{ env "DECK_LOG_SERVER_URL" }}
      headers:
        Authorization: Bearer ${{ env "DECK_AUTH_TOKEN" }}
      method: POST
      timeout: 3000
      retry_count: 1

Make the following request:

curl -i -X POST http://localhost:8001/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "http-log",
      "config": {
        "http_endpoint": "'$LOG_SERVER_URL'",
        "headers": {
          "Authorization": "Bearer '$AUTH_TOKEN'"
        },
        "method": "POST",
        "timeout": 3000,
        "retry_count": 1
      }
    }
    '

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": "http-log",
      "config": {
        "http_endpoint": "'$LOG_SERVER_URL'",
        "headers": {
          "Authorization": "Bearer '$AUTH_TOKEN'"
        },
        "method": "POST",
        "timeout": 3000,
        "retry_count": 1
      }
    }
    '

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: http-log
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: 'true'
config:
  http_endpoint: '$LOG_SERVER_URL'
  headers:
    Authorization: Bearer $AUTH_TOKEN
  method: POST
  timeout: 3000
  retry_count: 1
plugin: http-log
" | 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_http_log" "my_http_log" {
  enabled = true

  config = {
    http_endpoint = var.log_server_url

    headers = {
      Authorization = "Bearer var.auth_token"
    }
    method = "POST"
    timeout = 3000
    retry_count = 1
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}

This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.

variable "auth_token" {
  type = string
}

Add this section to your declarative configuration file:

_format_version: "3.0"
plugins:
  - name: http-log
    service: serviceName|Id
    config:
      http_endpoint: ${{ env "DECK_LOG_SERVER_URL" }}
      headers:
        Authorization: Bearer ${{ env "DECK_AUTH_TOKEN" }}
      method: POST
      timeout: 3000
      retry_count: 1

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": "http-log",
      "config": {
        "http_endpoint": "'$LOG_SERVER_URL'",
        "headers": {
          "Authorization": "Bearer '$AUTH_TOKEN'"
        },
        "method": "POST",
        "timeout": 3000,
        "retry_count": 1
      }
    }
    '

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": "http-log",
      "config": {
        "http_endpoint": "'$LOG_SERVER_URL'",
        "headers": {
          "Authorization": "Bearer '$AUTH_TOKEN'"
        },
        "method": "POST",
        "timeout": 3000,
        "retry_count": 1
      }
    }
    '

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: http-log
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
config:
  http_endpoint: '$LOG_SERVER_URL'
  headers:
    Authorization: Bearer $AUTH_TOKEN
  method: POST
  timeout: 3000
  retry_count: 1
plugin: http-log
" | kubectl apply -f -

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

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

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_http_log" "my_http_log" {
  enabled = true

  config = {
    http_endpoint = var.log_server_url

    headers = {
      Authorization = "Bearer var.auth_token"
    }
    method = "POST"
    timeout = 3000
    retry_count = 1
  }

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

This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.

variable "auth_token" {
  type = string
}

Add this section to your declarative configuration file:

_format_version: "3.0"
plugins:
  - name: http-log
    route: routeName|Id
    config:
      http_endpoint: ${{ env "DECK_LOG_SERVER_URL" }}
      headers:
        Authorization: Bearer ${{ env "DECK_AUTH_TOKEN" }}
      method: POST
      timeout: 3000
      retry_count: 1

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": "http-log",
      "config": {
        "http_endpoint": "'$LOG_SERVER_URL'",
        "headers": {
          "Authorization": "Bearer '$AUTH_TOKEN'"
        },
        "method": "POST",
        "timeout": 3000,
        "retry_count": 1
      }
    }
    '

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": "http-log",
      "config": {
        "http_endpoint": "'$LOG_SERVER_URL'",
        "headers": {
          "Authorization": "Bearer '$AUTH_TOKEN'"
        },
        "method": "POST",
        "timeout": 3000,
        "retry_count": 1
      }
    }
    '

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: http-log
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
config:
  http_endpoint: '$LOG_SERVER_URL'
  headers:
    Authorization: Bearer $AUTH_TOKEN
  method: POST
  timeout: 3000
  retry_count: 1
plugin: http-log
" | kubectl apply -f -

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

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

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

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_http_log" "my_http_log" {
  enabled = true

  config = {
    http_endpoint = var.log_server_url

    headers = {
      Authorization = "Bearer var.auth_token"
    }
    method = "POST"
    timeout = 3000
    retry_count = 1
  }

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

This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.

variable "auth_token" {
  type = string
}

Add this section to your declarative configuration file:

_format_version: "3.0"
plugins:
  - name: http-log
    consumer: consumerName|Id
    config:
      http_endpoint: ${{ env "DECK_LOG_SERVER_URL" }}
      headers:
        Authorization: Bearer ${{ env "DECK_AUTH_TOKEN" }}
      method: POST
      timeout: 3000
      retry_count: 1

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": "http-log",
      "config": {
        "http_endpoint": "'$LOG_SERVER_URL'",
        "headers": {
          "Authorization": "Bearer '$AUTH_TOKEN'"
        },
        "method": "POST",
        "timeout": 3000,
        "retry_count": 1
      }
    }
    '

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": "http-log",
      "config": {
        "http_endpoint": "'$LOG_SERVER_URL'",
        "headers": {
          "Authorization": "Bearer '$AUTH_TOKEN'"
        },
        "method": "POST",
        "timeout": 3000,
        "retry_count": 1
      }
    }
    '

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: http-log
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
config:
  http_endpoint: '$LOG_SERVER_URL'
  headers:
    Authorization: Bearer $AUTH_TOKEN
  method: POST
  timeout: 3000
  retry_count: 1
plugin: http-log
" | kubectl apply -f -

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

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

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_http_log" "my_http_log" {
  enabled = true

  config = {
    http_endpoint = var.log_server_url

    headers = {
      Authorization = "Bearer var.auth_token"
    }
    method = "POST"
    timeout = 3000
    retry_count = 1
  }

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

This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.

variable "auth_token" {
  type = string
}

HTTP Log

Send HTTP logs with custom header

Prerequisites

Environment variables

Set up the plugin

Help us make these docs great!

Still need help