rsyslog-doc icon indicating copy to clipboard operation
rsyslog-doc copied to clipboard

How to provide coverage for specifying template for actions using obsolete legacy format?

Open deoren opened this issue 7 years ago • 0 comments

From https://github.com/rsyslog/rsyslog-doc/pull/556#pullrequestreview-95752280 and https://github.com/rsyslog/rsyslog-doc/pull/556#issuecomment-364945627:

@PascalWithopf: There is no parameter for templates in the Legacy format, because it is handled in a different way. I wrote "none" as the directive, should there be something else done in this case?

@rgerhards: @deoren The question @PascalWithopf raises in regard to template is a very good one. It's actually a problem with almost all of the actions. In obsolete legacy format, the template is (usually ;-)) given by appending ;TemplateName to the action parameters - so, yes, you can set it, but, no, it's not a real parameter.

I admit I do not know yet how to handle this smartly inside the table...

For the advanced configuration format, this is handled via a parameter. For the obsolete legacy configuration format, this doesn't appear (at first glance) to fit well with the parameter table that we're using as part of a new template (https://github.com/rsyslog/rsyslog-doc/issues/451#issuecomment-360178558) for module doc updates.

We'll need to take a closer look to determine how this should be handled in a consistent manner across the module docs and likely some other pages as well.

The joys of supporting multiple formats ...

refs:

  • #556
  • https://github.com/rsyslog/rsyslog-doc/issues/451#issuecomment-360178558
  • rsyslog/rsyslog#2383

deoren avatar Feb 13 '18 17:02 deoren