Description\subtitle is now not different than the normal, documentation body markdown texts.
It can contain ', and other special characters ()[].*?+^$, etc., though some of them might require escaping, e.g. \\ or \|
Mentioning documentation sections (markdown ##, or HTML <h 1-6> headings) via the exact section title text should work normally, like Slack destination options, but the linking can be forced as well via our custom markdown [[Timezones and daylight saving]] format.
Linking also could work with our [markdown_link liquid include](/syslog-ng.github.io/doc-guide/02_Tools/01_Self_made_tools/README){: class="nav-link content-tooltip" }.
One more destination id=adm-about-glossary#bom override test from subtutle.
Macros test ${HOST}. Liquid test syslog-ng documentation.

H2 test row

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

H3 test row

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

H4 test row

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

H5 test row

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

H6 test row

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

INFO: {: .notice–info} Test
any modifications or changes, use the flags(no-parse) option in the source definition, and a template containing only the ${MESSAGE} macro in the destination definition.

To parse non-syslog messages, for example, JSON, CSV, or other messages, you can use the built-in parsers of syslog-ng OSE. For details, see parser: Parse and segment structured messages.

multi line backticked text

Markdown link tests

1st a source title

2nd a source title

3rd a correct reference link declaration - [a source url_ref]: url3 - (hopefully totally invisible)

4rd a reference link declaration with a missing space after : - [b source url_ref]:url4 - (hopefully totally invisible)

5th a source title using reference link 1

6th a source title using reference link 1 with more than 1 space between the [][] parts

7th b source title using reference link 2

8th [source title]{ url }

9th [a source]{: class=”” }

10th [a source title]{: class=”” }

11th an unknown notice block declaration (hopefully invisible too)

Soft macros (sometimes also called name-value pairs) are either built-in macros automatically generated from the log message (for example, ${HOST}), or custom user-created macros generated by using the syslog-ng OSE pattern database or a CSV-parser. The SDATA fields of RFC-5424 formatted log messages become soft macros as well. In contrast with hard macros, soft macros are writable and can be modified within syslog-ng OSE, for example, using rewrite rules.

WARNING: {: .notice–warning} Test
for the list of hard and soft macros, see Hard versus soft macros.

DANGER: {: .notice–danger} Test
at the location it reaches the log-msg-size() value, and discards the rest of the message.

Code block example:

options {
    stats(
        freq(1)
        level(1)
        lifetime(1000)
        max-dynamics(10000)
        syslog-stats(yes)
        stats()
    );
};

Tests of custom markdown in header source and with id

Introduction to syslog-ng OSE is a test for pages without description/subtitle, but text part between the title and the first heading which can have tooltips too this way.

Developer guide is a double (page title amd section heading) example with a description/subtitle.

Installing syslog-ng is a forced, (also a doubled) page link title example with a description/subtitle.

This one is a Self page link test with ID, this one with the title only - This’s a self made tools testing page of syslog-ng documentation, and a last one with direkt liquid usage - This’s a self made tools testing page of syslog-ng documentation.

Test of forced link with anchored ID part Install Homebrew.

  1. Same test like above in an enumeration Install Homebrew.

Hint: Same again in a notice block Install Homebrew. If you have syslog-ng OSE installed via brew, as a reference, you can check the dependencies of the brew built version using brew deps syslog-ng

Embedded markdown style link test from a different domain

Search test for RFC-3526 and RFC-3526. (you need to turn ‘search: true’ on temporally in the liquid header of this test page)

The severity of the message. time-zone() teszt

parser: Parse and segment structured messages

parser: Parse and segment structured messages

discord Sending alerts and notifications to Discord

discord Sending alerts and notifications to Discord

Timezones and daylight saving

Timezones and daylight saving

Slack destination options

Slack destination options

Slack destination options

Slack :destination options

Slack ‘destination’ options

[[destination]]

destination forced

destination id=bom different title, id=bom

destination id=bom

[[destination|bom_id]] exact example different title, id=bom

[[destination|]] - [[destination|]]

[[destination||]] - [[destination||]]

[destination ] - [destination|]
destination - destination|

[destination] - [destination]

Options of the mqtt() destination

[Parse bar]

Alma parser korte

This is a direct, html link destination test

another destination test

markdown_link test destination apostroph

markdown_link test destination quote

markdown_link test withTooltip=”yes”

markdown_link test withTooltip=yes

markdown_link test withTooltip=”true”

markdown_link test withTooltip=true

option

Options is an excluded word.

[[Option]] is excluded

option is excluded, but overidden

For more information, see Options of the kafka() destination’s C implementation or Options of the kafka() destination’s C implementation.

For details, see The syslog-ng.conf manual page.

See also direct

The syslog-ng.conf manual page

The syslog-ng OSE manual page

Here comes a liquid {% include doc/admin-guide/manpages-footnote.md %} and a {{ site.product.name }} variable raw inclusion test

One more without any escaping using the render_with_liquid: false frontmatter option {% include doc/admin-guide/manpages-footnote.md %} and a {{ site.product.name }} variable raw inclusion test

WARNING:
Take care, this might require a special notation even if {% raw %} and {% endraw %} block should protect alone these blocks, but it does not exactly !!!
See the source-code of this page how to escape it correctly (otherwise the page custom rendering might break!!!)
We found that using the render_with_liquid: false frontmatter option helps best, though it is not clearly documented, and its name suggests it will supress liquid rendering entirely, but (luckily ?) with our custom rendering it supresses only the final liquid render pass (that can fully eliminate our self-rendered content otherwise)

See also

The syslog-ng.conf manual page
The syslog-ng OSE manual page

NOTE: If you experience any problems or need help with syslog-ng OSE, visit the syslog-ng OSE mailing list.

For news and notifications about syslog-ng OSE, visit the syslog-ng blogs.

Further liquid site variable tests.
When encoding is set in a source (using the encoding() option) and the message is longer (in bytes) than log-msg-size() in UTF-8 representation, syslog-ng OSE splits the message at an undefined location (because the conversion between different encodings is not trivial).

The following is a simple configuration file for syslog-ng Open Source Edition that collects incoming log messages and stores them in a text file. syslog-ng Open Source Edition.

Aliast testing e.g ${LEVEL} or ${PRIORITY} should work like ${SDATA}

Alias testing e.g ${LEVEL} or ${PRIORITY} should work like ${SDATA}

Fully Qualified Domain Name

fully qualified domain name

Fully qualified domain Name

fully Qualified domain Name

Fully qualified domain name

FQDN

F.Q.D.N.

Updated: