Bindplane

The Bindplane Developer Hub

Welcome to the Bindplane developer hub. You'll find comprehensive guides and documentation to help you start working with Bindplane as quickly as possible, as well as support if you get stuck. Let's jump right in!

Nagios XI

Monitor Nagios XI Attatched Infrastructure

📘

Not Included in the BindPlane with Google Stackdriver offering

All of the Google Cloud Platform sources listed within this documentation are not included with the BindPlane with Google Stackdriver offering.

Data Collection Setup

Metrics are collected via REST API from Nagios XI monitoring systems

Network Requirements

Port: 443 (TCP) HTTPS to Nagios XI REST API

Least Privileged User

Bindplane requires a least-privileged user (LPU) account of read-only

Finding the API Key

The API keys in Nagios XI are bound to a user account. Generate and find the key in the user information.

Note API Key in User Account Information

🚧

Admin Required for Certain Metrics

A Nagios Admin account is required in order to collect the following Nagios System Status and User Configuration metrics:

  • Active Host Checks Enabled
  • Active Service Checks Enabled
  • Event Handlers Enabled
  • Is Currently Running
  • Notifications Enabled
  • Passive Host Checks Enabled
  • Passive Service Checks Enabled

Supported Versions

Nagios XI: 5.3.x+

Connection Parameters

NameRequired?Description
HostRequired
Port
UsernameRequired
API KeyRequiredAPI key for the Nagios system.
SSL Configuration
Collect EventsWhether or not to collect events.
Minimum Event SeverityMinimum severity of events to collect.
Services WhitelistComma separated list of services to collect. Otherwise, all.
Timeout In SecondsTimeout (in seconds) for requests to the API.
Max ThreadsMaximum simultaneous requests

Metrics

Host

NameDescription
Active Checks EnabledTODO
AddressThe address of the Host resource.
AliasTODO
Check TypeTODO
Idle CPU (%)The aggregated value of 'Idle' metrics from child Service resources.
IO Wait (%)The aggregated value of 'IO Wait' metrics from child Service resources.
System CPU Use (%)The aggregated value of 'System' metrics from child Service resources.
Used CPU (%)The aggregated value of User, System, and IO Wait metrics from child Service resources.
User CPU Use (%)The aggregated value of 'User' metrics from child Service resources.
Current AttemptTODO
Current StateTODO
Disk Free (Megabytes)The aggregated value of 'Free' metrics from child Service resources.
Disk Size (Megabytes)The aggregated value of 'Total' metrics from child Service resources.
Disk Used (Megabytes)The aggregated value of 'Used' metrics from child Service resources.
DurationTODO
Event Handler EnabledTODO
Execution Time (Seconds)TODO
Flap Detection EnabledTODO
Host NameThe name of the Host resource.
Last CheckTODO
Last NotificationTODO
Last State ChangeTODO
Latency (Seconds)TODO
Buffers and Cached Memory (Megabytes)The aggregated value of 'Buffers and Cached' metrics from child Service resources.
Free Memory (Megabytes)The aggregated value of 'Free' metrics from child Service resources.
Shared Memory (Megabytes)The aggregated value of 'Shared' metrics from child Service resources.
Total Memory (Megabytes)The aggregated value of 'Total' metrics from child Service resources.
Used Memory (Megabytes)The aggregated value of 'Used' metrics from child Service resources.
Next CheckTODO
Notifications EnabledTODO
Obsession EnabledTODO
Parent SystemThe parent system of the host resource.
Passive Checks EnabledTODO
Problem AcknowledgedWhether or not the problem has been acknowledged.
Performance Data Processing EnabledTODO
Service Problem CountThe total number of Service descendants whose status is not 'OK'.
Services CountThe number of Service descendants of this resource.
Status InformationTODO

Host Group

NameDescription
AliasThe alias of the Host resource.
Average CPU Use (from Host descendants) (%)The average CPU used across all Host descendants.
Maximum CPU Use (from Host descendants) (%)The maximum CPU used across all Host descendants.
Minimum CPU Use (from Host descendants) (%)The minimum CPU used across all Host descendants.
Average Disk Use (from Host descendants) (Megabytes)The average disk used across all Host descendants.
Maximum Disk Use (from Host descendants) (Megabytes)The maximum disk used across all Host descendants.
Minimum Disk Use (from Host descendants) (Megabytes)The minimum disk used across all Host descendants.
Total Disk Space (from Host descendants) (Megabytes)The total disk used across all Host descendants.
Used Total Disk Use (from Host descendants) (Megabytes)The total disk used across all Host descendants.
Host Problem CountThe total number of Host descendants whose status is not 'OK'.
Host Unhandled Problem CountThe total number of Host descendants whose status is not 'OK' and have an unacknowledged problem.
Host Group NameThe group name of the Host resource.
Host CountThe total number of Host descendants.
Host Down CountThe total number of Host descendants where status is down.
Host Pending CountThe total number of Host descendants where status is pending.
Host Unreachable CountThe total number of Host descendants where status is unreachable.
Host Up CountThe total number of Host descendants where status is up.
Average Memory Use (from Host descendants) (Megabytes)The average memory used across all Host descendants.
Maximum Memory Use (from Host descendants) (Megabytes)The maximum memory used across all Host descendants.
Minimum Memory Use (from Host descendants) (Megabytes)The minimum memory used across all Host descendants.
Total Memory Capacity (from Host descendants) (Megabytes)The total memory across all Host descendants.
Used Total Memory Use (from Host descendants) (Megabytes)The total memory used across all Host descendants.
Parent SystemThe parent system of the host group resource.

Service

NameDescription
Check Latency (Milliseconds)The latency of this Service on the associated Host resource.
StateThe current state of the Service resource.
Execution Time (Seconds)The execution time of the latest status check for this Service on the associated Host resource.
Host NameThe address of the Service resource.
Last CheckThe time of the last state change of the Service resource.
Parent SystemThe parent system of the service resource.
Performance DataThe performance data returned from the latest status check for this Service on the associated Host resource.
Problem AcknowledgedIf there is a problem, whether or not it is acknowledged.
Service DescriptionThe description of the Service resource.
Status TextThe status text of the latest status check for this Service resource on the associated Host resource.

Service Group

NameDescription
AliasThe alias of the Service Group.
Host Problem CountThe total number of problems in the Service Group.
Host CountThe total number of hosts in Service Group
Host Down CountThe total number of hists in the Service Group where status is down.
Host Pending CountThe total number of hosts in the Service Group where status is pending.
Host Unhandled Problems CountThe total number of host problems in the Service Group that are unhandled.
Host Unreachable CountThe total number of hosts in the Service Group where stauts is unreachable
Host Up CountThe total number of hosts in the Service Group where status is up.
Parent SystemThe parent system of the service group resource.
Service Group NameThe group name of the Service Group.
Service CountThe total number of services in the Service Group
Service Critical CountThe total number of services in the Service Group where status is critical.
Service OK CountThe total number of services in the Service Group where status is okay.
Service Pending CountThe total number of services in the Service Group where status is pending.
Service Problem CountThe total number of service problems in the Service Group
Service Unhandled Problem CountThe total number of service problems in the Service Group that are unhandled.
Service Unknown CountThe total number of services in the Service Group where status is unknown.
Service Warning CountThe total number of services in the Service Group where status is warning.

System

NameDescription
Active Host Checks EnabledWhether or not active host checks are enabled.
Active Service Checks EnabledWhether or not active service checks are enabled.
Average CPU Use (from Host children) (%)The average CPU used across all Host children.
Maximum CPU Use (from Host children) (%)The maximum CPU used across all Host children.
Minimum CPU Use (from Host children) (%)The minimum CPU used across all Host children.
Average Disk Use (from Host children) (Megabytes)The average disk used across all Host children.
Maximum Disk Use (from Host children) (Megabytes)The maximum disk used across all Host children.
Minimum Disk Use (from Host children) (Megabytes)The minimum disk used across all Host children.
Total Disk Capacity (from Host children) (Megabytes)The total disk capacity across all Host children.
Total Disk Use (from Host children) (Megabytes)The total disk used across all Host children.
Event Handlers EnabledWhether or not event handlers are enabled.
Host CountNumber of hosts within this system.
Host Down CountNumber of hosts within this system that are down.
Host Pending CountNumber of hosts within this system that are unreachable.
Host Problem CountNumber of host problems within this system.
Host Unhandled Problem CountNumber of unhandled host problems within this system.
Host Unreachable CountNumber of hosts within this system that are unreachable.
Host Up CountNumber of hosts within this system that are up.
HostnameHostname of the Nagios System.
Is Currently RunningWhether or not the system is currently running.
Average Memory Use (from Host children) (Megabytes)The average memory used across all Host children.
Maximum Memory Use (from Host children) (Megabytes)The maximum memory used across all Host children.
Minimum Memory Use (from Host children) (Megabytes)The minimum memory used across all Host children.
Total Memory Capacity (from Host children) (Megabytes)The total memory across all Host children.
Total Memory Use (from Host children) (Megabytes)The total memory used across all Host children.
Notifications EnabledWhether or not notifications are enabled.
Passive Host Checks EnabledWhether or not passive host checks are enabled.
Passive Service Checks EnabledWhether or not passive service checks are enabled.
Service CountNumber of services within this system.
Service Critical CountNumber of hosts within this system that have state 'critical'.
Service Pending CountNumber of hosts within this system that have state 'pending'.
Service Problem CountNumber of service problems within this system.
Service Unhandled Problem CountNumber of unhandled service problems within this system.
Service Unknown CountNumber of hosts within this system that have state 'unknown'.
Service OK CountNumber of hosts within this system that have state 'OK'.
Service Warning CountNumber of hosts within this system that have state 'warning'.

Updated 8 months ago

Nagios XI


Monitor Nagios XI Attatched Infrastructure

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.