|
| 1 | +--- |
| 2 | +title: syslog-ng-otlp() source options |
| 3 | +id: adm-src-otlp-opt |
| 4 | +--- |
| 5 | + |
| 6 | +The following options are available for the `syslog-ng-otlp()` source. |
| 7 | + |
| 8 | +## auth() |
| 9 | + |
| 10 | +The `auth()` option can be used to set the authentication of the driver. The default state of this option is `insecure`, as it is not defined. |
| 11 | + |
| 12 | +The following sub-options are available for `auth()`. |
| 13 | + |
| 14 | +### adc() |
| 15 | + |
| 16 | +This option is an authentication method that is only available for destinations. For more information, see Application Default Credentials. |
| 17 | + |
| 18 | +### alts() |
| 19 | + |
| 20 | +This option is an accessible authentication available for Google infrastructures. Service accounts can be listed with the nested `target-service-account()` option, to match these against the server. |
| 21 | + |
| 22 | +#### Example: configure an syslog-ng-otlp() source using auth(alts()) |
| 23 | + |
| 24 | +```config |
| 25 | +source { |
| 26 | + syslog-ng-otlp( |
| 27 | + port(4317) |
| 28 | + auth(alts()) |
| 29 | + ); |
| 30 | + }; |
| 31 | +
|
| 32 | +``` |
| 33 | + |
| 34 | +### insecure() |
| 35 | + |
| 36 | +This option can be used to disable authentication: `auth(insecure())`. |
| 37 | + |
| 38 | +### tls() |
| 39 | + |
| 40 | +The `tls()` option accepts the following nested sub-options. |
| 41 | +* ca-file() |
| 42 | +* key-file() |
| 43 | +* cert-file() |
| 44 | +* peer-verify() |
| 45 | + * required-trusted |
| 46 | + * required-untrusted |
| 47 | + * optional-trusted |
| 48 | + * optional-untrusted |
| 49 | + |
| 50 | +#### Example: configure an syslog-ng-otlp() source using auth(tls()) |
| 51 | + |
| 52 | +```config |
| 53 | +destination { |
| 54 | + syslog-ng-otlp( |
| 55 | + url("your-otel-server:12346") |
| 56 | + auth( |
| 57 | + tls( |
| 58 | + ca-file("/path/to/ca.pem") |
| 59 | + key-file("/path/to/key.pem") |
| 60 | + cert-file("/path/to/cert.pem") |
| 61 | + ) |
| 62 | + ) |
| 63 | + ); |
| 64 | + }; |
| 65 | +``` |
| 66 | + |
| 67 | +## chain-hostname() |
| 68 | + |
| 69 | +| Type:| `yes`, `no`| |
| 70 | +|Default:| `no`| |
| 71 | + |
| 72 | +*Description:* This option can be used to enable or disable the chained hostname format. For more information, see the chain-hostnames() global option. |
| 73 | + |
| 74 | +{% include doc/admin-guide/options/channel-args.md %} |
| 75 | + |
| 76 | +## concurrent-requests() |
| 77 | + |
| 78 | +| Type:| integer| |
| 79 | +|Default:| 2| |
| 80 | + |
| 81 | +*Description:* This option configures the upper limit of in-flight gRPC requests per worker. It is advisd to set this value in the range of 10s or 100s when there are a high number of clients sending simultaneously. In an optimized solution, the number of `workers()` and `concurrent-requests()` is greater than or equal to the number of clients. However, this can cause an increase in memory usage. |
| 82 | + |
| 83 | +## default-facility() |
| 84 | + |
| 85 | +| Type:| facility string| |
| 86 | +|Default:| kern| |
| 87 | + |
| 88 | +*Description:* This option assigns a facility value to messages received from the file source if the message does not specify one. |
| 89 | + |
| 90 | +## default-level() |
| 91 | + |
| 92 | +| Type:| string| |
| 93 | +|Default:| notice| |
| 94 | + |
| 95 | +*Description:* This option defines the default level value if the `PRIORITY` entry does not exist. |
| 96 | + |
| 97 | +{% include doc/admin-guide/options/default-priority.md %} |
| 98 | + |
| 99 | +## dns-cache() |
| 100 | + |
| 101 | +| Type:| `yes`, `no`| |
| 102 | +|Default:| `no`| |
| 103 | + |
| 104 | +*Description:* This option enables or disables the DNS cache usage. |
| 105 | + |
| 106 | +## ebpf() |
| 107 | + |
| 108 | +Available in syslog-ng OSE 4.2 and later versions. |
| 109 | + |
| 110 | +If this option is not used, the kernel chooses the receive socket for a specific UDP randomly based on the source IP/port of the sender. It is possible to customize this algorithm using the Extended Berkeley Packet Filter (eBPF) plugin. The `ebpf()` option changes the `SO_REUSEPORT` algorithm of the kernel, to place messages randomly into one of the UDP sockets. The decision which UDP socket buffer a datagram is placed is made for every datagram, and not once for every stream. This results in the percet load-balancing of messages across the set of UDP sockets. While this resolves the imbalance between the sockets and results in perfect load balancing, the order of messages from the same sender is lost, which is the drawback of increased throughput. |
| 111 | + |
| 112 | +### Example: Configure a syslog-ng-otlp() source with ebpf() |
| 113 | + |
| 114 | +```config |
| 115 | +source { |
| 116 | + syslog-ng-otlp( |
| 117 | + udp(so-reuseport(yes) port(2000) persist-name("udp1") |
| 118 | + ebpf(reuseport(sockets(4)))); |
| 119 | + udp(so-reuseport(yes) port(2000) persist-name("udp2")); |
| 120 | + udp(so-reuseport(yes) port(2000) persist-name("udp3")); |
| 121 | + udp(so-reuseport(yes) port(2000) persist-name("udp4")); |
| 122 | + ); |
| 123 | +}; |
| 124 | +``` |
| 125 | + |
| 126 | +{% include doc/admin-guide/options/flags.md %} |
| 127 | + |
| 128 | +{% include doc/admin-guide/options/host-override.md %} |
| 129 | + |
| 130 | +{% include doc/admin-guide/options/keep-hostname.md %} |
| 131 | + |
| 132 | +{% include doc/admin-guide/options/keep-timestamp.md %} |
| 133 | + |
| 134 | +{% include doc/admin-guide/options/log-fetch-limit.md %} |
| 135 | + |
| 136 | +{% include doc/admin-guide/options/log-iw-size.md %} |
| 137 | + |
| 138 | +{% include doc/admin-guide/options/log-prefix.md %} |
| 139 | + |
| 140 | +## normalize-hostnames() |
| 141 | + |
| 142 | +| Type:| `yes`, `no`| |
| 143 | +|Default:| `no`| |
| 144 | + |
| 145 | +*Description:* If this option is set to `yes` (`normalize-hostnames(yes)`), syslog-ng OSE converts the hostnames to lowercase. This setting only applies to hostnames resolved from DNS. It has no effect if the `keep-hostname()` option is enabled, and the message contains a hostname. |
| 146 | + |
| 147 | +{% include doc/admin-guide/options/persist-name.md %} |
| 148 | + |
| 149 | +{% include doc/admin-guide/options/port.md %} |
| 150 | + |
| 151 | +{% include doc/admin-guide/options/program-override.md %} |
| 152 | + |
| 153 | +{% include doc/admin-guide/options/tags.md %} |
| 154 | + |
| 155 | +{% include doc/admin-guide/options/time-zone.md %} |
| 156 | + |
| 157 | +{% include doc/admin-guide/options/time-reopen.md %} |
| 158 | + |
| 159 | +{% include doc/admin-guide/options/use-dns.md %} |
| 160 | + |
| 161 | +{% include doc/admin-guide/options/use-fqdn.md %} |
| 162 | + |
| 163 | +{% include doc/admin-guide/options/workers.md %} |
0 commit comments