Service Discovery
The service discovery helps you find additional services you can monitor for any existing host, which are not automatically added out-of-the-box by the host's monitoring template. There are two ways how you can use the service discovery: either perform a manual scan or configure a periodically scheduled job which performs the discovery.
Manual Discovery
To perform a manual service scan for a host, navigate to ConfigurationServicesManual Discovery.
Now you need to select the host you want to scan for additional services. In case you have a lot of hosts, you can pre-filter them by selecting a poller. After selecting a host, the available discovery templates are shown in the Discovery Template lookup.
The discovery templates are installed by the Plugin Store and contain the discovery command to execute, as well as the resulting service name and service macros to set.
By default, only pre-filtered discovery templates are shown, which corrispond with the assigned monitoring templates of the selected host. To disable this behavior, uncheck the Filtered flag next to the discovery template lookup.
Start the scan by clicking on the Scan button. The scan may take a few seconds to complete, depending on the discovery template and the host's response time. In case the scan fails due to a timeout, you can try to increase the scan timeout using the stopwatch icon near the Discovery Template lookup.
Scan results
After a scan is completed, the results are shown in a table below the scan controls.
While scanning you have the possibility to cancel/abort the scan, in case the configuration of the scan is not correct or the scan takes too long.
A scan result (service) always has a status, which indicates it's current monitoring configuration situation (1st column), a key value (2nd column), a generated service name (3rd column, defined by the discovery template) and other values reported by the scan.
Status
The status of a result indicates it's current monitoring situation:
- new: indicates that the service is not yet monitored and is ready to be synced (created)
- excluded: indicates that the service was excluded by the discovery template. This is most likely a default configuration set by our team to prevent syncing of unnecessary services.
- existing: indicates that the service is already present in your monitoring configuration for the given host
Filters
Results (services) can be filtered using the Search and the Status filters.
- Search: filters results by service name and all other available values given by the scan
- Status: filters results by their monitoring-based status
Toggle columns
You can show and hide all non-relevant columns using following control:
Sync services with Monitoring
Sync selected services
Check any services you want to add to your monitoring configuration and hit Sync with Monitoring. All checked services are created shortly after. If you encounter a problem with any service you can expand the sync-results and identify the problem.
Sync all services
By clicking on the expand button on the right of Sync with Monitoring you can choose between Sync selected services or Sync all services. The first one is the default option and equal to clicking the Sync with Monitoring button. By choosing Sync all services, all services are created (also services with status excluded). Again in any case of failure, you can analyze the problem of a given service by expanding the sync-results.
To see created services, head over to Configuration -> Services -> Services by host using the sidemenu.
To find your services you just created it's best practice to use the page's filters. Insert the hostname in the Hosts filter and choose the service template using the Template lookup.
Troubleshooting
It is possible to easily activate the debug mode of our service discovery by enabling the debug switch right next to the scan button.
After enabling debug click again on scan. A moveable popup will open which displays the executed command as well as the command result.
Using the debug information you can analyze and identify problems of a failed scan.
By clicking the button next to close in the top right corner of the debug popup, the inbuilt popup will close and a new browser window will open with the debug information. This may be useful for your workflow if you need to deeper analyze various scans and different scan-configurations.
Auto Discovery Service Job
Overview
An auto discovery service job allows to automatically identify possible services and add them to your monitoring configuration in a flexible way.
To create such jobs, go to Configuration > Services > Auto Discovery Service Jobs using the sidemenu and click on the Add button.
Create Job
General information
- Job name: descriptive name to identify job
- Linked Hosts: target hosts on which the discovery should be performed
- Linked Host Groups: target host groups on whose contained hosts the discovery should be performed
- Discovery Service Template: the discovery template (discovery configuration) used for the scan. In general, it defines the command which is executed, the service name and relevant service macros
- Obsolete service action: defines the action to be carried out when a configured service is no longer available in the scan results. Choosing Default uses the global discovery settings.
Additional information
- Status: enable or disable job
- Comments: notes to further describe job
Periods
- Periods: set days and hours for the Auto Discovery. Leave days and hour empty to use Auto Discovery Defaults. Press Add new period to schedule the execution of jobs over several time periods.
Click Save to add the job
Job Execution
Jobs run automatically, depending on their configured schedule.
It is also possible to force an immediate job execution by selecting one or more the desired jobs and choosing Schedule immediate discovery (Forced) from the More Actions drop down of the Auto Discovery Service Jobs List