dpdkevents plugin¶

See this section in the full configuration reference

The dpdkevents plugin collects events from DPDK such as link status of network ports and Keep Alive status of DPDK logical cores. In order to get Keep Alive events following requirements must be met: - DPDK >= 16.07 - support for Keep Alive implemented in DPDK application. More details can be found here: http://dpdk.org/doc/guides/sample_app_ug/keep_alive.html

Synopsis:

<Plugin "dpdkevents">
  <EAL>
    Coremask "0x1"
    MemoryChannels "4"
    FilePrefix "rte"
  </EAL>
  <Event "link_status">
    SendEventsOnUpdate true
    EnabledPortMask 0xffff
    PortName "interface1"
    PortName "interface2"
    SendNotification false
  </Event>
  <Event "keep_alive">
    SendEventsOnUpdate true
    LCoreMask "0xf"
    KeepAliveShmName "/dpdk_keepalive_shm_name"
    SendNotification false
  </Event>
</Plugin>

Options:

The EAL block¶

Coremask Mask

Memorychannels Channels

Number of memory channels per processor socket.

FilePrefix File

The prefix text used for hugepage filenames. The filename will be set to /var/run/.<prefix>_config where prefix is what is passed in by the user.

The Event block¶

The Event block defines configuration for specific event. It accepts a single argument which specifies the name of the event.

Link Status event¶

SendEventOnUpdate true|false

If set to true link status value will be dispatched only when it is different from previously read value. This is an optional argument - default value is true.

EnabledPortMask Mask

A hexidecimal bit mask of the DPDK ports which should be enabled. A mask of 0x0 means that all ports will be disabled. A bitmask of all F's means that all ports will be enabled. This is an optional argument - by default all ports are enabled.

PortName Name

A string containing an optional name for the enabled DPDK ports. Each PortName option should contain only one port name; specify as many PortName options as desired. Default naming convention will be used if PortName is blank. If there are less PortName options than there are enabled ports, the default naming convention will be used for the additional ports.

SendNotification true|false

If set to true, link status notifications are sent, instead of link status being collected as a statistic. This is an optional argument - default value is false.

Keep Alive event¶

SendEventOnUpdate true|false

If set to true keep alive value will be dispatched only when it is different from previously read value. This is an optional argument - default value is true.

LCoreMask Mask

An hexadecimal bit mask of the logical cores to monitor keep alive state.

KeepAliveShmName Name

Shared memory name identifier that is used by secondary process to monitor the keep alive cores state.

SendNotification true|false

If set to true, keep alive notifications are sent, instead of keep alive information being collected as a statistic. This is an optional argument - default value is false.