نام (NAME)

syslog-ng - برنامه ثبت وقایع سیستم syslog-ng

خلاصه دستور (SYNOPSIS)

syslog-ng [گزینه‌ها]

توضیحات (DESCRIPTION)

این صفحه راهنما صرفاً یک چکیده است.

برنامه syslog-ng OSE یک برنامه منعطف و بسیار مقیاس‌پذیر برای ثبت وقایع سیستم (system logging) است. به‌طور معمول، syslog-ng OSE برای مدیریت پیام‌های گزارش (log messages) و پیاده‌سازی ثبت متمرکز وقایع به کار می‌رود؛ جایی که هدف، جمع‌آوری پیام‌های گزارش از چندین دستگاه مختلف بر روی یک کارگزار لاگ مرکزی و واحد است. دستگاه‌های مختلف - که کلاینت‌های syslog-ng OSE نامیده می‌شوند - همگی syslog-ng OSE را اجرا می‌کنند و پیام‌های گزارش را از برنامه‌ها، فایل‌ها و سایر منابع گوناگون جمع‌آوری می‌نمایند. کلاینت‌ها تمامی پیام‌های گزارش مهم را به کارگزار دوردست syslog-ng OSE ارسال می‌کنند، جایی که کارگزار آن‌ها را مرتب‌سازی و ذخیره می‌نماید.

گزینه‌ها (OPTIONS)

--caps فرایند syslog-ng OSE را با فلگ‌های قابلیت (POSIX capability) مشخص‌شده اجرا می‌کند.

/Users/hofi/Develop/Balabit/syslog-ng/build/install/sbin/syslog-ng -Fv --caps cap_sys_admin,cap_chown,cap_dac_override,cap_net_bind_service,cap_fowner=pi

/Users/hofi/Develop/Balabit/syslog-ng/build/install/sbin/syslog-ng -Fv --caps CAP_SYS_ADMIN,CAP_CHOWN,CAP_DAC_OVERRIDE,CAP_NET_BIND_SERVICE,CAP_FOWNER=pi

--cfgfile <file> یا -f <file> از فایل پیکربندی مشخص‌شده استفاده می‌کند.

--chroot <dir> یا -C <dir> ریشه (root) را به پوشه مشخص‌شده تغییر می‌دهد (chroot). فایل پیکربندی پس از عمل chroot خوانده می‌شود، بنابراین فایل پیکربندی باید درون محیط chroot در دسترس باشد. بدین ترتیب بازخوانی مجدد (reload) پیکربندی syslog-ng OSE پس از chroot نیز امکان‌پذیر خواهد بود. با این حال توجه داشته باشید که گزینه‌های --user و --group پیش از اعمال chroot تعیین و اعمال می‌شوند.

--check-startup در syslog-ng OSE نسخه 4.5 و بالاتر موجود است. از این گزینه می‌توان برای مقداردهی اولیه کامل پیکربندی با syslog-ng OSE و سپس خروج با کد خروج نشان‌دهنده نتیجه استفاده کرد. همچنین می‌توان از این گزینه برای بررسی معتبر بودن معنایی پیکربندی و اینکه آیا syslog-ng OSE واقعاً می‌تواند شروع به کار کند استفاده نمود. (گزینه --syntax-only تنها خطاهای نحوی را تشخیص می‌دهد.) علاوه بر این، --check-startup را می‌توان در محیط کوبرنتیز (Kubernetes) برای اجرا به عنوان یک کانتینر اختصاصی بررسی پیکربندی به کار برد.

توجه: احتمال شکست این گزینه در صورتی که نمونه دیگری از syslog-ng OSE در پس‌زمینه در حال اجرا باشد بسیار بالاست، زیرا چندین فرایند مانند شنوندگان شبکه (network listeners) را مقداردهی اولیه می‌کند. در چنین حالتی، آدرس شبکه قبلاً در حال استفاده خواهد بود.

--control <file> یا -c <file> محل سوکت کنترلی syslog-ng OSE را تعیین می‌کند. مقدار پیش‌فرض: /var/run/syslog-ng.ctl

--debug یا -d اجرای syslog-ng OSE در حالت اشکال‌زدایی (debug mode).

--default-modules فهرستی جداشده با کاما از ماژول‌هایی که به‌طور خودکار بارگذاری می‌شوند. ماژول‌هایی که به‌طور خودکار بارگذاری نمی‌شوند را می‌توان با گنجاندن عبارت @module <modulename> در فایل پیکربندی syslog-ng OSE بارگذاری کرد. تنها در نسخه 4.1 و بالاتر syslog-ng OSE در دسترس است.

--enable-core به syslog-ng OSE امکان می‌دهد تا در صورت بروز خرابی و فروپاشی (crash)، فایل‌های core بنویسد تا به پشتیبانی و اشکال‌زدایی کمک کند.

--fd-limit <number> حداقل تعداد توصیف‌کننده‌های فایل (fdها) مورد نیاز را تعیین می‌کند. این مقدار مشخص می‌کند که syslog-ng OSE می‌تواند چند فایل را به‌طور هم‌زمان باز نگه دارد. مقدار پیش‌فرض: 4096.

توجه: این گزینه بر تنظیم کلی ulimit میزبان اولویت ندارد و آن را بازنویسی نمی‌کند.

--foreground یا -F به صورت دیمن در پس‌زمینه نرود و در پیش‌زمینه اجرا شود. هنگام اجرا در پیش‌زمینه، syslog-ng OSE از دایرکتوری جاری (${CWD}) شروع می‌شود تا بتواند فایل‌های core تولید کند (به‌طور معمول، syslog-ng OSE از /Users/hofi/Develop/Balabit/syslog-ng/build/install/var شروع به کار می‌کند).

--group <group> یا -g <group> پس از مقداردهی اولیه فایل پیکربندی، به گروه مشخص‌شده تغییر وضعیت می‌دهد.

--help یا -h یک پیام راهنمای کوتاه نمایش می‌دهد.

--module-registry فهرست و توضیحات ماژول‌های موجود را نمایش می‌دهد.

توجه: همه این ماژول‌ها به‌طور خودکار بارگذاری نمی‌شوند، بلکه فقط موارد مشخص‌شده در گزینه --default-modules بارگذاری خواهند شد. تنها در syslog-ng OSE نسخه 4.0 و بالاتر در دسترس است.

--no-caps اجرای syslog-ng OSE به عنوان ریشه (root)، بدون پشتیبانی از قابلیت‌ها (capabilities). این رفتار پیش‌فرض است. در لینوکس، اگر syslog-ng OSE با فعال بودن گزینه --enable-linux-caps کامپایل شده باشد، امکان اجرای آن به عنوان کاربر غیرریشه همراه با پشتیبانی از قابلیت‌ها وجود دارد. (برای نمایش فهرست پارامترهای فعال‌شده هنگام ساخت، دستور syslog-ng --version را اجرا کنید.) برای اجرای syslog-ng OSE با قابلیت‌های خاص، از گزینه --caps استفاده نمایید.

--persist-file <persist-file> یا -R <persist-file> مسیر و نام فایل syslog-ng.persist را که گزینه‌ها و داده‌های پایدار در آن ذخیره می‌شوند تعیین می‌کند.

--pidfile <pidfile> یا -p <pidfile> مسیر فایل PID را که شناسه فرایند اصلی در آن ذخیره می‌شود تعیین می‌کند.

--preprocess-into <output-file> پس از پردازش فایل پیکربندی و حل کردن فایل‌ها و متغیرهای گنجانده‌شده (included)، پیکربندی حاصل را در فایل خروجی مشخص‌شده می‌نویسد. تنها در syslog-ng OSE نسخه 4.0 و بالاتر در دسترس است.

--process-mode <mode> نحوه اجرای syslog-ng OSE را تعیین می‌کند: در پیش‌زمینه (عمدتاً برای اشکال‌زدایی)، در پس‌زمینه به عنوان دیمن، یا در حالت پس‌زمینه امن (safe-background). به‌طور پیش‌فرض، syslog-ng OSE در حالت safe-background اجرا می‌شود. این حالت یک فرایند ناظر با عنوان supervising syslog-ng OSE ایجاد می‌کند که در صورت فروپاشی syslog-ng OSE، آن را مجدداً راه‌اندازی می‌نماید.

--stderr یا -e پیام‌های داخلی syslog-ng OSE را در stderr ثبت می‌کند. عمدتاً برای اهداف اشکال‌زدایی به همراه گزینه --foreground استفاده می‌شود. اگر مشخص نشود، syslog-ng OSE چنین پیام‌هایی را در مبدأ داخلی خود ثبت خواهد کرد.

--syntax-only یا -s صحت نحوی فایل پیکربندی را بررسی کرده و خارج می‌شود.

--user <user> یا -u <user> پس از مقداردهی اولیه فایل پیکربندی (و به صورت اختیاری chroot کردن)، به کاربر مشخص‌شده تغییر وضعیت می‌دهد.

توجه: اگر کاربر مشخص‌شده مجوزی برای ایجاد فایل /dev/log نداشته باشد، امکان بازخوانی مجدد (reload) پیکربندی syslog-ng OSE وجود نخواهد داشت.

--verbose یا -v ثبت گزارش‌های با جزئیات بیشتر (verbose) را که برای عیب‌یابی syslog-ng OSE به کار می‌رود فعال می‌کند.

--version یا -V شماره نسخه و اطلاعات کامپایل و همچنین فهرست و توصیف کوتاهی از ماژول‌های موجود را نمایش می‌دهد. برای توضیحات دقیق ماژول‌های موجود، گزینه --module-registry را ببینید.

توجه: همه این ماژول‌ها به‌طور خودکار بارگذاری نمی‌شوند، بلکه فقط موارد مشخص‌شده در گزینه --default-modules بارگذاری خواهند شد.

--worker-threads تعداد رشته‌های کاری (worker threads) را که syslog-ng OSE می‌تواند استفاده کند، از جمله رشته اصلی syslog-ng OSE، تعیین می‌کند. برای جزئیات بیشتر به syslog-ng OSE Administrator Guide[1] مراجعه فرمایید.

توجه: برخی عملیات در syslog-ng OSE می‌توانند از رشته‌هایی استفاده کنند که توسط این گزینه محدود نمی‌شوند. این تنظیم تنها زمانی اعمال می‌شود که syslog-ng OSE در حالت چندرشته‌ای (multithreaded) اجرا شود. تنها در syslog-ng OSE نسخه 4.0 و بالاتر در دسترس است.

فایل‌ها (FILES)

/Users/hofi/Develop/Balabit/syslog-ng/build/install/

/Users/hofi/Develop/Balabit/syslog-ng/build/install/etc/syslog-ng.conf

همچنین ببینید (SEE ALSO)

syslog-ng.conf(5)

توجه: اگر با مشکلی مواجه شدید یا در رابطه با syslog-ng OSE به کمک نیاز داشتید، به syslog-ng OSE Administration Guide[1] مراجعه کنید، یا به syslog-ng OSE mailing list[2] سر بزنید. برای اخبار و اطلاعیه‌های مربوط به syslog-ng OSE، از syslog-ng OSE blogs[3] دیدن کنید.

نویسنده (AUTHOR)

این صفحه راهنما از syslog-ng OSE Administration Guide[1] تولید شده است که توسط چندین مشارکت‌کننده نوشته شده و مایلیم از آن‌ها صمیمانه تشکر و قدردانی نماییم.

حق نشر (COPYRIGHT)

نکات (NOTES)

[1] syslog-ng OSE Administration Guide
⟨https://syslog-ng.github.io/admin-guide/README⟩

[2] syslog-ng OSE mailing list
⟨https://lists.balabit.hu/mailman/listinfo/syslog-ng⟩

[3] syslog-ng OSE blogs
⟨https://syslog-ng.com/blog⟩