-
Notifications
You must be signed in to change notification settings - Fork 1.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
config_param options to specify deprecated/obsoleted parameters #1186
Conversation
…not parameter name
…rameter and removed parameter
@repeatedly could you review this change? |
# because they are expected to be removed entirely sometime in the future. | ||
# Obsoleted: These obsolete features have been entirely removed from JavaScript and can no longer be used. | ||
if opts[:deprecated] | ||
logger.warn "'#{name}' paramenter isn't recommended to use now." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo: parameter
One idea. How about adding "message" like parameter to show better logs?. config_param :host, :string, default: nil, obsoleted: true, message: "Use <server> section instead" result:
|
@repeatedly When is that parameter used? only for |
LGTM 👍 |
Good. After test passed, please merge. |
Merged. |
config_param options to specify deprecated/obsoleted parameters
This change adds 2 options for
config_param
.And I marked
host
,port
ofout_forward
without<server>
sections as obsoleted.deprecated
Unrecommended parameter, and will be removed in future.
If users specify this parameter, Fluentd warns it in logs.
obsoleted
Configuration parameter which is already removed.
If users specify this parameter, Fluentd stops with an error (a kind of configuration errors).