Amberflo.io API Metering Configuration

Configuration

This plugin is compatible with DB-less mode.

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

Compatible protocols

The Amberflo.io API Metering plugin is compatible with the following protocols:

http, https

Parameters

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

• name or plugin

  string required

  The name of the plugin, in this case kong-plugin-amberflo.

  • If using the Kong Admin API, Konnect API, declarative configuration, or decK files, the field is name.
  • If using the KongPlugin object in Kubernetes, the field is plugin.

• instance_name

  string

  An optional custom name to identify an instance of the plugin, for example kong-plugin-amberflo_my-service.

  The instance name shows up in Kong Manager and in Konnect, so it's useful when running the same plugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance via the Kong Admin API.

  An instance name must be unique within the following context:

  • Within a workspace for Kong Gateway Enterprise
  • Within a control plane or control plane group for Konnect
  • Globally for Kong Gateway (OSS)

• service.name or service.id

  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/{serviceName|Id}/plugins.

• route.name or route.id

  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/{routeName|Id}/plugins.

• enabled

  boolean default: true

  Whether this plugin will be applied.

• config

  record required
  • apiKey

    string required

    Your Amberflo API key.

  • meterApiName

    string required

    The meter for metering the requests.

  • customerHeader

    string required

    The header to get the Amberflo customerId from.

  • intervalSeconds

    number default: 1

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

  • batchSize

    number default: 10

    The size at which to send the meter record batch.

  • methodDimension

    string

    The dimension name for the request method.

  • hostDimension

    string

    The dimension name for the target URL host.

  • routeDimension

    string

    The dimension name for the route name.

  • serviceDimension

    string

    The dimension name for the service name.

  • dimensionHeaders

    map

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

  • replacements

    map default: { "/": ":" }

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