feat: add default values of entities to inputs.conf #1530
Conversation
hetangmodi-crest
requested review from
artemrys,
sgoral-splunk and
kgwizdz-splunk
|
Is there an impact in the UI or in the behavior of modular inputs if we have this feature? |
@artemrys @hetangmodi-crest I think that the difference in comparision to the current behaviour will be that when a field is not required, but has a default value in inputs.conf and the user saves input without this field, splunk will automatically save the default value instead of an empty one. |
It makes sense to me, should we add test describing this behaviour? I think should also be reflected in the "User experience" section. |
Can this change affect existing or new add-on users somehow? Some unexpected side effect they might experience? |
No, there is no impact on UI or modular inputs. These default values come from globalConfig itself. Hence, the only delta of an add-on would be - if the add-on's user configures the add-on from .conf files and forgets to not mention the optional values, they would be fetched from |
I have updated the description to capture the details from add-on developer and an add-on user's perspective. |
hetangmodi-crest
requested review from
kkedziak-splunk
and removed request for
kgwizdz-splunk
| if type(entity["defaultValue"]) is bool: | ||
| self.default_value_info[service["name"]].update( | ||
| { | ||
| f"{entity['field']}": f"{str(entity['defaultValue']).lower()}" |
There was a problem hiding this comment.
Just a NIT: f-strings can be omitted here
There was a problem hiding this comment.
Thanks for pointing out, made the changes.
| @@ -4,4 +4,11 @@ python.version = python3 | |||
| {% if disabled and service_name == input_name%} | |||
| disabled = true | |||
| {% endif %} | |||
| {% for key, values in default_values.items() %} | |||
| {% if key == input_name %} | |||
There was a problem hiding this comment.
I think we don't need this double for and if. This would be enough:
{% for item, value in default_values[input_name].items() %}
{{item}} = {{value}}
{% endfor %}
There was a problem hiding this comment.
Made the changes
hetangmodi-crest
dismissed stale reviews from kkedziak-splunk, sgoral-splunk, and artemrys
via
68d98be
Issue number:
ADDON-13362
PR Type
What kind of change does this PR introduce?
Summary
Default values of an entity have been added to
inputs.confto highlight the default configurations for an input.Changes
In accordance with the add-on convention, an inputs.conf file should specify the default values for an input so that the default values are always present. Therefore, this code change adds default entity values to
inputs.confas defined in globalConfig.User experience
User will now be able to point out the default values of their inputs in
inputs.confitself. If an add-on user configuring add-on from .conf files only, forgets to provide the default values, these changes would now come fromdefault/inputs.confand they don't have to wait for error to surface or the add-on to throw out an error.There would be no change in UX for users using an add-on from GUI or REST endpoints.
Checklist
If an item doesn't apply to your changes, leave it unchecked.