search

Icinga / icingaweb2-module-director

The Director aims to be your new favourite Icinga config deployment tool. Director is designed for those who want to automate their configuration deployment and those who want to grant their “point & click” users easy access to the configuration.
https://icinga.com/docs/director/latest
GNU General Public License v2.0
412 stars 201 forks source link

add hints where to find the checks from external commands #1942

Closed fireba11 closed 4 years ago

fireba11 commented 5 years ago

There are quite a few Command pre-defined as external commands, but there is no hint where the plugins for the checks can be aquired. Quite a few come with a normal installation on debian, but others (for example check_elasticsearch) do not. If you could provide hints where those are from that would be really usefull especially since icinga-exchange/nagios-exchange sometimes got more than one plugin by that name with different syntax :-/

idandr commented 5 years ago

External commands (usually) come from the Icinga 2 Template Library (ITL). In the documentation of the ITL are links to the source of each check. For check_elasticsearch see https://icinga.com/docs/icinga2/latest/doc/10-icinga-template-library/#elasticsearch which links to https://github.com/anchor/nagios-plugin-elasticsearch . Hope that helps and addresses your question.

Thomas-Gelf commented 5 years ago

I like this feature request. IMHO every external/ITL-Command should be able to point to it's upstream project/source. Currently there is no place for this, but we have inline links in our documentation. Couldn't we provide an optional website property for our Command-objects?

This would allow us to maintain references to the related plugin in the ITL, and the Director could show related links - where available.

@dnsmichi: what's your opinion on this?

fireba11 commented 5 years ago

@idandr thank you for pointing me in the right direction :-) @Thomas-Gelf that sounds like a very userfriendly way to include that information

dnsmichi commented 5 years ago

I like the idea. I am only undecided about the actual attribute name, I would rather opt for plugin_url or script_url or source_url.

Mainly because some plugins are taken from a Git repository with long direct urls, accompanied by others. The majority of the plugins likely points to exchange.icinga.com or single GH repos.

Event/Notification command objects should also be taken into account.

Maybe we just call it docs_url and always point to the icinga docs, keeping the URLs for the ITL documented in just one place.

Thomas-Gelf commented 4 years ago

@fireba11: you might eventually want to open a dedicated issue in the Icinga 2 issue tracker to speed things up. There is nothing we can do here unless this has been implemented. When creating the issue please link this one and eventually ping me once this feature is available. I'll close this issue so far.

Thanks, Thomas

dnsmichi commented 4 years ago

I had this on my TODO list and have talked with @lippserd about it.

Cheers, Michael