Configuration
This plugin is compatible with DB-less mode.
Compatible protocols
The UDP Log plugin is compatible with the following protocols:
grpc
, grpcs
, http
, https
, tcp
, tls
, tls_passthrough
, udp
, ws
, wss
Parameters
Here's a list of all the parameters which can be used in this plugin's configuration:
-
name
string requiredThe name of the plugin, in this case
udp-log
. -
instance_name
stringAn optional custom name to identify an instance of the plugin, for example
udp-log_my-service
. Useful when running the same plugin in multiple contexts, for example, on multiple services. -
service.name or service.id
stringThe 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|ID/plugins
. -
route.name or route.id
stringThe 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|ID/plugins
. -
consumer.name or consumer.id
stringThe name or ID of the consumer the plugin targets. Set one of these parameters if adding the plugin to a consumer through the top-level
/plugins
endpoint. Not required if using/consumers/CONSUMER_NAME|ID/plugins
. -
enabled
boolean default:true
Whether this plugin will be applied.
-
config
record required-
host
string requiredA string representing a host name, such as example.com.
-
port
integer required between:0
65535
An integer representing a port number between 0 and 65535, inclusive.
-
timeout
number default:10000
An optional timeout in milliseconds when sending data to the upstream server.
-
custom_fields_by_lua
mapLua code as a key-value map
-