•

بدنه اصلی فایل پیکربندی از تعاریف اشیاء تشکیل شده است: منابع، مقصدها و مسیرهای لاگ مشخص می‌کنند که چه پیام‌های گزارشی دریافت شوند و به کجا ارسال گردند. همه شناسه‌ها، نام‌های گزینه‌ها و ویژگی‌ها، و هر رشته متنی دیگری که در فایل پیکربندی syslog-ng OSE استفاده می‌شود، به حروف کوچک و بزرگ حساس هستند (case sensitive). تعاریف اشیاء (که statement نیز نامیده می‌شوند) دارای ساختار نحوی زیر هستند:

type-of-the-object identifier-of-the-object {<parameters>};

تمامی شناسه‌ها، ویژگی‌ها و هر رشته متنی دیگری که در فایل پیکربندی syslog-ng OSE به کار می‌رود، به حروف کوچک و بزرگ حساس هستند.

نکته کاربردی: از شناسه‌هایی استفاده کنید که به نوع شیئی که مشخص می‌کنند اشاره داشته باشند. برای مثال، پیشوند s_ را برای اشیاء مبدأ (source)، پیشوند d_ را برای مقصدها (destination) و مواردی از این دست قرار دهید.

توجه: تکرار تعریف یک شیء (یعنی تعریف یک شیء مشابه با همان شناسه بیش از یک بار) مجاز نیست، مگر اینکه از تعریف @define allow-config-dups 1 در فایل پیکربندی استفاده کنید. - پارامترها (Parameters): پارامترهای شیء، محصور در آکولاد {parameters}. - نقطه ویرگول (Semicolon): تعاریف اشیاء با یک نقطه ویرگول (;) خاتمه می‌یابند.

برای مثال، خط زیر یک مبدأ را تعریف کرده و آن را s_internal می‌نامد.

source s_internal { internal(); };

بعداً می‌توان با استفاده از شناسه این شیء در سایر دستورات به آن ارجاع داد؛ برای مثال، مبدأ قبلی به عنوان یک پارامتر در دستور لاگ زیر استفاده شده است:

log { source(s_internal); destination(d_file); };

•

پارامترها و گزینه‌های درون یک عبارت، شبیه به فراخوانی توابع در زبان برنامه‌نویسی C هستند: نام گزینه که به دنبال آن فهرستی از پارامترهایش درون پرانتز قرار گرفته و به یک نقطه ویرگول ختم می‌شود.

option(parameter1, parameter2); option2(parameter1, parameter2);

برای مثال، درایور file() در عبارت مبدأ زیر دارای سه گزینه است: نام فایل (/var/log/apache/access.log)، follow-freq() و flags(). گزینه follow-freq() نیز یک پارامتر دارد، در حالی که گزینه flags() دارای دو پارامتر است.

source s_tail { file("/var/log/apache/access.log"
follow-freq(1) flags(no-parse, validate-utf8)); };

اشیاء ممکن است پارامترهای اجباری و اختیاری داشته باشند. پارامترهای اجباری وابسته به موقعیت (positional) هستند، به این معنی که باید به ترتیبی معین مشخص شوند. پارامترهای اختیاری را می‌توان با هر ترتیبی با استفاده از قالب option(value) مشخص کرد. اگر پارامتری (اختیاری یا اجباری) مشخص نشود، از مقدار پیش‌فرض آن استفاده می‌شود. پارامترها و مقادیر پیش‌فرض آن‌ها در بخش مرجع شیء مربوطه فهرست شده‌اند.

مثال: استفاده از پارامترهای اجباری و اختیاری

درایور مبدأ unix-stream() یک آرگومان اجباری دارد: نام سوکتی که باید روی آن گوش فرا دهد. پارامترهای اختیاری پس از نام سوکت با هر ترتیبی قرار می‌گیرند، بنابراین تعاریف مبدأ زیر عملکرد یکسانی دارند:

source s_demo_stream1 {
    unix-stream("<path-to-socket>"
    max-connections(10) group(log));
};
source s_demo_stream2 {
    unix-stream("<path-to-socket>"
    group(log) max-connections(10));
};

•

برخی از گزینه‌ها، گزینه‌های سراسری هستند یا می‌توان آن‌ها را به صورت سراسری تنظیم کرد؛ برای مثال، اینکه آیا syslog-ng OSE باید از تفکیک DNS برای وضوح نشانی‌های IP استفاده کند یا خیر.

options { use-dns(no); };

• اشیاء می‌توانند پیش از تعریف شدن مورد استفاده قرار گیرند.
• اشیاء را می‌توان به صورت درون‌خطی (inline) نیز تعریف کرد. این حالت زمانی کاربرد دارد که از شیء فقط یک بار استفاده می‌کنید (برای مثال، یک فیلتر).
• برای افزودن توضیحات (کامنت) به فایل پیکربندی، سطر را با # شروع کرده و نظر خود را بنویسید. این سطرها توسط syslog-ng OSE نادیده گرفته می‌شوند.

# Comment: This is a stream source
source s_demo_stream {
unix-stream("<path-to-socket>" max-connections(10) group(log)); };

log {
    source(s1); source(s2); ...
    optional_element(filter1|parser1|rewrite1);
    optional_element(filter2|parser2|rewrite2);
    ...
    destination(d1); destination(d2); ...
    flags(flag1[, flag2...]);
};

source s_localhost { network(ip(127.0.0.1) port(1999)); };
destination d_tcp { network("10.1.2.3" port(1999) localport(999)); };
log { source(s_localhost); destination(d_tcp); };

options { option1(params); option2(params); ... };

options { use-dns(no); };