Skip to content

Commit 05882eb

Browse files
authored
Merge branch 'master' into s3_fixes
2 parents 8fcb598 + ad1fd20 commit 05882eb

File tree

10 files changed

+92
-40
lines changed

10 files changed

+92
-40
lines changed

_data/external_links.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -608,6 +608,11 @@ gh-es:
608608
url: https://github.com/syslog-ng/syslog-ng/tree/master/scl/elasticsearch
609609
title: [ "Elasticsearch configuration snippet on GitHub" ]
610610

611+
gh-es-ds:
612+
id: gh-es-ds
613+
url: https://github.com/syslog-ng/syslog-ng/blob/master/scl/elasticsearch/elastic-datastream.conf
614+
title: [ "Elasticsearch datastream configuration snippet on GitHub" ]
615+
611616
gh-fortigate:
612617
id: gh-fortigate
613618
url: https://github.com/syslog-ng/syslog-ng/blob/master/scl/fortigate/fortigate.conf
@@ -796,6 +801,11 @@ ebpf:
796801
url: https://ebpf.io/
797802
title: [ "Extended Berkeley Packet Filter" ]
798803

804+
elastic-ds:
805+
id: elastic-ds
806+
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html
807+
title: [ "Elasticsearch data streams" ]
808+
799809
gcp-ser:
800810
id: gcp-ser
801811
url: https://cloud.google.com/iam/docs/service-account-overview

doc/_admin-guide/060_Sources/102_OpenTelemetry/000_opentelemetry_source_options.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,10 @@ destination {
7171

7272
*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 optimzed 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.
7373

74+
## keep-hostname()
75+
76+
The `syslog-ng-otlp()` and `opentelemetry()` sources ignore this option and use the hostname from the message as the `${HOST}`.
77+
7478
## log-fetch-limit()
7579

7680
| Type:| number|

doc/_admin-guide/060_Sources/175_syslog-otlp/000_otlp_source_options.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,9 @@ source {
129129

130130
{% include doc/admin-guide/options/host-override.md %}
131131

132-
{% include doc/admin-guide/options/keep-hostname.md %}
132+
## keep-hostname()
133+
134+
The `syslog-ng-otlp()` and `opentelemetry()` sources ignore this option and use the hostname from the message as the `${HOST}`.
133135

134136
{% include doc/admin-guide/options/keep-timestamp.md %}
135137

doc/_admin-guide/060_Sources/180_System/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,10 @@ such messages without losing any information to CIM-aware applications
5050
| | Note that on Linux, the so-rcvbuf() option of the system() source is automatically set to 8192. |
5151
| | If the host is running under systemd, {{ site.product.short_name }} reads directly from the systemd journal file using the systemd-journal() source. |
5252
| | If the kernel of the host is version 3.5 or newer, and /dev/kmsg is seekable, {{ site.product.short_name }} will use that instead of /proc/kmsg, using the multi-line-mode(indented), keep-timestamp(no), and the format(linux-kmsg)options. |
53-
| | If {{ site.product.short_name }} is running in a jail or a Linux Container (LXC), it will not read from the /dev/kmsg or /proc/kmsg files. |
53+
| |If {{ site.product.short_name }} is running in a jail or a Linux Container (LXC), it will not read from the `/dev/kmsg` or `/proc/kmsg` files.
54+
| |With systemd: `systemd-journal();`
55+
| |Without systemd, on kernel 3.5 or newer: `unix-dgram("/dev/log"); file("/dev/kmsg" program-override("kernel") flags(kernel) format("linux-kmsg") keep-timestamp(no));`
56+
| |Without systemd, on kernels older than 3.5: `unix-dgram("/dev/log"); file("/proc/kmsg" program-override("kernel") flags(kernel) keep-timestamp(no));`
5457
| macOS | file("/var/log/system.log" follow-freq(1)); |
5558
| | **NOTE:** Starting with version 3.7, the {{ site.product.short_name }} system() driver automatically extracts the msgid from the message (if available), and stores it in the .solaris.msgid macro. To extract the msgid from the message without using the system()driver, use the **extract-solaris-msgid()** parser. You can find the exact source of the Solaris parser on GitHub.|
5659
| NetBSD | unix-dgram("/var/run/log"); |

doc/_admin-guide/060_Sources/220_unix-stream_unix-dgram/README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,9 @@ short_title: unix-stream, unix-dgram
44
id: adm-src-unix
55
description: >-
66
The unix-stream() and unix-dgram() drivers open an AF_UNIX socket and
7-
start listening on it for messages. The unix-stream() driver is
8-
primarily used on Linux and uses SOCK_STREAM semantics (connection
9-
oriented, no messages are lost), while unix-dgram() is used on BSDs and
10-
uses SOCK_DGRAM semantics: this may result in lost local messages if
7+
start listening on it for messages. On Linux both the unix-stream() and unix-dgram() drivers are used and are always reliable. The unix-stream() driver uses SOCK_STREAM semantics (connection
8+
oriented, no messages are lost),
9+
while unix-dgram() is used on BSDs and uses SOCK_DGRAM semantics: this may result in lost local messages if
1110
the system is overloaded.
1211
---
1312

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: 'elasticsearch-datastream: Elasticsearch data streams'
3+
short_title: elasticsearch-datastream
4+
id: adm-dest-es-datastream
5+
description: >-
6+
From {{ site.product.short_name }} 4.8 and later versions, you can send messages and metrics to Elasticsearch data streams to store your log and metrics data as time series data.
7+
---
8+
9+
**Declaration**
10+
11+
```config
12+
destination d_elastic_data_stream {
13+
elasticsearch-datastream(
14+
url("https://elastic-endpoint:9200/my-data-stream/_bulk")
15+
user("elastic")
16+
password("ba253DOn434Tc0pY22OI")
17+
);
18+
};
19+
```
20+
21+
This driver is a reusable configuration snippet configured to send log messages using the http() driver using a template. You can find the Elasticsearch datastream configuration snippet on GitHub.
22+
23+
## Prerequisites
24+
25+
* An account for Elasticsearch datastreams with a username and a password.
26+
27+
## Options
28+
29+
Elasticsearch datastream is an HTTP based driver, hence it utilizes the HTTP destination options.
30+
31+
> *Copyright © 2024 Axoflow*

doc/_admin-guide/100_TLS-encrypted_message_transfer/002_Mutual_authentication_using_TLS/000_Configuring_mutual_TLS_client.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,28 +17,28 @@ syslog() driver):
1717
1. Create an X.509 certificate for the {{ site.product.short_name }} client.
1818

1919
2. Copy the certificate (for example, client_cert.pem) and the
20-
matching private key (for example, client.key) to the syslog-ng
20+
matching private key (for example, client.key) to the {{ site.product.short_name }}
2121
client host, for example, into the
2222
/opt/syslog-ng/etc/syslog-ng/cert.d directory. The certificate must
23-
be a valid X.509 certificate in PEM format. If you want to use a
24-
password-protected key, see
25-
Password-protected keys.
23+
be a valid X.509 certificate in PEM format. The key must be in PEM format.
24+
If you want to use a password-protected key, see Password-protected keys.
2625

27-
3. Copy the CA certificate of the Certificate Authority (for example,
28-
cacert.pem) that issued the certificate of the {{ site.product.short_name }} server (or
29-
the self-signed certificate of the {{ site.product.short_name }} server) to the
30-
{{ site.product.short_name }} client hosts, for example, into the
26+
3. Copy the CA certificate (for example, cacert.pem) of the Certificate
27+
Authority that issued the certificate of the {{ site.product.short_name }} server
28+
(or the self-signed certificate of the {{ site.product.short_name }} server) to the
29+
{{ site.product.short_name }} client host, for example, into the
3130
/opt/syslog-ng/etc/syslog-ng/ca.d directory.
3231

33-
Issue the following command on the certificate: **openssl x509
34-
-noout -hash -in cacert.pem** The result is a hash (for example,
32+
If you wish to use the ca-dir() option, instead of the ca-file(), in the
33+
{{ site.product.short_name }} configuration file (step 4.) then
34+
- issue the following command on the certificate:\
35+
`openssl x509 -noout -hash -in cacert.pem`\
36+
The result is a hash (for example,
3537
6d2962a8), a series of alphanumeric characters based on the
3638
Distinguished Name of the certificate.
37-
38-
Issue the following command to create a symbolic link to the
39+
- issue the following command to create a symbolic link to the
3940
certificate that uses the hash returned by the previous command and
40-
the **.0** suffix.
41-
41+
the **.0** suffix:\
4242
`ln -s cacert.pem 6d2962a8.0`
4343

4444
4. Add a destination statement to the {{ site.product.short_name }} configuration file that
@@ -49,6 +49,9 @@ syslog() driver):
4949
Include the client\'s certificate and private key in the tls()
5050
options.
5151

52+
For the details of the available tls() options, see
53+
TLS options.
54+
5255
Example: A destination statement using mutual authentication
5356

5457
The following destination encrypts the log messages using TLS and

doc/_admin-guide/100_TLS-encrypted_message_transfer/002_Mutual_authentication_using_TLS/001_Configuring_mutual_TLS_server.md

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -11,38 +11,37 @@ Complete the following steps on the {{ site.product.short_name }} server:
1111

1212
## Steps
1313

14-
1. Copy the certificate (for example, syslog-ng.cert) of the syslog-ng
15-
server to the {{ site.product.short_name }} server host, for example, into the
14+
1. Create an X.509 certificate for the {{ site.product.short_name }} server.
15+
16+
2. Copy the certificate (for example, syslog-ng.cert) and the
17+
matching private key (for example, syslog-ng.key) to the {{ site.product.short_name }}
18+
server host, for example, into the
1619
/opt/syslog-ng/etc/syslog-ng/cert.d directory. The certificate must
17-
be a valid X.509 certificate in PEM format.
20+
be a valid X.509 certificate in PEM format. The key must be in PEM format.
21+
If you want to use a password-protected key, see Password-protected keys.
1822

19-
2. Copy the CA certificate (for example, cacert.pem) of the Certificate
23+
3. Copy the CA certificate (for example, cacert.pem) of the Certificate
2024
Authority that issued the certificate of the {{ site.product.short_name }} clients to
21-
the {{ site.product.short_name }} server, for example, into the
25+
the {{ site.product.short_name }} server host, for example, into the
2226
/opt/syslog-ng/etc/syslog-ng/ca.d directory.
2327

24-
Issue the following command on the certificate: **openssl x509
25-
-noout -hash -in cacert.pem** The result is a hash (for example,
28+
If you wish to use the ca-dir() option, instead of the ca-file(), in the
29+
{{ site.product.short_name }} configuration file (step 4.) then
30+
- issue the following command on the certificate:\
31+
`openssl x509 -noout -hash -in cacert.pem`\
32+
The result is a hash (for example,
2633
6d2962a8), a series of alphanumeric characters based on the
2734
Distinguished Name of the certificate.
28-
29-
Issue the following command to create a symbolic link to the
35+
- issue the following command to create a symbolic link to the
3036
certificate that uses the hash returned by the previous command and
31-
the **.0** suffix.
32-
37+
the **.0** suffix:\
3338
`ln -s cacert.pem 6d2962a8.0`
3439

35-
3. Copy the private key (for example, syslog-ng.key) matching the
36-
certificate of the {{ site.product.short_name }} server to the {{ site.product.short_name }} server host,
37-
for example, into the /opt/syslog-ng/etc/syslog-ng/key.d directory.
38-
The key must be in PEM format. If you want to use a
39-
password-protected key, see Password-protected keys.
40-
4140
4. Add a source statement to the {{ site.product.short_name }} configuration file that uses
4241
the tls( key-file(key_file_fullpathname)
4342
cert-file(cert_file_fullpathname) ) option and specify the key and
4443
certificate files. The source must use the source driver (network()
45-
or syslog()) matching the destination driver used by the syslog-ng
44+
or syslog()) matching the destination driver used by the {{ site.product.short_name }}
4645
client. Also specify the directory storing the certificate of the CA
4746
that issued the client's certificate.
4847

@@ -52,7 +51,7 @@ Complete the following steps on the {{ site.product.short_name }} server:
5251
Example: A source statement using TLS
5352

5453
The following source receives log messages encrypted using TLS,
55-
arriving to the 1999/TCP port of any interface of the syslog-ng
54+
arriving to the 1999/TCP port of any interface of the {{ site.product.short_name }}
5655
server.
5756

5857
```config

doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/004_Macros_of_syslog-ng.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -503,6 +503,7 @@ following macros are available in {{ site.product.short_name }} version 3.9 and
503503
- .tls.x509_o: The value of the Organization field.
504504

505505
- .tls.x509_ou: The value of the Organization Unit field.
506+
- .tls.x509_fp: The key fingerprint of the peer, when the trusted-key() option is used. Available in {{ site.product.short_name }} 4.8 and later versions.
506507

507508
## ${UNIQID}
508509

doc/_admin-guide/120_Parser/002_Parsing_key-value_pairs/000_kv_parser_options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Options of key=value parsers
3-
parser: kv-parser
3+
parser: kv
44
prefix: kv
55
id: adm-parser-kv-opt
66
description: >-

0 commit comments

Comments
 (0)