Skip to main content

Peplink

Plugin: go.d.plugin Module: snmp

Overview

Monitor Peplink (router) with Netdata over SNMP. Netdata recognizes the device automatically by its sysObjectID (recognized across 2 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 peplink.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 Peplink 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:

MethodBest forHow to
UIFast setup without editing filesGo to Nodes → Configure this node → Collectors → Jobs, search for snmp, then click + to add a job.
FileIf 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 Peplink 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.

25 metrics in 11 groups; each row is a chart context usable in alerts.

GroupMetrics
Hardware / Fan2
Hardware / Power3
Hardware / Temperature2
Network / Interface4
Network / Link3
Network / WAN3
System / Activity2
System / CPU1
System / Memory2
System / Uptime1
Uncategorized2

Hardware / Fan

Metric (chart context)UnitScopeDescription
snmp.device_prof_deviceFanStatus{status}per device_fan_idDevice fan status
snmp.device_prof_peplink_deviceFanSpeed{revolution}/minper device_fan_idDevice fan speed

Hardware / Power

Metric (chart context)UnitScopeDescription
snmp.device_prof_devicePSUStatus{status}per device_psu_idDevice psu status
snmp.device_prof_devicePowerSourceStatus{status}per device_power_source_id, device_power_source_namePower source status
snmp.device_prof_peplink_devicePSUPercentage%per device_psu_idDevice psu percentage

Hardware / Temperature

Metric (chart context)UnitScopeDescription
snmp.device_prof_peplink_deviceTemperatureCelsiusCeldeviceDevice temperature celsius
snmp.device_prof_peplink_deviceTemperatureFahrenheitdegFdeviceDevice temperature fahrenheit

Network / Interface

Metric (chart context)UnitScopeDescription
snmp.device_prof_ifAdminStatus{status}per interface, interfaceCurrent administrative state of the interface
snmp.device_prof_ifHighSpeedbit/sper interface, interfaceEstimate of the interface's current bandwidth
snmp.device_prof_ifNumber{interface}deviceNumber of network interfaces regardless of their current state present on this system
snmp.device_prof_ifOperStatus{status}per interface, interfaceCurrent operational state of the interface
Metric (chart context)UnitScopeDescription
snmp.device_prof_peplink_linkDataTransferredBy/sper link_conn_num, link_nameNumber of bytes transferred through
snmp.device_prof_peplink_linkThroughputIn{packet}/sper link_conn_num, link_nameNumber of inbound packets discarded to free buffer space
snmp.device_prof_peplink_linkThroughputOut{packet}/sper link_conn_num, link_nameNumber of outbound packets discarded to free buffer space

Network / WAN

Metric (chart context)UnitScopeDescription
snmp.device_prof_peplink_wanUsageDataTransferredBy/sper wan_usage_indexNumber of bytes transferred through
snmp.device_prof_peplink_wanUsageThroughputIn{packet}/sper wan_usage_indexNumber of inbound packets discarded to free buffer space
snmp.device_prof_peplink_wanUsageThroughputOut{packet}/sper wan_usage_indexNumber of outbound packets discarded to free buffer space

System / Activity

Metric (chart context)UnitScopeDescription
snmp.device_prof_hrSystemNumUsers{session}deviceThe 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}deviceThe number of process contexts currently loaded or running on this system.

System / CPU

Metric (chart context)UnitScopeDescription
snmp.device_prof_cpu_usage%per cpu_indexThe current CPU utilization

System / Memory

Metric (chart context)UnitScopeDescription
snmp.device_prof_memory_totalBydeviceTotal memory
snmp.device_prof_memory_usage%deviceMemory usage

System / Uptime

Metric (chart context)UnitScopeDescription
snmp.device_prof_systemUptimesdeviceTime since the system was last rebooted or powered on.

Uncategorized

Metric (chart context)UnitScopeDescription
snmp.device_prof_hrStorageSizeByper storage_index, rm:storage_type, rm:storage_alloc_unit
snmp.device_prof_hrStorageUsedByper storage_index, rm:storage_type, rm:storage_alloc_unit

Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.