Poll Callback Reference

Introduction

Poll callbacks are the driving force behind Nagios Fusion. A poll callback is registered, which tells Fusion which types of servers and what type of data to poll from them.

Without the flexibility and power of poll callbacks, Fusion would grab all of the data from every server (for each user individually mapped) every <polling period>!

Note on testing: Be careful with poll callbacks. They are flexible, but they are also very powerful and therefore dangerous. We don't recommend developing new components on production servers with mission critical data. However, you will almost certainly need a system set up with some enabled fused servers for testing your poll callbacks.

You can test the output of the poll callbacks by utilizing the polling subsystem cron job and the --debug flag. As an example let us say we have a remote server (server id: 1) fused with the nagiosadmin user - then our debug statement would look like this:

/usr/local/nagiosfusion/cron/poll_subsys.php --debug --server 1 --user nagiosadmin

You can redirect the output to another file as the output may scroll well past your terminal's buffer. When utilizing the --debug flag, the polled data is not entered into the database, and does not effect the state of the servers/data in any way.

The data you're looking for is literally the array of the [data] element. Everything that your poll callback functions return is merged into this array, and ultimately added to the database (when not debugging). The common employed workflow is as follows:

1. Create a component registering a poll callback
2. Ensure that the component is installed properly by viewing it in the 'Manage Components' page
3. Run the polling subsystem with the debug flag
4. Adjust your component until you receive the desired results
5. Repeat steps 2-4 ad nauseum

When you register a poll callback, the function that you register needs to accept an array as an argument (the $raw_data of the type of the data you're polling) and must return an array of data to be merged and entered into the database. A good place to look is nagiosfusion/html/includes/components/fusioncore/poll_callbacks if you get stuck or need some ideas. Also keep in mind that if you accept the $raw_data by reference you can alter the data passed to the rest of the poll callbacks that are registered to that poll type.

Details

POLL_TYPE_HOSTSTATUS

api/v1/objects/hoststatus

backend/?cmd=getHostStatus

statusjson.cgi?query=hostlist&details=true

POLL_TYPE_SERVICESTATUS

api/v1/objects/servicestatus

backend/?cmd=getServiceStatus

statusjson.cgi?query=servicelist&details=true

POLL_TYPE_ALERTS

api/v1/objects/logentries&logentry_type=in:{NSLOG_HOST_UP,NSLOG_HOST_DOWN,NSLOG_HOST_UNREACHABLE,NSLOG_SERVICE_OK,NSLOG_SERVICE_WARNING,NSLOG_SERVICE_CRITICAL,NSLOG_SERVICE_UNKNOWN}

backend/?cmd=getLogEntries&logentry_type=in:{NSLOG_HOST_UP,NSLOG_HOST_DOWN,NSLOG_HOST_UNREACHABLE,NSLOG_SERVICE_OK,NSLOG_SERVICE_WARNING,NSLOG_SERVICE_CRITICAL,NSLOG_SERVICE_UNKNOWN}

archivejson.cgi?query=alertlist

api/backend/nagioslogserver/alert/_search/

POLL_TYPE_NOTIFICATIONS

api/v1/objects/logentries&logentry_type=in:{NSLOG_HOST_NOTIFICATION,NSLOG_SERVICE_NOTIFICATION}

backend/?cmd=getLogEntries&logentry_type=in:{NSLOG_HOST_NOTIFICATION,NSLOG_SERVICE_NOTIFICATION}

archivejson.cgi?query=notificationlist

POLL_TYPE_COMMENT

api/v1/objects/comment

backend/?cmd=getComments

statusjson.cgi?query=commentlist

POLL_TYPE_DOWNTIME

api/v1/objects/downtime

backend/?cmd=getScheduledDowntime

statusjson.cgi?query=downtimelist

POLL_TYPE_CONTACT

api/v1/objects/contact

backend/?cmd=getContacts

objectjson.cgi?query=contactlist&details=true

POLL_TYPE_HOST

api/v1/objects/host

backend/?cmd=getHosts

objectjson.cgi?query=hostlist&details=true

POLL_TYPE_SERVICE

api/v1/objects/services

backend/?cmd=getServices

objectjson.cgi?query=servicelist&details=true

POLL_TYPE_HOSTGROUP

api/v1/objects/hostgroup

backend/?cmd=getHostgroups

objectjson.cgi?query=hostgrouplist&details=true

POLL_TYPE_SERVICEGROUP

api/v1/objects/servicegroup

backend/?cmd=getServicegroups

objectjson.cgi?query=servicegrouplist&details=true

POLL_TYPE_CONTACTGROUP

api/v1/objects/contactgroup

backend/?cmd=getContactgroups

objectjson.cgi?query=contactgrouplist&details=true

POLL_TYPE_HOSTGROUPMEMBERS

api/v1/objects/hostgroupmembers

backend/?cmd=getHostgroupMembers

objectjson.cgi?query=hostgrouplist&details=true

POLL_TYPE_SERVICEGROUPMEMBERS

api/v1/objects/servicegroupmembers

backend/?cmd=getServicegroupMembers

objectjson.cgi?query=servicegrouplist&details=true

POLL_TYPE_CONTACTGROUPMEMBERS

api/v1/objects/contactgroupmembers

backend/?cmd=getContactgroupMembers

objectjson.cgi?query=contactgrouplist&details=true

POLL_TYPE_STATUS

api/v1/system/status

backend/?cmd=getProgramStatus

statusjson.cgi?query=programstatus

POLL_TYPE_USER

api/v1/system/user

backend/?cmd=getUsers

api/user/get_all_users

POLL_TYPE_ALERT_HISTORY

api/backend/nagioslogserver_history/_search/?sort=ran:&size=

POLL_TYPE_CLUSTER_HEALTH

api/backend/_cluster/health

POLL_TYPE_CLUSTER_STATS

api/backend/_cluster/stats

POLL_TYPE_INDEX_STATS

api/backend/_all/_stats/docs,store,indexing,get,search/

POLL_TYPE_SNMP_RECEIVERS

api/check/get_snmp_receivers

POLL_TYPE_NRDP_SERVERS

api/check/get_snmp_receivers

POLL_TYPE_INFO

api/v1/system/info