Skip to content
2023 API Summit Hackathon: Experiment with AI for APIs (August 28 - September 27) Learn More →
Kong Logo | Kong Docs Logo
search
  • We're Hiring!
  • Docs
    • Kong Gateway
      Lightweight, fast, and flexible cloud-native API gateway
      Kong Konnect
      Single platform for SaaS end-to-end connectivity
      Kong Mesh
      Enterprise service mesh based on Kuma and Envoy
      decK
      Helps manage Kong’s configuration in a declarative fashion
      Kong Ingress Controller
      Works inside a Kubernetes cluster and configures Kong to proxy traffic
      Kong Gateway Operator
      Manage your Kong deployments on Kubernetes using YAML Manifests
      Insomnia
      Collaborative API development platform
      Kuma
      Open-source distributed control plane with a bundled Envoy Proxy integration
  • API Specs
  • Plugin Hub
    • Explore the Plugin Hub
      View all plugins View all plugins View all plugins arrow image
    • Functionality View all View all arrow image
      View all plugins
      Authentication's icon
      Authentication
      Protect your services with an authentication layer
      Security's icon
      Security
      Protect your services with additional security layer
      Traffic Control's icon
      Traffic Control
      Manage, throttle and restrict inbound and outbound API traffic
      Serverless's icon
      Serverless
      Invoke serverless functions in combination with other plugins
      Analytics & Monitoring's icon
      Analytics & Monitoring
      Visualize, inspect and monitor APIs and microservices traffic
      Transformations's icon
      Transformations
      Transform request and responses on the fly on Kong
      Logging's icon
      Logging
      Log request and response data using the best transport for your infrastructure
  • Support
  • Community
  • Kong Academy
Get a Demo Start Free Trial
Kong Gateway
3.1.x
  • Home icon
  • Kong Gateway
  • Plugin Development
  • Pluginserver
  • Write plugins in Python
github-edit-pageEdit this page
report-issueReport an issue
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kong Ingress Controller
  • Kong Gateway Operator
  • Insomnia
  • Kuma

  • Docs contribution guidelines
  • 3.4.x (latest)
  • 3.3.x
  • 3.2.x
  • 3.1.x
  • 3.0.x
  • 2.8.x
  • 2.7.x
  • 2.6.x
  • Archive (pre-2.6)
enterprise-switcher-icon Switch to OSS
On this pageOn this page
  • The Python PDK
  • Install
  • Development
  • Phase handlers
    • Type hints
  • Embedded server
  • Example configuration
  • Concurrency model
  • More Information
You are browsing documentation for an outdated version. See the latest documentation here.

Write plugins in Python

The Python PDK

Kong Gateway support for Python plugin development is provided by the kong-python-pdk library. The library provides a plugin server and Kong-specific functions to interface with Kong Gateway.

Install

To install the plugin server and PDK globally, use pip:

pip3 install kong-pdk

Development

A Kong Gateway Python plugin implementation has following attributes:

Schema = (
    { "message": { "type": "string" } },
)
version = '0.1.0'
priority = 0
class Plugin(object):
  pass
  • A class named Plugin defines the class that implements this plugin.
  • A dictionary called Schema that defines expected values and data types of the plugin.
  • The variables version and priority that define the version number and priority of execution respectively.

Note: This repository contains example Python plugins and an API reference.

Phase handlers

You can implement custom logic to be executed at various points of the request processing lifecycle. To execute custom code during the access phase, define a function named access:

class Plugin(object):
    def __init__(self, config):
        self.config = config
    def access(self, kong):
      pass

You can implement custom logic during the following phases using the same function signature:

  • certificate
  • rewrite
  • access
  • response
  • preread
  • log

The presence of the response handler automatically enables the buffered proxy mode.

Notes: A positional argument is required in the definition of the phase handler method. In the example below, the positional argument is called kong. The positional argument can be used as the PDK function’s root object, which means that you can call specific PDK functions by using this argument, like kong.log.info or kong.request.get_header.

Type hints

Support for type hints is available. To use type hints and autocomplete in an IDE, add the kong parameter to the phase handler function:

import kong_pdk.pdk.kong as kong
class Plugin(object):
    def __init__(self, config):
        self.config = config
    def access(self, kong: kong.kong):
        host, err = kong.request.get_header("host")

Warning: Classes and functions in the kong_pdk.pdk.kong module cannot be used directly because they’re only used for type hints. To call PDK functions, use the kong object that is passed as the phase handler’s parameter. Keep in mind that if you want to call PDK functions outside of the phase handler, you also need to pass the kong object to your outer code.

Here is an example of using the PDK functions outside of the Plugin class:

import kong_pdk.pdk.kong as kong

def example_access_phase(kong: kong.kong):
    host_header, err = kong.request.get_header("host")
    kong.log.info(host_header)

class Plugin(object):
    def __init__(self, config):
        self.config = config
    def access(self, kong: kong.kong):
        example_access_phase(kong)

Embedded server

To use the embedded server, use the following code:

if __name__ == "__main__":
    from kong_pdk.cli import start_dedicated_server
    start_dedicated_server("py-hello", Plugin, version, priority)

The first argument to start_dedicated_server defines the plugin name and must be unique.

Example configuration

To load plugins using the kong.conf configuration file, you have to map existing Kong Gateway properties to aspects of your plugin. Below are two examples of loading plugins within kong.conf.

pluginserver_names = my-plugin,other-one
pluginserver_my_plugin_socket = /usr/local/kong/my-plugin.socket
pluginserver_my_plugin_start_cmd = /path/to/my-plugin.py
pluginserver_my_plugin_query_cmd = /path/to/my-plugin.py --dump
pluginserver_other_one_socket = /usr/local/kong/other-one.socket
pluginserver_other_one_start_cmd = /path/to/other-one.py
pluginserver_other_one_query_cmd = /path/to/other-one.py -dump

The socket and start command settings coincide with their defaults and can be omitted:

pluginserver_names = my-plugin,other-one
pluginserver_my_plugin_query_cmd = /path/to/my-plugin --dump
pluginserver_other_one_query_cmd = /path/to/other-one --dump

If you want to open verbose logging, pass the -v argument to the start command line:

pluginserver_my_plugin_start_cmd = /path/to/my-plugin.py -v

Concurrency model

The Python plugin server and the embedded server support concurrency. By default, the server starts in multi-threading mode.

If your workload is IO intensive, you can use the Gevent model by passing the -g flag to start_cmd in kong.conf. If your workload is CPU intensive, consider the multi-processing model by passing the -m flag to start_cmd in kong.conf.

More Information

  • PDK Reference
  • Plugins with Containers
  • Develop plugins with Go
  • Develop plugins with JavaScript
Thank you for your feedback.
Was this page useful?
Too much on your plate? close cta icon
More features, less infrastructure with Kong Konnect. 1M requests per month for free.
Try it for Free
  • Kong
    THE CLOUD CONNECTIVITY COMPANY

    Kong powers reliable digital connections across APIs, hybrid and multi-cloud environments.

    • Company
    • Customers
    • Events
    • Investors
    • Careers Hiring!
    • Partners
    • Press
    • Contact
  • Products
    • Kong Konnect
    • Kong Gateway
    • Kong Mesh
    • Get Started
    • Pricing
  • Resources
    • eBooks
    • Webinars
    • Briefs
    • Blog
    • API Gateway
    • Microservices
  • Open Source
    • Install Kong Gateway
    • Kong Community
    • Kubernetes Ingress
    • Kuma
    • Insomnia
  • Solutions
    • Decentralize
    • Secure & Govern
    • Create a Dev Platform
    • API Gateway
    • Kubernetes
    • Service Mesh
Star
  • Terms•Privacy
© Kong Inc. 2023