NDM Profiles

Docs > Network Monitoring > Network Device Monitoring > NDM Profiles

Overview

Network Device Monitoring uses profiles to tell the Datadog Agent the metrics and associated tags to collect. A profile is a collection of OIDs associated with a device.

Configuration

By default, all profiles in the Agent configuration directory are loaded. To customize the specific profiles for collection, explicitly reference them by filename under definition_file, or provide an inline list under definition. Any of the Datadog profiles can be listed by name. Additional custom profiles can be referenced by the file path in the config, or placed in the configuration directory.

Note: The generic profile is generic-device.yaml, which supports routers, switches, etc.

sysOID mapped devices

Profiles allow Network Device Monitoring to reuse metric definitions across several device types or instances. Profiles define metrics the same way as instances, either inline in the configuration file or in separate files. Each instance can only match a single profile. For example, you can define a profile in the init_config section:

init_config:
  profiles:
    my-profile:
      definition:
        - MIB: IP-MIB
          table: ipSystemStatsTable
          symbols:
            - ipSystemStatsInReceives
          metric_tags:
            - tag: ipversion
          index: 1
      sysobjectid: '1.3.6.1.4.1.8072.3.2.10'

Then either reference it explicitly by name, or use sysObjectID detection:

instances:
   - ip_address: 192.168.34.10
     profile: my-profile
   - ip_address: 192.168.34.11
     # Don't need anything else here, the check will query the sysObjectID
     # and use the profile if it matches.

If necessary, additional metrics can be defined in the instances. These metrics are collected in addition to those in the profile.

Metric definition by profile

Profiles can be used interchangeably, meaning devices that share MIB dependencies can reuse the same profiles. For example, the Cisco c3850 profile can be used across many Cisco switches.

For more Datadog provided profiles, see the GitHub repository.

Metadata definition by profile

In the profiles’s metadata section, you can define where and how metadata is collected. Values can be static or come from an OID value. See the DeviceMetadata section for the supported fields.

With Datadog Agent version 7.52 and later, there is a device_type field for device metadata. This can be set manually in the profile and can be used to filter on specific types of devices. Accepted values include: