Skip to content

Latest commit

 

History

History

syslogexporter

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
examples
examples
 
 
internal/metadata
internal/metadata
 
 
Makefile
Makefile
 
 
README.md
README.md
 
 
config.go
config.go
 
 
config_test.go
config_test.go
 
 
doc.go
doc.go
 
 
exporter.go
exporter.go
 
 
exporter_test.go
exporter_test.go
 
 
factory.go
factory.go
 
 
factory_test.go
factory_test.go
 
 
go.mod
go.mod
 
 
go.sum
go.sum
 
 
metadata.yaml
metadata.yaml
 
 
sender.go
sender.go
 
 
sender_test.go
sender_test.go
 
 
utils.go
utils.go
 
 
utils_test.go
utils_test.go
 
 

README.md

Syslog Exporter

Status
Stability development: logs
Distributions []

The syslog exporter supports sending messages to a remote syslog server.

  • This exporter can forward syslog messages to syslog server using RFC5424 and RFC3164.
  • It is recommended that this syslog exporter be used with the syslog receiver or with filelog receiver along with syslog_parser configured in the receiver, please see examples This ensures that all the syslog message headers are populated with the expected values.
  • Not using the syslog_parser will result in the syslog message being populated with default header values.

Configuration

The following configuration options are available:

  • endpoint - (required) syslog endpoint
  • network - (default = tcp) tcp/udp
  • port - (default = 514) A syslog port
  • protocol - (default = rfc5424) rfc5424/rfc3164
    • rfc5424 - Expects the syslog messages to be rfc5424 compliant
    • rfc3164 - Expects the syslog messages to be rfc3164 compliant
  • tls - configuration for TLS/mTLS
    • insecure (default = false) whether to enable client transport security, by default, TLS is enabled.
    • cert_file - Path to the TLS cert to use for TLS required connections. Should only be used if insecure is set to false.
    • key_file - Path to the TLS key to use for TLS required connections. Should only be used if insecure is set to false.
    • ca_file - Path to the CA cert. For a client this verifies the server certificate. For a server this verifies client certificates. If empty uses system root CA. Should only be used if insecure is set to false.
    • insecure_skip_verify - (default = false) whether to skip verifying the certificate or not.
    • min_version (default = 1.2) Minimum acceptable TLS version
    • max_version (default = "" handled by crypto/tls - currently TLS 1.3) Maximum acceptable TLS version.
    • reload_interval - Specifies the duration after which the certificate will be reloaded. If not set, it will never be reloaded.
  • retry_on_failure
    • enabled (default = true)
    • initial_interval (default = 5s): Time to wait after the first failure before retrying; ignored if enabled is false
    • max_interval (default = 30s): Is the upper bound on backoff; ignored if enabled is false
    • max_elapsed_time (default = 120s): Is the maximum amount of time spent trying to send a batch; ignored if enabled is false
  • sending_queue
    • enabled (default = false)
    • num_consumers (default = 10): Number of consumers that dequeue batches; ignored if enabled is false
    • queue_size (default = 5000): Maximum number of batches kept in memory before data; ignored if enabled is false; User should calculate this as num_seconds * requests_per_second where:
      • num_seconds is the number of seconds to buffer in case of a backend outage
      • requests_per_second is the average number of requests per seconds.
    • storage (default = none): When set, enables persistence and uses the component specified as a storage extension for the persistent queue
  • timeout (default = 5s) Time to wait per individual attempt to send data to a backend

Please see example configurations.