AppSentinels

Third Party

Configuration

configobject
Hide Child Parameters
authzboolean

Enable authz/enforcement mode

Default:false

authz_fail_allowboolean

Enable authz fail open for authz/enforcement mode

Default:true

authz_fail_msgstring

Custom authz fail message sent to client in authz/enforcement mode

Default:Unauthorized by Appsentinels

compress_logsboolean

Enable gzip compression for logs

Default:true

connect_timeoutnumber

HTTP Connect timeout to AppSentinels edge controller

Default:1000

console_error_supp_ratenumber

Console error logging suppression rate

Default:10

content_regexstring

Regular expression to match content type for logging

Default:(json|form|xml|graphql)

content_typestring

Content-Type for HTTP logging request to AppSentinels edge controllr

Allowed values:application/json

Default:application/json

early_payload_thresholdnumber

Payloads greater then this will be logged during access phase without holding in the memory

Default:32768

flush_timeoutnumber

Flush timeout for batched queue in seconds

Default:1

force_read_client_payloadboolean

Force read client payload to determine the size if content length isnt available in request headers

Default:false

http_endpointstringrequired

URL of AppSentinels edge controller

instance_namestring

Configure to identify Kong deployment instances

Default:NA

keepalivenumber

HTTP Keepalive timeout for connections to AppSentinels edge controller

Default:60000

log_timeoutnumber

Logging request timeout for response and transparent mode

Default:150

max_payloadnumber

Maximum payload size in bytes, beyond which payload wont be logged

Default:131072

methodstring

Method for HTTP logging request to AppSentinels edge controllr

Allowed values:PATCHPOSTPUT

Default:POST

no_self_signedboolean

Enable server (AppSentinels edge controller) cert verification

Default:false

normalize_factornumber

Normalize factor for shaper

Default:0

path_mergedlogstring

Set merged log path in transparent mode

Default:/mergedlog

path_requestlogstring

Set request log path in authz/enforcement mode

Default:/auth

path_responselogstring

Set response log path in authz/enforcement mode

Default:/nginxlog

path_statsstring

Set stats request path

Default:/nginxstats

queue_max_entriesinteger

Maximum number of entries in the batched queue

Default:10000

queue_numinteger

Number of batched queues

Default:5

queue_sizeinteger

Number of entries in the batched queue

Default:5

retry_countinteger

Number of retries for HTTP logging request in case of failure

Default:0

shaper_basenumber

Base for shaper steps, in number of logs

Default:3

shaper_fallback_ratenumber

Shaper fallback rate in case of failures

Default:1.25

shaper_idle_timeoutnumber

Shaper idle timeout in milliseconds

Default:60000

shaper_max_stagesnumber

Maximum number of stages in shaper algorithm

Default:180

shaper_multipliernumber

Multiplier for shaper steps

Default:1

shaper_step_durationnumber

Duration of each shaper step in milliseconds

Default:1000

shaper_typestring

Shaping algorithm to use

Default:linear

stats_send_timeoutnumber

Stats send timeout in milliseconds

Default:4000

stats_timeoutnumber

Stats message frequency in seconds to AppSentinels edge controller

Default:5

timeoutnumber

Authz request timeout

Default:100

traceboolean

Enable plugin logging on console

Default:false

unhealthy_thresholdinteger

Number of failures to consider before declaring connection to AppSentinels edge controller as unhealthy

Default:3

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
consumer_groupobject

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

* Additional properties are NOT allowed.
Hide Child Parameters
idstring
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!