rsyslog-doc
rsyslog-doc copied to clipboard
rsyslog
list valid values for options
example, on the omeleasticsearch page there is the option format, and comments about the history of various options, but it doesn't list what the various possible values are.
Do you happen to have a page in mind that could serve as a valid reference for updating the other pages?
The recent work to refresh the module docs is a move in this direction (that format makes an effort to emphasize the correct types among other changes).
sorry, I said omelasticsearch, I meant impstats http://www.rsyslog.com/doc/v8-stable/configuration/modules/impstats.html
look at format as an example of the problem
I wonder if we need another parameter type 'enum' for things that are one of a list rather than an arbitrary word or string, and then we can have something that does a test to make sure we list the possible values.
@davidelang I can definitely see adding a 'max' column for the integer types.
I see for the Format parameter that some of the options have been listed in that section:
http://www.rsyslog.com/doc/v8-stable/configuration/modules/impstats.html#format
though to make it stand out better those details may need to be formatted differently.
re: enum types (like format)
the section mentions several possible values (but not all of them) and gives no real information about what each of them do.
the default plain text version isn't mentioned anywhere.
@davidelang: re: enum types (like format)
the section mentions several possible values (but not all of them) and gives no real information about what each of them do.
the default plain text version isn't mentioned anywhere.
Oh I definitely wasn't holding it up as a complete example, just that an attempt was made (however incomplete it may be). With the decision to move to having the module docs place parameters as separate sections (instead of as bullet points or some other grouping), thee is now enough "room" or separation between the parameters now that sufficient detail could be provided for each valid option for a parameter.
In short, I believe that your point is spot on and we have the space needed to flesh out the options without worry of the details intruding into the space set aside for another parameter.