Skip to content
|
search
Plugin Hub
header icon

Amberflo.io API Metering

This plugin allows you to understand customer API usage and implement usage-based price & billing by metering the requests with Amberflo.io.

It supports high-volume HTTP(S) usage without adding latency.

Amberflo is the simplest way to integrate metering into your application. Sign up for free to get started.

How it works

This plugin intercepts the requests, detects which customer is making it, generates a meter event and sends it to Amberflo.

Customer detection occurs via inspection of the request headers. You can configure Kong Gateway to inject the customerId as a header before this plugin runs. For example, if you use the Key Authentication plugin, this occurs automatically.

To avoid impacting the performance of your gateway, the plugin batches the meter records and sends them asynchronously to Amberflo.

Installation

This is a server plugin implemented in Go. You only need to make the binary available to Kong Gateway:

GOBIN=/tmp go install github.com/amberflo/kong-plugin-amberflo@latest
mv /tmp/kong-plugin-amberflo /usr/local/bin/amberflo

Then, register the plugin in your kong.conf file:

plugins = bundled,amberflo

pluginserver_names = amberflo

pluginserver_amberflo_start_cmd = /usr/local/bin/amberflo
pluginserver_amberflo_query_cmd = /usr/local/bin/amberflo -dump

Finally, restart Kong Gateway:

kong restart

Configuration Reference

This plugin is compatible with DB-less mode.

In DB-less mode, you configure Kong Gateway declaratively. Therefore, the Admin API is mostly read-only. The only tasks it can perform are all related to handling the declarative config, including:

  • Setting a target's health status in the load balancer
  • Validating configurations against schemas
  • Uploading the declarative configuration using the /config endpoint

The plugin is compatible with any with DB-less mode, including local, cluster, and redis.

Example plugin configuration

The following examples provide some typical configurations for enabling the amberflo plugin on a service.

Make the following request:

curl -X POST http://localhost:8001/services/SERVICE_NAME|SERVICE_ID/plugins \
    --data "name=amberflo"

Replace SERVICE_NAME|SERVICE_ID with the id or name of the service that this plugin configuration will target.

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: amberflo-example
config:
  EXAMPLE_PARAMETER: EXAMPLE_VALUE
plugin: amberflo

Next, apply the KongPlugin resource to a service by annotating the service as follows:

apiVersion: v1
kind: Service
metadata:
  name: SERVICE_NAME|SERVICE_ID
  labels:
    app: SERVICE_NAME|SERVICE_ID
  annotations:
    konghq.com/plugins: amberflo-example
spec:
  ports:
  - port: 80
    targetPort: 80
    protocol: TCP
    name: SERVICE_NAME|SERVICE_ID
  selector:
    app: SERVICE_NAME|SERVICE_ID

Replace SERVICE_NAME|SERVICE_ID with the id or name of the service that this plugin configuration will target.

Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

Add this section to your declarative configuration file:

plugins:
- name: amberflo
  service: SERVICE_NAME|SERVICE_ID
  config:
    EXAMPLE_PARAMETER: EXAMPLE_VALUE

Replace SERVICE_NAME|SERVICE_ID with the id or name of the service that this plugin configuration will target.

The following examples provide some typical configurations for enabling the amberflo plugin on a route.

Make the following request:

curl -X POST http://localhost:8001/routes/ROUTE_NAME|ROUTE_ID/plugins \
  --data "name=amberflo"

Replace ROUTE_NAME|ROUTE_ID with the id or name of the route that this plugin configuration will target.

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: amberflo-example
config:
  EXAMPLE_PARAMETER: EXAMPLE_VALUE
plugin: amberflo

Then, apply it to an ingress (route or routes) by annotating the ingress as follows:

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: ROUTE_NAME|ROUTE_ID
  annotations:
    kubernetes.io/ingress.class: kong
    konghq.com/plugins: amberflo-example
spec:
  rules:
  - host: examplehostname.com
    http:
      paths:
      - path: /bar
        backend:
          service:
            name: echo
            port:
              number: 80

Replace ROUTE_NAME|ROUTE_ID with the id or name of the route that this plugin configuration will target.

Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

Add this section to your declarative configuration file:

plugins:
- name: amberflo
  route: ROUTE_NAME
  config:
    EXAMPLE_PARAMETER: EXAMPLE_VALUE

Replace ROUTE_NAME|ROUTE_ID with the id or name of the route that this plugin configuration will target.

A plugin which is not associated to any service, route, or consumer is considered global, and will be run on every request. Read the Plugin Reference and the Plugin Precedence sections for more information.

The following examples provide some typical configurations for enabling the amberflo plugin globally.

Make the following request:

curl -X POST http://localhost:8001/plugins/ \
  --data "name=amberflo"

Create a KongClusterPlugin resource and label it as global:

apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: <global-amberflo>
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: \"true\"
config:
  <optional_parameter>: <value>
plugin: amberflo

Add a plugins entry in the declarative configuration file:

plugins:
- name: amberflo
  config:
    EXAMPLE_PARAMETER: EXAMPLE_VALUE

Parameters

Here's a list of all the parameters which can be used in this plugin's configuration:

Form Parameter Description
name

required

Type: string

 The name of the plugin, in this case amberflo.
service.name or service.id

optional

Type: string

The name or ID of the service the plugin targets.

Set one of these parameters if adding the plugin to a service through the top-level /plugins endpoint.

Not required if using /services/SERVICE_NAME|SERVICE_ID/plugins.
route.name or route.id

optional

Type: string

The name or ID of the route the plugin targets.

Set one of these parameters if adding the plugin to a route through the top-level /plugins endpoint.

Not required if using /routes/ROUTE_NAME|ROUTE_ID/plugins.
enabled

optional

Type: boolean

Default value: true

 Whether this plugin will be applied.
config.apiKey

required

Your Amberflo API key.
config.meterApiName

required

The meter for metering the requests.
config.customerHeader

required

The header to get the Amberflo customerId from.
config.intervalSeconds

optional

Default value: 1


The rate (in seconds) at which to send the meter record batch.
config.batchSize

optional

Default value: 10


The size at which to send the meter record batch.
config.methodDimension

optional

The dimension name for the request method.
config.hostDimension

optional

The dimension name for the target URL host.
config.routeDimension

optional

The dimension name for the route name.
config.serviceDimension

optional

The dimension name for the service name.
config.dimensionHeaders

optional

The map of “dimension name” to “header name”, for inclusion in the meter record.
config.replacements

optional

Default value: {"/": ":"}


The map of “old” to “new” values for transforming dimension values.