Amberflo.io API Metering

Third Party

Configuration

configobject
Hide Child Parameters
apiKeystring

Your Amberflo API key.

batchSizenumber

The size at which to send the meter record batch.

Default:10

customerHeaderstring

The header to get the Amberflo customerId from.

dimensionHeadersobject

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

hostDimensionstring

The dimension name for the target URL host.

intervalSecondsnumber

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

Default:1

meterApiNamestring

The meter for metering the requests.

methodDimensionstring

The dimension name for the request method.

replacementsobject

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

Default:{ "/": ":" }

routeDimensionstring

The dimension name for the route name.

serviceDimensionstring

The dimension name for the service name.

protocolsarray[string]

A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.

Allowed values:httphttps

Default:http, https

routeobject

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

* Additional properties are NOT allowed.
Hide Child Parameters
idstring
serviceobject

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

* Additional properties are NOT allowed.
Hide Child Parameters
idstring

Did this doc help?

Something wrong?

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!