IngestListener is a
datatype for ingest Listeners listen on a port for UDP or TCP
traffic, used with SysLog.
Table: IngestListener
| Parameter | Type | Required | Default | Stability | Description |
|---|---|---|---|---|---|
| Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column. | |||||
| Table last updated: Sep 25, 2024 | |||||
bindInterface | string | yes | Long-Term | The ip address this listener will bind to. By default (leaving this field empty) it will bind to 0.0.0.0 - all interfaces. Using this field it is also possible to specify the address to bind to. In a cluster setup it is also possible to specify if only one machine should open a socket - The vhost field is used for that. | |
charset | string | yes | Long-Term | The character set used to decode the event stream. Available character sets depend on the JVM running the LogScale instance. Names and aliases can be found at http://www.iana.org/assignments/character-sets/character-sets.xhtml | |
id | string | yes | Long-Term | The unique identifier for the ingest listener. | |
name | string | yes | Long-Term | The name of the ingest listener. | |
Parser | Parser | yes | Long-Term | The parser configured to parse data for the listener. It returns null if the parser has been removed since the listener was created. See Parser. | |
port | integer | yes | Long-Term | The TCP/UDP port on which to listen. | |
protocol | IngestListenerProtocol | yes | Long-Term | The network protocol data is sent through. See IngestListenerProtocol. | |
repository | Repository | yes | Long-Term | The repository associated with the ingest listener. See Repository. | |
vHost | integer | Long-Term | Specify which host should open the socket. By default this field is empty and all hosts will open a socket. This field can be used to select only one host to open the socket. | ||