Skip to content

Commit 5096a60

Browse files
Merge branch 'master' into doc-datastream-dest
2 parents 586d59d + fdad7fa commit 5096a60

File tree

8 files changed

+44
-21
lines changed

8 files changed

+44
-21
lines changed

.github/workflows/jekyll-gh-pages.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ concurrency:
2929
jobs:
3030
# Build job
3131
build:
32-
runs-on: ubuntu-latest
32+
runs-on: ubuntu-22.04
3333
steps:
3434
- name: Checkout
3535
uses: actions/checkout@v4
@@ -105,7 +105,7 @@ jobs:
105105
environment:
106106
name: github-pages
107107
url: ${{ steps.deployment.outputs.page_url }}
108-
runs-on: ubuntu-latest
108+
runs-on: ubuntu-22.04
109109
needs: build
110110
steps:
111111
- name: Deploy to GitHub Pages

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/090_Global_options/000_Global_options.md

Lines changed: 27 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -338,7 +338,7 @@ driver.
338338

339339
## stats()
340340

341-
Available in {{ site.product.short_name }} 4.1 and later versions.
341+
Available in {{ site.product.short_name }} 4.1 and later versions, introduced by Axoflow.
342342

343343
*Description:* The stats() option is an aggregated collection of statistic-related sub-options.
344344

@@ -358,12 +358,16 @@ options {
358358

359359
The following sub-options are available within the stats() option:
360360

361-
- freq()
361+
### freq()
362362

363-
| Accepted values:| number|
363+
| Accepted values:| number (seconds)|
364364
|Default:| 600|
365365

366-
- level()
366+
*Description:* The period between two STATS messages in seconds. STATS
367+
are log messages sent by syslog-ng, containing statistics about dropped
368+
log messages. Set to **0** to disable the STATS messages.
369+
370+
### level()
367371

368372
| Accepted values:| 0, 1, 2, 3|
369373
|Default:| 0|
@@ -379,8 +383,16 @@ The following sub-options are available within the stats() option:
379383
- Level 3 contains detailed statistics based on various message parameters like facility, severity, or tags.
380384

381385
**NOTE:** Level 2 and 3 increase the memory requirements and CPU load. For details on message statistics, see Statistics of syslog-ng.
386+
{: .notice--info}
387+
388+
### lifetime()
382389

383-
- max-dynamics()
390+
| Accepted values:| number (seconds)|
391+
|Default:| N/A|
392+
393+
*Description:* Dynamic counters in metrics are pruned after lifetime expires. Note that orphaned counters are not pruned (you can prune them by running `syslog-ng-ctl stats --remove-orphans`)
394+
395+
### max-dynamics()
384396

385397
| Accepted values:| number|
386398
|Default:| N/A|
@@ -392,27 +404,28 @@ The following sub-options are available within the stats() option:
392404
If this option is not used, dynamic counters are not limited. This can be useful in cases where you are extremely interested in dynamic counters, and use these statistics extensively.
393405

394406
![]({{ site.baseurl}}/assets/images/caution.png) **CAUTION:** In some cases, there might be even millions of dynamic counters.
407+
{: .notice--warning}
395408

396409
- **Limited dynamic counter clusters:**
397410

398-
To limit dynamic counters, enter a number, and only a maximum of <number> counters will be registered in the statistics.
411+
To limit dynamic counters, enter a number, and only a maximum of \<number\> counters will be registered in the statistics.
399412

400413
In practice, this means dynamic counter clusters. A program name produces one dynamic counter cluster, that can include several counters, such as processed, stamp, and so on.
401414

402415
**Example: Limiting dynamic counter clusters 1:**
403416

404-
If stats-max-dynamics() is set to 1, and 2 programs send messages, only one of these programs will be tracked in the dynamic counters, but it will have more than one counters.
405-
417+
If max-dynamics() is set to 1, and 2 programs send messages, only one of these programs will be tracked in the dynamic counters, but it will have more than one counters.
406418

407419
**Example: Limiting dynamic counter clusters 2:**
408420

409-
If you have 500 clients, and set stats-max-dynamics() to 1000, you will have enough number of counters reserved for these clients, but at the same time, you limit the use of your resources and therefore protect your system from being overloaded.
421+
If you have 500 clients, and set max-dynamics() to 1000, you will have enough number of counters reserved for these clients, but at the same time, you limit the use of your resources and therefore protect your system from being overloaded.
410422

411423
- **No dynamic counters:**
412424

413425
To disable dynamic counters completely, set the value of this option to 0. This is the recommended value if statistics are not used, or if dynamic counters are irrelevant (for example, the number of logs arriving from programs).
414426

415-
**NOTE:** If a lower value is set to stats-max-dynamics() (or, any limiting value, if this option has not been configured before) and {{ site.product.short_name }} is restarted, the changes are only applied after stats-freq() time has passed. That is, the previously allocated dynamic clusters are only removed after this time.
427+
**NOTE:** If a lower value is set to max-dynamics() (or, any limiting value, if this option has not been configured before) and {{ site.product.short_name }} is restarted, the changes are only applied after freq() time has passed. That is, the previously allocated dynamic clusters are only removed after this time.
428+
{: .notice--info}
416429

417430
## so-passcred()
418431

@@ -442,19 +455,19 @@ Possible values:
442455

443456
## stats-freq() (DEPRECATED)
444457

445-
This is a deprecated legacy option. Use the stats() option.
458+
This is a deprecated legacy option. Use stats(freq()) instead.
446459

447460
## stats-level() (DEPRECATED)
448461

449-
This is a deprecated legacy option. Use the stats() option.
462+
This is a deprecated legacy option. Use stats(level()) instead.
450463

451464
## stats-max-dynamics() (DEPRECATED)
452465

453-
This is a deprecated legacy option. Use the stats() option.
466+
This is a deprecated legacy option. Use stats(max-dynamics()) instead.
454467

455468
## sync() or sync-freq() (DEPRECATED)
456469

457-
This is a deprecated legacy option. Use the stats() option.
470+
Obsolete aliases for flush-lines().
458471

459472
## threaded()
460473

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/023_db_parser/001_Using_pattern_databases/002_Correlating_log_messages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Note the following points about timeout values:
6969

7070
Consider the following two messages:
7171

72-
><38>1990-01-01T14:45:25 customhostname program6[1234]: program6 testmessage
72+
><38>1990-01-01T14:45:25 customhostname program6[1234]: program6 testmessage\
7373
><38>1990-01-01T14:46:25 customhostname program6[1234]: program6 testmessage
7474
7575
If the context-timeout is 10 seconds and {{ site.product.short_name }} receives the

doc/_admin-guide/190_The_syslog-ng_manual_pages/007_syslog-ng_control_tool.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -223,8 +223,8 @@ The stats command has the following options:
223223
>dst.file;#anon-destination0#0;/tmp/2021-08-17.log;o;processed;156
224224
>dst.file;#anon-destination0#0;/tmp/2021-08-18.log;a;processed;961
225225
226-
**NOTE:** The stats-lifetime() can be used to do the same
227-
automatically and periodically, but currently stats-lifetime()
226+
**NOTE:** The stats(lifetime()) can be used to do the same
227+
automatically and periodically, but currently stats(lifetime())
228228
removes only dynamic counters that have a timestamp field set.
229229
{: .notice--info}
230230

0 commit comments

Comments
 (0)