Configuration

configobject
Hide Child Parameters
client_errors_severitystring

Allowed values:alertcritdebugemergerrinfonoticewarning

Default:info

custom_fields_by_luaobject

Lua code as a key-value map

* Additional properties are allowed.
facilitystring

The facility is used by the operating system to decide how to handle each log message.

Allowed values:authauthprivcrondaemonftpkernlocal0local1local2local3local4local5local6local7lprmailnewssysloguseruucp

Default:user

log_levelstring

Allowed values:alertcritdebugemergerrinfonoticewarning

Default:info

server_errors_severitystring

Allowed values:alertcritdebugemergerrinfonoticewarning

Default:info

successful_severitystring

Allowed values:alertcritdebugemergerrinfonoticewarning

Default:info

consumerobject

If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.

* Additional properties are NOT allowed.
Hide Child Parameters
idstring
protocolsarray[string]

A string representing a protocol, such as HTTP or HTTPS.

Allowed values:grpcgrpcshttphttpstcptlstls_passthroughudpwswss

Default:grpc, grpcs, 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!