Added three configuration properties to SyslogAppender #238
Conversation
…ck.trace.pattern, and throwable.excluded. These provide more flexibility for segregation of log output for different audiences and systems, such as for creating audit-only logs, structured logs, and logs intended for debugging application errors.
| @@ -37,7 +34,7 @@ | |||
|
|
|||
| @Component(metatype = true, configurationFactory = true, policy = ConfigurationPolicy.REQUIRE, | |||
| label = "ACS AEM Commons - Syslog Appender", | |||
| description = "Logback appender to send messages using Syslog") | |||
| description = "Logback appender to send messages using Syslog. When testing this configuration, you should verify that the remote syslog daemon accepts requests from an external source. Experience shows that, by default, syslog daemons usually deny requests coming via a network connection.") | |||
There was a problem hiding this comment.
This should probably go in the docs.
There was a problem hiding this comment.
I agree. I put it there because it was something I specifically ran into when trying to get syslog setup on my mac and only found it at the end of the Logback documentation on the SyslogAppender. I wish it was front-and-center when I started down this path, so I just stuck it right there on the Felix config panel for anyone else like me who regularly fails to RTFM.
How would I go about making changes to the docs? Should I just make pull requests for the gh-pages-1.6 branch? If so, I'll remove that statement from the metatype description and move it to the Syslog Appender page.
…om metatype description
| description = "The Syslog Facility is meant to identify the source of a message, separately from any context included in the Suffix Pattern. The facility option must be set to one of the strings KERN, USER, MAIL, DAEMON, AUTH, SYSLOG, LPR, NEWS, UUCP, CRON, AUTHPRIV, FTP, NTP, AUDIT, ALERT, CLOCK, LOCAL0, LOCAL1, LOCAL2, LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7. Case is not important.") | ||
| private static final String PROP_FACILITY = "facility"; | ||
|
|
||
| @Property(label = "Stack Trace Pattern", description = "Logback Pattern for customizing the string appearing just before each stack trace line. The default value for this property is a single tab character.") |
There was a problem hiding this comment.
Just noticed this - the description says that the default is a single tab character, but it looks like the default is an empty string.
There was a problem hiding this comment.
nevermind; I get it now, this default is in Logback.
|
merged with minor formatting changes. Thanks!!! |
Added three configuration properties to SyslogAppender: facility, stacktrace.pattern, and throwable.excluded. These provide more flexibility for segregation of log output for different audiences and systems, such as for creating audit-only logs, structured logs, and logs intended for debugging application errors.