Add ITL CheckCommands for Thola

[BausPhi]

We wrote CheckCommands for our monitoring tool Thola and we would like to add them to the ITL.
The commands are also documented in the corresponding doc file.
If something needs to be changed, let us know :D
If you are interested in Thola, have a look at our github page.

[yhabteab]

So unfortunately the separation of templates and commands doesn't quite fit into the layout. So we should really think about documenting the templates, then it would be easier to put the subcommands underneath.

cc @Al2Klimov.

[BausPhi]

I applied the change requests, I hope it now fulfills the requirements.

[yhabteab]

It looks pretty good now. I just need to test the CheckCommands.

[BausPhi]

Okay, let me know if you need some help using thola.

[yhabteab]

I could not find any device supported by thola and so it would be very helpful if you would test the CheckCommands and write here as a test protocol.

[BausPhi]

We tested all commands on our icinga and all the commands worked flawless.

[yhabteab]

Sorry for the delay!

If I understood it correctly, all the checkcommands are based on a single thola main command namely thola check so the subcommands are always executed like /thola-client check $sub_commands$. Therefore it would be a bit more helpful if there would be only one checkcommand without the templates and all sub commands. The user could then, depending on where he needs them, enter the sub commands as follows vars.sub_command = "cpu-load", vars.sub_command = "memory-usage" etc. then the documentation would be a bit clearer without having to document the templates.

The CheckCommand would then look like as follows.

object CheckCommand "thola-check" {
    import "plugin-check-command"

    command = [ PluginContribDir + "/thola-client" ]

    arguments += {
        "(no key.0)" = {
            order = -2
            required = true
            skip_key = true
            value = "check"
            description = "Thola Check Mode"
        }
        "(no key)" = {
            order = -1
            required = true
            skip_key = true
            value = "$sub_command$"
            description = "Thola check sub commands"
        }
        "(no key.1)" = {
            order = 0
            required = true
            skip_key = true
            value = "$address$"
            description = "Thola Check Device Mode"
        }
        "--target-api" = {
            required = true
            value = "$thola_api_address$"
            description = "Address of the thola API"
        }
        "--snmp-community" = {
            required = false
            value = "$snmp_community$"
            description = "SNMP Community of target"
        }
        "--snmp-version" = {
            required = false
            value = "$snmp_protocol$"
            description = "SNMP Version of target"
        }
    }

    if (vars.sub_command == "cpu-load" || vars.sub_command == "memory-usage") {
        arguments += {
            "--critical" = {
                required = false
                value = "$critical$"
                description = "Critical Threshold"
            }
            "--warning" = {
                required = false
                value = "$warning$"
                description = "Warning Threshold"
            }
        }
    } else if (vars.sub_command == "sbc") {
       The arguments of `sbc` sub command come here
    }
   etc.....

It's just a suggestion, you don't have to change everything right away, and maybe @Al2Klimov can say something about it too.

[Al2Klimov]

No, @Yonas-net . If the user shall be able to specify the subcommand as custom var at host/service (where else?), you can’t do it this way. Depending on the specific case you can either make several separate commands or one big command like MySQL health with all arguments of all subcommands present (unconditionally).

@BausPhi Do you consider the latter solution reasonable?

[BausPhi]

Tomorrow I will discuss with my workmates which option is the best for us. I will then let you now what we decided. Sorry for the delay.

[BausPhi]

We came to the conclusion that we would like to stick with a separate command for every sub command. The reason for this is that the possible flags vary a lot for the different sub commands. For example the thola check ups command has 12 flags that don't exist in other sub commands.

Is there still anything that we then have to change?

[Al2Klimov]

What about shortening all this a bit...

[Al2Klimov]

Sure.

[Al2Klimov]

Indent config w/ tabs, not spaces.

[BausPhi]

Is there anything left to do?

[Al2Klimov]

Yes, #8683 (review) .

[BausPhi]

All spaces should now be replaced by tabs.

[Al2Klimov]

We’re actually moving forward...

[Al2Klimov]

@Yonas-net I hope you keep all of my complaints in mind for the next time you review a new check command. 😄

[Al2Klimov]

In the doc please use ASCII " and '.

[Al2Klimov]

And ’ => '?

[Al2Klimov]

We’re almost done...

[Al2Klimov]

You seem to have merged the master to resolve conflicts. I'll take care of this, but the next time please rebase:

https://github.com/Icinga/icinga2/blob/master/CONTRIBUTING.md#-rebase-a-branch

[Al2Klimov]

LGTM

[BausPhi]

Thank you very much for taking your time to look at all the changes

[Al2Klimov]

And don't forget I've force-pushed the branch, i.e. perform git pull -f first!

[Al2Klimov]

If you request squashing, please w/o rebasing!