You are browsing documentation for an outdated plugin version.
Configuration
This plugin is compatible with DB-less mode.
Compatible protocols
The Loggly 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:
-
string required
The name of the plugin, in this case
loggly
.- 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
.
- If using the Kong Admin API, Konnect API, declarative configuration, or decK files, the field is
-
string
An optional custom name to identify an instance of the plugin, for example
loggly_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)
-
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
. -
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
. -
string
The 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/{consumerName|Id}/plugins
. -
boolean default:
true
Whether this plugin will be applied.
-
record required
-
string default:
logs-01.loggly.com
The IP address or hostname of Loggly server.
-
integer default:
514
between:0
65535
The UDP port to send data to on the Loggly server.
-
string required referenceable encrypted
Loggly customer token.
-
set of type
string
default:kong
An optional list of tags to support segmentation and filtering of logs.
-
string default:
info
Must be one of:debug
,info
,notice
,warning
,err
,crit
,alert
,emerg
An optional logging severity, any request with equal or higher severity will be logged to Loggly. Available options:
debug
,info
,notice
,warning
,err
,crit
,alert
,emerg
.
-
string default:
info
Must be one of:debug
,info
,notice
,warning
,err
,crit
,alert
,emerg
An optional logging severity assigned to all the successful requests with a response status code 400. Available options:
debug
,info
,notice
,warning
,err
,crit
,alert
,emerg
.
-
string default:
info
Must be one of:debug
,info
,notice
,warning
,err
,crit
,alert
,emerg
An optional logging severity assigned to all the failed requests with a response status code 400 or higher but less than 500. Available options:
debug
,info
,notice
,warning
,err
,crit
,alert
,emerg
.
-
string default:
info
Must be one of:debug
,info
,notice
,warning
,err
,crit
,alert
,emerg
An optional logging severity assigned to all the failed requests with response status code 500 or higher. Available options:
debug
,info
,notice
,warning
,err
,crit
,alert
,emerg
.
-
number default:
10000
An optional timeout in milliseconds when sending data to the Loggly server.
-
map
A list of key-value pairs, where the key is the name of a log field and the value is a chunk of Lua code, whose return value sets or replaces the log field value.
-