Differential D8402

Add a new 'include' keyword to syslog.conf
ClosedPublic
Actions

Authored by bapt on Oct 31 2016, 8:03 PM.

Tags

None

Referenced Files

	Unknown Object (File)
	Wed, Jan 1, 11:30 PM

	Unknown Object (File)
	Dec 4 2024, 4:10 AM

	Unknown Object (File)
	Dec 3 2024, 9:00 PM

	Unknown Object (File)
	Nov 24 2024, 3:16 AM

	Unknown Object (File)
	Nov 22 2024, 7:30 AM

	Unknown Object (File)
	Nov 22 2024, 2:08 AM

	Unknown Object (File)
	Nov 21 2024, 11:29 AM

	Unknown Object (File)
	Nov 17 2024, 7:51 PM

Subscribers

Details

Reviewers

Group Reviewers

Commits

rS308721: MFC r308160:
rS308160: syslogd(8): add an 'include' keyword

Summary

the include keyword is looking at non hidden '.conf' files in the directory
specified in argument.

If the directory does not exist it is simply ignored

It simplies usage of syslogd with automation tools as well as allowing packages
to provide samples syslog configuration files

Change the default config to look for configuration files in /etc/syslog.d and
/usr/local/etc/syslog.d

Diff Detail

Repository

rS FreeBSD src repository - subversion

Lint

Lint Passed

Unit

No Test Coverage

Build Status

Buildable 5771
Build 6075: arc lint + arc unit

Event Timeline

bapt updated this revision to Diff 21847.Oct 31 2016, 8:03 PM

bapt retitled this revision from to Add a new 'include' keyword to syslog.conf.

bapt updated this object.

bapt edited the test plan for this revision. (Show Details)

Herald added a reviewer: manpages. · View Herald TranscriptOct 31 2016, 8:03 PM

Herald added a subscriber: imp. · View Herald Transcript

Add /etc/syslog.d in mtree

Herald edited edge metadata. · View Herald TranscriptOct 31 2016, 8:04 PM

Ensure 'include' is followed by a space to be taken in account (reported by kib)
Fix some debug printing

Herald edited edge metadata. · View Herald TranscriptOct 31 2016, 8:15 PM

Use static string and sizeof as requested by kib

Herald edited edge metadata. · View Herald TranscriptOct 31 2016, 8:24 PM

I know @markj likes syslogd

more sizeof

Herald edited edge metadata. · View Herald TranscriptOct 31 2016, 8:29 PM

Check the return of snprintf

Herald edited edge metadata. · View Herald TranscriptOct 31 2016, 8:33 PM

Test the result of scandir(3) and print it in debug output

Herald edited edge metadata. · View Herald TranscriptOct 31 2016, 8:41 PM

markj added inline comments.Oct 31 2016, 10:48 PM

usr.sbin/syslogd/syslog.conf.5
67	maybe "all files with names ending in '.conf' and not beginning with a '.' contained in the directory following the keyword."?
usr.sbin/syslogd/syslogd.c
1662	Why not do this check in the select routine for scandir too?
1677	This will crash if a config file includes the directory it's in.

Reword manpage
Prevent 'include' recursion
Move then entire configfile detection into the select for scandir

Herald edited edge metadata. · View Herald TranscriptNov 1 2016, 12:33 AM

bapt marked 3 inline comments as done.Nov 1 2016, 12:34 AM

Plig memory leak

Herald edited edge metadata. · View Herald TranscriptNov 1 2016, 1:09 AM

markj accepted this revision.Nov 1 2016, 1:24 AM

markj added a reviewer: markj.

markj added inline comments.

usr.sbin/syslogd/syslogd.c
1658	This works, but the restriction should be noted in the syslog.conf man page. I think newsyslog is more complete and actually detects include cycles.
1691	You can add a "continue" to the nents == -1 case above to avoid the conditional here.

This revision is now accepted and ready to land.Nov 1 2016, 1:24 AM

Closed by commit rS308160: syslogd(8): add an 'include' keyword (authored by bapt). · Explain WhyNov 1 2016, 1:41 AM

This revision was automatically updated to reflect the committed changes.

wblock added a subscriber: wblock.Nov 18 2016, 4:07 PM

wblock added inline comments.

usr.sbin/syslogd/syslog.conf.5
67	Sorry for the late response. This explanation is still not that clear. Suggestion below. Also, this really needs an example in the man page. The .Em include keyword includes all files with names ending in .Pa .conf from the directory name following the keyword. Filenames that begin with a single dot .Pa \&. are ignored.

Revision Contents
Changeset List

Path

Size

etc/

mtree/

2 lines

2 lines

usr.sbin/

syslogd/

10 lines

211 lines

Diff 21850

etc/mtree/BSD.root.dist

Loading...

etc/syslog.conf

Loading...

usr.sbin/syslogd/syslog.conf.5

Loading...

usr.sbin/syslogd/syslogd.c

Loading...