PF Sense

Plugin: go.d.plugin Module: snmp

Overview

Monitor PF Sense (network device) with Netdata over SNMP. Netdata recognizes the device automatically by its sysObjectID (recognized across 1 device identifiers) and collects the metrics this profile declares — on top of the generic SNMP baseline — with no manual OID configuration.

Netdata's SNMP collector matches the device to the pf-sense.yaml profile via sysObjectID/sysDescr, then polls the OIDs it declares.

This integration is supported on all platforms.

This integration supports multiple instances configured side-by-side.

Default Behavior

Auto-Detection

Auto-detected as PF Sense via sysObjectID/sysDescr.

Limits

The default configuration for this integration does not impose any limits.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Setup

You can configure the snmp collector in two ways:

Method	Best for	How to
UI	Fast setup without editing files	Go to Nodes → Configure this node → Collectors → Jobs, search for snmp, then click + to add a job.
File	If you prefer configuring via file, or need to automate deployments (e.g., with Ansible)	Edit go.d/snmp.conf and add a job.

important

UI configuration requires paid Netdata Cloud plan.

Prerequisites

SNMP access

SNMP must be enabled on the device and reachable from the Netdata Agent acting as the site's SNMP hub.

Configuration

Options

Configure the SNMP collector with the device hostname and SNMP credentials. See the SNMP collector reference for all options.

via UI

Configure the snmp collector from the Netdata web interface:

1. Go to Nodes.
2. Select the node where you want the snmp data-collection job to run and click the ⚙ (Configure this node). That node will run the data collection.
3. The Collectors → Jobs view opens by default.
4. In the Search box, type snmp (or scroll the list) to locate the snmp collector.
5. Click the + next to the snmp collector to add a new job.
6. Fill in the job fields, then click Test to verify the configuration and Submit to save.
   • Test runs the job with the provided settings and shows whether data can be collected.
   • If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.

via File

The configuration file name for this integration is go.d/snmp.conf.

The file format is YAML. Generally, the structure is:

update_every: 1
autodetection_retry: 0
jobs:
  - name: some_name1
  - name: some_name2

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/snmp.conf

Examples

There are no configuration examples.

Alerts

There are no alerts configured by default for this integration.

Metrics

On top of the generic SNMP baseline (the Generic SNMP Device integration — interfaces, system, IP/TCP/UDP, host resources), this PF Sense profile adds the metrics below. Each is collected only where the device exposes the matching OID — inclusion means the profile requests it; availability depends on the device model and software.

38 metrics in 7 groups; each row is a chart context usable in alerts.

Group	Metrics
Network / Interface	4
System / Activity	2
System / CPU	3
System / Disk	15
System / Memory	11
System / Uptime	1
Uncategorized	2

Network / Interface

Metric (chart context)	Unit	Scope	Description
snmp.device_prof_ifAdminStatus	{status}	per interface, interface	Current administrative state of the interface
snmp.device_prof_ifHighSpeed	bit/s	per interface, interface	Estimate of the interface's current bandwidth
snmp.device_prof_ifNumber	{interface}	device	Number of network interfaces regardless of their current state present on this system
snmp.device_prof_ifOperStatus	{status}	per interface, interface	Current operational state of the interface

System / Activity

Metric (chart context)	Unit	Scope	Description
snmp.device_prof_hrSystemNumUsers	{session}	device	The number of user sessions for which this host is storing state information. A session is a collection of processes requiring a s…
snmp.device_prof_hrSystemProcesses	{process}	device	The number of process contexts currently loaded or running on this system.

System / CPU

Metric (chart context)	Unit	Scope	Description
snmp.device_prof_cpu_usage	%	per cpu_index	The current CPU utilization
snmp.device_prof_ucd_ssRawContexts	{switch}/s	device	Number of context switches
snmp.device_prof_ucd_ssRawInterrupts	{interrupt}/s	device	Number of interrupts processed

System / Disk

Metric (chart context)	Unit	Scope	Description
snmp.device_prof_ucd_diskIOLA1	%	per ucd_disk_io_device	The 1 minute average load of disk (%)
snmp.device_prof_ucd_diskIOLA15	%	per ucd_disk_io_device	The 15 minute average load of disk (%)
snmp.device_prof_ucd_diskIOLA5	%	per ucd_disk_io_device	The 5 minute average load of disk (%)
snmp.device_prof_ucd_diskIONReadX	By/s	per ucd_disk_io_device	The number of bytes read from this device since boot
snmp.device_prof_ucd_diskIONWrittenX	By/s	per ucd_disk_io_device	The number of bytes written to this device since boot
snmp.device_prof_ucd_diskIOReads	{read}/s	per ucd_disk_io_device	The number of read accesses from this device since boot
snmp.device_prof_ucd_diskIOWrites	{write}/s	per ucd_disk_io_device	The number of write accesses to this device since boot
snmp.device_prof_ucd_dskAvail	By	per ucd_dsk_path, ucd_dsk_device	Available space on the disk
snmp.device_prof_ucd_dskErrorFlag	{status}	per ucd_dsk_path, ucd_dsk_device	Flag signaling that the disk or partition is under the minimum required space configured for it
snmp.device_prof_ucd_dskPercent	%	per ucd_dsk_path, ucd_dsk_device	Percentage of space used on disk
snmp.device_prof_ucd_dskPercentNode	%	per ucd_dsk_path, ucd_dsk_device	Percentage of inodes used on disk
snmp.device_prof_ucd_dskTotal	By	per ucd_dsk_path, ucd_dsk_device	Total size of the disk/partition
snmp.device_prof_ucd_dskUsed	By	per ucd_dsk_path, ucd_dsk_device	Used space on the disk
snmp.device_prof_ucd_ssIORawReceived	By/s	device	Amount of data read from disk or other block device
snmp.device_prof_ucd_ssIORawSent	By/s	device	Amount of data written to disk or other block device

System / Memory

Metric (chart context)	Unit	Scope	Description
snmp.device_prof_memory_free	By	device	The amount of real/physical memory currently unused or available
snmp.device_prof_ucd_memAvailSwap	By	device	The amount of swap space currently unused or available
snmp.device_prof_ucd_memBuffer	By	device	The total amount of real or virtual memory currently allocated for use as memory buffers
snmp.device_prof_ucd_memCached	By	device	The total amount of real or virtual memory currently allocated for use as cached memory
snmp.device_prof_ucd_memMinimumSwap	By	device	The minimum amount of swap space expected to be kept free or available during normal operation of this host
snmp.device_prof_ucd_memShared	By	device	The total amount of real or virtual memory currently allocated for use as shared memory
snmp.device_prof_ucd_memTotalFree	By	device	The total amount of memory free or available for use on this host
snmp.device_prof_ucd_memTotalSwap	By	device	The total amount of swap space configured for this host
snmp.device_prof_ucd_memoryTotal	By	device	The total amount of real/physical memory installed on this host
snmp.device_prof_ucd_ssRawSwapIn	By/s	device	Amount of memory swapped in from disk
snmp.device_prof_ucd_ssRawSwapOut	By/s	device	Amount of memory swapped out to disk

System / Uptime

Metric (chart context)	Unit	Scope	Description
snmp.device_prof_systemUptime	s	device	Time since the system was last rebooted or powered on.

Uncategorized

Metric (chart context)	Unit	Scope	Description
snmp.device_prof_hrStorageSize	By	per storage_index, rm:storage_type, rm:storage_alloc_unit
snmp.device_prof_hrStorageUsed	By	per storage_index, rm:storage_type, rm:storage_alloc_unit