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!

Host

Windows & Linux Host - OS Monitoring

Data Collection Setup

Deployment for this Source is different than others for data collection, as the OS metrics are collected locally from the Data Collector.

Least Privileged User

No additional LPU setup is required. Collection is done with the services user that they BindPlane collection processes are run under.

Network Requirements

Collection is local and not additional network access is required.

Supported Versions

*Windows, All Editions, including Core Supported for:
Windows 2008 R2, 2012 R2, 2016, 2019

*Linux:
Centos/RHEL/OEL 6.x & 7.x
SLES 15
Ubunu 14/16/18
Debian 9

Connection Parameters

NameRequired?Description
Collect DisksConfigure Monitoring of Disks, See metrics for more details
Collect Disk PartitionsConfigure Monitoring of Disk Partitions, See metrics for more details
Collect File SystemConfigure Monitoring o File Systems, See metrics for more details
Collect File StoresConfigure Monitoring of File Stores, See metrics for more details
Collect ProcessesConfigure Monitoring of Processes, See metrics for more details
Collect Power SourcesConfigure Monitoring of Power Sources, See metrics for more details
Maximum Process CountThe maximum number of processes to collect. Specify a value of '0' to collect all.
Order Processes By
Process FilterA Java Regex. Only processes whose command line matches this regex will be returned.

Metrics

CPU

NameDescription
Context SwitchesThe number of context switches which have occurred.
FamilyThe family of the CPU.
HostnameThe hostname of the system.
IDThe Processor ID. This is a hexidecimal string representing an 8-byte value, normally obtained using the CPUID opcode with the EAX register set to 1. The first four bytes are the resulting contents of the EAX register, which is the Processor signature.
IdentifierIdentifier, eg. x86 Family 6 Model 15 Stepping 10.
Idle Utilization (%)Time that the CPU or CPUs were idle and the system did not have an outstanding disk I/O request.
InterruptsThe number of interrupts which have occurred.
I/O Wait Utilization (%)Time that the CPU or CPUs were idle during which the system had an outstanding disk I/O request.
IRQ Utilization (%)Time that the CPU used to service hardware IRQs.
Is 64 Bit?True if CPU is 64 Bit, else false.
Logical ProcessorsThe number of logical CPUs available for processing.
ModelThe model of the CPU.
NameName of the CPU, eg. Intel(R) Core(TM)2 Duo CPU T7300 @ 2.00GHz.
Nice Utilization (%)CPU utilization that occurred while executing at the user level with nice priority.
Physical PackagesThe number of packages/sockets in the system.
Physical ProcessorsThe number of physical CPUs/cores available for processing.
Software IRQ Utilization (%)Time that the CPU used to service soft IRQs.
Steal Utilization (%)Time which the hypervisor dedicated for other guests in the system. Only supported on Linux.
SteppingThe stepping of the CPU that is installed.
System Load (%)The recent cpu usage for the whole system; negative if unavailable.
System Load Average (Last 15 Minutes)Sum of the queued and running entities over the last 15 minutes; negative if unavailable.
System Load Average (Last 5 Minutes)Sum of the queued and running entities over the last 5 minutes; negative if unavailable.
System Load Average (Last Minute)Sum of the queued and running entities over the last minute; negative if unavailable.
System Load Between Ticks (%)The recent cpu usage for the whole system by polling every second.
System Up-time (Seconds)Amount of time since last boot.
System Utilization (%)CPU utilization that occurred while executing at the system level (kernel).
Temperature (Celsius)CPU Temperature if available, 0 otherwise.
User Utilization (%)CPU utilization that occurred while executing at the user level.
Utilization (%)Aggregate of CPU utilization that was not spent idle.
VendorThe vendor of the CPU.
Vendor Frequency (Hertz)Frequency or -1 if unknown.
Voltage (Volts)CPU Voltage if available, 0 otherwise.

Disk

NameDescription
HostnameThe hostname of the system.
ModelThe manufacturer's model name and number.
NameThe name of the disk.
Read Size (Bytes)Size of reads from disk.
Reads (Reads)Number of reads from disk.
SerialThe serial number of the disk.
Size (Bytes)The total size of the disk.
Transfer Time (Milliseconds)The time spent reading or writing.
Write Size (Bytes)Size of writes to disk.
Writes (Writes)Number of writes to disk.

Disk Partition

NameDescription
HostnameThe hostname of the system.
IdentifierThe unique partition id.
Major IDDevice ID (Major).
Minor IDDevice ID (Minor).
Mount PointThe location where the partition is mounted.
NameThe name of the partition.
Size (Bytes)Total size of the partition.
TypeType of description of the partition.
UUIDUUID of the partition.

File Store

NameDescription
DescriptionA description of the file store.
Free Space (Bytes)The amount of usable space of the file store.
HostnameThe hostname of the system.
Logical VolumeThe logical volume of the file store.
Mount PointThe mountpoint of the file store.
NameThe name of the file store.
Total Space (Bytes)Total size of the file store.
TypeThe partition type of the file store (FAT, NTFS, ext2, ext4, etc.).
Utilization (%)The amount of usable space that the file store is utilizing.
UUIDUUID or GUID of the file store.
VolumePartition where this file store is located.

File System

NameDescription
HostnameThe hostname of the system.
Maximum File DescriptorsThe maximum number of open file descriptors.
Open File Descriptor Utilization (%)The current utilization of open file descriptors.
Open File DescriptorsThe current number of open file descriptors.

Host

NameDescription
BitnessThe bitness of the operating system (either 32 or 64 bit).
DNS ServersThe DNS servers that are set.
DomainThe domain that the system belongs to.
FamilyThe family of the operating system.
IPv4 Default GatewayThe default gateway(routing destination for 0.0.0.0/0) for IPv4, empty string if not defined.
IPv6 Default GatewayThe default gateway(routing destination for ::/0) for IPv6, empty string if not defined.
ManufacturerThe manufacturer of the operating system.
NameThe hostname of the system.
Processes (Processes)The number of processes currently running.
Thread Count (Threads)The number of threads currently running.
VersionThe version of the operating system.

Memory

NameDescription
Available (Bytes)The amount of physical memory currently available.
HostnameThe hostname of the system.
Page Size (Bytes)Size of a page.
Swap Pages In (Pages)Number of pages read from paging/swap file(s).
Swap Pages Out (Pages)Number of pages written to paging/swap file(s).
Swap Used (Bytes)The current memory committed to the paging/swap file(s).
Swap Utilization (%)The current utilization of swap memory.
Total (Bytes)The amount of actual physical memory.
Total Swap (Bytes)The current size of the paging/swap file(s).
Used (Bytes)The amount of physical memory currently in use.
Utilization (%)The current utilization of memory.

Network Interface

NameDescription
Display NameDescription of the network interface. On some platforms, may be the same as name.
HostnameThe hostname of the system.
Inbound Errors (Errors)Number of inbound errors.
Inbound Packets (Packets)Number of packets received.
Inbound Throughput (Bytes)The total amount of data received using this network interface.
IPv4 AddressesThe IPv4 addresses assigned to the network interface.
IPv6 AddressesThe IPv6 addresses assigned to the network interface.
MAC AddressThe MAC address of the network interface.
MTU (Bytes)The MTU that is configured for the network interface.
NameThe name of the network interface according to the operating system.
Outbound Errors (Errors)Number of outbound errors.
Outbound Packets (Packets)Number of packets Sent.
Outbound Throughput (Bytes)The total amount of data sent using this network interface.
Speed (Bits per Second)The maximum speed of the network interface.

Process

NameDescription
Command LineThe process' command line text. The format of this string is platform-dependent.
Current Working DirectoryThe process' current working directory.
Data Read (Bytes)The amount of data the process has read from disk.
Data Written (Bytes)The amount of data the process has written to disk.
GroupThe group of the process. On Windows systems, populating this value for processes other than the current user requires administrative privileges (and still may fail for some system processes).
Group IDThe group ID of the process. On Windows systems, populating this value for processes other than the current user requires administrative privileges (and still may fail for some system processes).
HostnameThe hostname of the system.
IDThe ID of the process given by the operating system.
Kernel Time (Milliseconds)The amount of time the process has executed in kernel/system mode.
NameThe name of the process.
Open FilesThe number of open file handles (or network connections) that belongs to the process. -1 if unknown or not supported.
Parent Process IDThe parent process' ID, if any.
PathThe full filepath of the executing process.
PriorityThe priority of the process. For Linux and Unix, priority is a value in the range -20 to 19 (20 on some systems). The default priority is 0; lower priorities cause more favorable scheduling. For Windows, priority values can range from 0 (lowest priority) to 31 (highest priority). Mac OS X has 128 priority levels, ranging from 0 (lowest priority) to 127 (highest priority). They are divided into several major bands: 0 through 51 are the normal levels; the default priority is 31. 52 through 79 are the highest priority regular threads; 80 through 95 are for kernel mode threads; and 96 through 127 correspond to real-time threads, which are treated differently than other threads by the scheduler.
Resident Set Size (Bytes)The Resident Set Size (RSS). On Windows, returns the private working set size. It is used to show how much memory is allocated to that process and is in RAM. It does not include memory that is swapped out. It does include memory from shared libraries as long as the pages from those libraries are actually in memory. It does include all stack and heap memory.
Start Time (Milliseconds)The time at which the process started since the epoch.
StateThe execution state of the process. Either NEW, RUNNING, SLEEPING, WAITING, ZOMBIE, STOPPED, or OTHER (unknown).
Thread CountThe number of threads in this process.
Up Time (Milliseconds)The amount of time since the process has started.
UserThe user name that owns the process. On Windows systems, also returns the domain prepended to the username.
User IDThe userID. On Windows systems, returns the Security ID (SID).
User Time (Milliseconds)The amount of time the process has executed in user mode.
Virtual Size (Bytes)The Virtual Memory Size (VSZ). It includes all memory that the process can access, including memory that is swapped out and memory that is from shared libraries.

Updated 8 months ago

Host


Windows & Linux Host - OS Monitoring

Suggested Edits are limited on API Reference Pages

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