ITL: add --extra-opts to plugins supporting it

[netphantm]

Adding --extra-opts to nagios plugins

fixes #7630
fixes #10001

[Al2Klimov]

Hello @netphantm and thank you for contributing!

While updating the documentation you have indented the table columns of some new rows not as the others and re-indented the table columns of some existing rows not as the others and needlessly.

Please fix that.

Best,
AK

[Al2Klimov]

• git reset --soft HEAD~3
• git commit --amend --no-edit
• git push -f

[netphantm]

I wanted to change also line 758, to escape the asterisk, since it changes the way it's rendered by vim w/ syntax highlighting from there onward (it makes all text italic), but changed it back to how it was initially..

[julianbrost]

The ordering where you added the new option in the documentation is a bit inconsistent, see the individual comments.

Personal opinion (i.e. you don't have to change this, but in case you agree, feel free to do so): The existing options don't seem to follow a particular order in general, most likely it's based of the order in the usage output in the corresponding plugin. --extra-opts seems to be some kind of "feature of last resort", i.e. you use it if you find no other way, therefore maybe it would make sense to always put it last?

[julianbrost]

* [ ]  `git reset --soft HEAD~3`
* [ ]  `git commit --amend --no-edit`
* [ ]  `git push -f`

@Al2Klimov Looks like this has been addressed, do you mind updating your review?

[Al2Klimov]

Btw. no need for rebasing or squashing – we'll take care.

[cla-bot]

Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Bruno Lingner.
This is most likely caused by a git client misconfiguration; please make sure to:

1. check if your git client is configured with an email to sign commits git config --list | grep email
2. If not, set it up using git config --global user.email [email protected]
3. Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails

[cla-bot]

Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Bruno Lingner.
This is most likely caused by a git client misconfiguration; please make sure to:

1. check if your git client is configured with an email to sign commits git config --list | grep email
2. If not, set it up using git config --global user.email [email protected]
3. Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails

[cla-bot]

Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Bruno Lingner.
This is most likely caused by a git client misconfiguration; please make sure to:

1. check if your git client is configured with an email to sign commits git config --list | grep email
2. If not, set it up using git config --global user.email [email protected]
3. Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails

[cla-bot]

Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Bruno Lingner.
This is most likely caused by a git client misconfiguration; please make sure to:

1. check if your git client is configured with an email to sign commits git config --list | grep email
2. If not, set it up using git config --global user.email [email protected]
3. Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails

[cla-bot]

Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Bruno Lingner.
This is most likely caused by a git client misconfiguration; please make sure to:

1. check if your git client is configured with an email to sign commits git config --list | grep email
2. If not, set it up using git config --global user.email [email protected]
3. Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails

[netphantm]

@Al2Klimov I changed the email address, what do I have to do now to get the checks to be successful now?

[Al2Klimov]

You have to change it in all commits here.

[Al2Klimov]

Btw. no need for rebasing or squashing – we'll take care.

The CLA bot seems to disagree with me. Please

1. Checkout the branch
2. git reset --soft d5d89b7f398a0c8700fe36a64602a3e1bf3f52e0
3. Commit all the stuff

[julianbrost]

I'll try to resolve the remaining open points myself as there was a customer request for this (in particular for check_snmp).

Though when resolving the conflicts, I got confused about the http check now already supporting that argument and its use of set_if:

icinga2/itl/command-plugins.conf

Lines 363 to 367 in 866db3b

	"--extra-opts" = {
	set_if = {{ string(macro("$http_extra_opts$")) != "" }}
	value = "$http_extra_opts$"
	description = "Read extra plugin options from an ini file"
	}

@yhabteab Looks like this was added based on your review. I don't see why this should be necessary though, like shouldn't arguments only be passed if the argument is set anyways?

ref/IP/57417

[yhabteab]

I don't see why this should be necessary though, like shouldn't arguments only be passed if the argument is set anyways?

Yes, I was thinking of a situation where a user might assign a value such as vars.http_extra_opts = host.vars.something, which could result in an empty string (Icinga 2 would pass that as an argument to the plugin). However, since pretty much everywhere else do it without the extra set_if, I guess you can remove it, if you see any problems in it.

[cla-bot]

Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Bruno Lingner.
This is most likely caused by a git client misconfiguration; please make sure to:

1. check if your git client is configured with an email to sign commits git config --list | grep email
2. If not, set it up using git config --global user.email [email protected]
3. Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails

[julianbrost]

I force pushed to squash the commits and rebased to resolve the conflicts.

[cla-bot]

Thank you for your pull request. Before we can look at it, you'll need to sign a Contributor License Agreement (CLA).

Please follow instructions at https://icinga.com/company/contributor-agreement to sign the CLA.

After that, please reply here with a comment and we'll verify.

Contributors that have not signed yet: @netphantm

• If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Please contact us if you think this is the case.

• If you signed the CLA as a corporation, your GitHub username may not have been submitted to us. Please reach out to the responsible person in your organization.

[julianbrost]

And another force push to switch to the author's other e-mail address (there were commits with two different addresses on the branch, I changed it so that the one that's already in the AUTHORS file is used).

The PR will be accepted without the CLA due to the trivial nature of the change (approved by @bobapple, see internal ticket ref/IP/57417).

[bobapple]

@cla-bot check

[oxzi]

• The extra opts parameter is listed last in the documentation for every check except curl / check_curl, where it is first.
• nscp / check_nt also supports --extra-opts, https://www.monitoring-plugins.org/doc/man/check_nt.html.
• smart / check_ide_smart also supports --extra-opts, https://www.monitoring-plugins.org/doc/man/check_ide_smart.html.

See #8010 (comment)

[julianbrost]

• smart / check_ide_smart also supports --extra-opts, monitoring-plugins.org/doc/man/check_ide_smart.html.

That's already added by the PR, am I missing something?

https://github.com/netphantm/icinga2/blob/daf36ae362437d84ebf433045e51f655cce50087/doc/10-icinga-template-library.md#L1364
https://github.com/netphantm/icinga2/blob/daf36ae362437d84ebf433045e51f655cce50087/itl/command-plugins.conf#L3321-L3324

[oxzi]

Compared the documentation list against the CheckCommands and they seem to fit. Furthermore, I think we have not forgotten any check. Thanks everyone!

[netphantm]

thanks guys, sorry I left this unfinished! I had a lot to deal with lately and also just simply forgot about it..
I'm glad it finally got done, so now I don't have to manually edit the command-plugins file after each update of icinga where this is overwritten

[julianbrost]

No worries! Thank you for starting it and already doing a lot of the work!