Sending messages over HTTP 🔗︎
Overview 🔗︎
More info at https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/40#TOPIC-1829058
Configuration 🔗︎
HTTPOutput 🔗︎
url (string, optional) 🔗︎
Specifies the hostname or IP address and optionally the port number of the web service that can receive log data via HTTP. Use a colon (:) after the address to specify the port number of the server. For example: http://127.0.0.1:8000
Default: -
headers ([]string, optional) 🔗︎
Custom HTTP headers to include in the request, for example, headers(“HEADER1: header1”, “HEADER2: header2”).
Default: empty
time_reopen (int, optional) 🔗︎
The time to wait in seconds before a dead connection is reestablished.
Default: 60
tls (*TLS, optional) 🔗︎
This option sets various options related to TLS encryption, for example, key/certificate files and trusted CA locations. TLS can be used only with tcp-based transport protocols. For details, see TLS for syslog-ng outputs and the syslog-ng documentation.
Default: -
disk_buffer (*DiskBuffer, optional) 🔗︎
This option enables putting outgoing messages into the disk buffer of the destination to avoid message loss in case of a system failure on the destination side. For details, see the Syslog-ng DiskBuffer options.
Default: false
(Batch, required) 🔗︎
Batching parameters
Default: -
body (string, optional) 🔗︎
The body of the HTTP request, for example, body(“${ISODATE} ${MESSAGE}"). You can use strings, macros, and template functions in the body. If not set, it will contain the message received from the source by default.
Default: -
body-prefix (string, optional) 🔗︎
The string syslog-ng OSE puts at the beginning of the body of the HTTP request, before the log message.
Default: -
body-suffix (string, optional) 🔗︎
The string syslog-ng OSE puts to the end of the body of the HTTP request, after the log message.
Default: -
delimiter (string, optional) 🔗︎
By default, syslog-ng OSE separates the log messages of the batch with a newline character.
Default: -
method (string, optional) 🔗︎
Specifies the HTTP method to use when sending the message to the server. POST | PUT
Default: -
retries (int, optional) 🔗︎
The number of times syslog-ng OSE attempts to send a message to this destination. If syslog-ng OSE could not send a message, it will try again until the number of attempts reaches retries, then drops the message.
Default: -
user (string, optional) 🔗︎
The username that syslog-ng OSE uses to authenticate on the server where it sends the messages.
Default: -
password (secret.Secret, optional) 🔗︎
The password that syslog-ng OSE uses to authenticate on the server where it sends the messages.
Default: -
user-agent (string, optional) 🔗︎
The value of the USER-AGENT header in the messages sent to the server.
Default: -
workers (int, optional) 🔗︎
Description: Specifies the number of worker threads (at least 1) that syslog-ng OSE uses to send messages to the server. Increasing the number of worker threads can drastically improve the performance of the destination.
Default: -
persist_name (string, optional) 🔗︎
Default: -
Batch 🔗︎
batch-lines (int, optional) 🔗︎
Description: Specifies how many lines are flushed to a destination in one batch. The syslog-ng OSE application waits for this number of lines to accumulate and sends them off in a single batch. Increasing this number increases throughput as more messages are sent in a single batch, but also increases message latency. For example, if you set batch-lines() to 100, syslog-ng OSE waits for 100 messages.
Default: -
batch-bytes (int, optional) 🔗︎
Description: Sets the maximum size of payload in a batch. If the size of the messages reaches this value, syslog-ng OSE sends the batch to the destination even if the number of messages is less than the value of the batch-lines() option. Note that if the batch-timeout() option is enabled and the queue becomes empty, syslog-ng OSE flushes the messages only if batch-timeout() expires, or the batch reaches the limit set in batch-bytes().
Default: -
batch-timeout (int, optional) 🔗︎
Description: Specifies the time syslog-ng OSE waits for lines to accumulate in the output buffer. The syslog-ng OSE application sends batches to the destinations evenly. The timer starts when the first message arrives to the buffer, so if only few messages arrive, syslog-ng OSE sends messages to the destination at most once every batch-timeout() milliseconds.
Default: -
