HTTP Log

Overview Examples Configuration reference Changelog

Configuration

configobjectrequired

Hide Child Parameters

content_typestring

Indicates the type of data sent. The only available option is application/json.

Allowed values:application/jsonapplication/json; charset=utf-8

Default:application/json

custom_fields_by_luaobject

Lua code as a key-value map

* Additional properties are allowed.

flush_timeoutnumber

Optional time in seconds. If queue_size > 1, this is the max idle time before sending a log with less than queue_size records.

headersobject

An optional table of headers included in the HTTP message to the upstream server. Values are indexed by header name, and each header name accepts a single string.

* Additional properties are allowed.

http_endpointstringrequired

A string representing a URL, such as https://example.com/path/to/resource?q=search.
This field is encrypted.
This field is referenceable.

keepalivenumber

An optional value in milliseconds that defines how long an idle connection will live before being closed.

Default:60000

methodstring

An optional method used to send data to the HTTP server. Supported values are POST (default), PUT, and PATCH.

Allowed values:PATCHPOSTPUT

Default:POST

queueobject

Hide Child Parameters

concurrency_limitinteger

The number of of queue delivery timers. -1 indicates unlimited.

Allowed values:-11

Default:1

initial_retry_delaynumber

Time in seconds before the initial retry is made for a failing batch.

Default:0.01

>= 0.001<= 1000000

max_batch_sizeinteger

Maximum number of entries that can be processed at a time.

Default:1

>= 1<= 1000000

max_bytesinteger

Maximum number of bytes that can be waiting on a queue, requires string content.

max_coalescing_delaynumber

Maximum number of (fractional) seconds to elapse after the first entry was queued before the queue starts calling the handler.

Default:1

>= 0<= 3600

max_entriesinteger

Maximum number of entries that can be waiting on the queue.

Default:10000

>= 1<= 1000000

max_retry_delaynumber

Maximum time in seconds between retries, caps exponential backoff.

Default:60

>= 0.001<= 1000000

max_retry_timenumber

Time in seconds before the queue gives up calling a failed handler for a batch.

Default:60

queue_sizeinteger

Maximum number of log entries to be sent on each message to the upstream server.

retry_countinteger

Number of times to retry when sending data to the upstream server.

timeoutnumber

An optional timeout in milliseconds when sending data to the upstream server.

Default:10000

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

HTTP Log

Configuration

Did this doc help?

Help us make these docs great!

Still need help