Viewing Netify Version v5

Telemetry via Sink Socket

The Netify Sockets interface enables the direct streaming of real-time network telemetry and metadata from the DPI engine to client applications. It supports TCP sockets, UDP sockets, WebSockets, and file sockets, providing flexible options for both persistent, low-latency connections and local inter-process communication. This approach is ideal for custom integrations, live dashboards, or systems that require streaming telemetry data.

For alternative methods of accessing network telemetry, see the related Netify Sink options.

License

The Netify Sink Socket plugin is open-source software. It can be licensed under the GPLv3 or a commercial license. Please contact us for details.

Installation

Netify plugins are distributed through the same packaging workflow as the Netify Agent, allowing for a consistent installation experience using standard package manager syntax. While pre-compiled binaries are readily available for x86_64 architectures via our public mirrors, support for ARM, MIPS, and other specialized architectures is available upon request. Please contact us for details.

Step 1 - Select your installation target:

Step 2 - Add Netify's package signing key and repository:

Terminal - Netify

×

sudo apt-get update
sudo apt-get -y install curl gnupg2
sudo curl https://download.netify.ai/5/debian/netify-archive-keyring.gpg -o /usr/share/keyrings/netify-archive-keyring.gpg
echo 'deb [signed-by=/usr/share/keyrings/netify-archive-keyring.gpg] http://download.netify.ai/5/debian/12/ /' | sudo tee /etc/apt/sources.list.d/netify.list

Step 3 - Install Netify Sink Socket:

Terminal - Netify

×

sudo apt update
sudo apt install netify-sink-socket

Step 2 - Add Netify's package signing key and repository:

Terminal - Netify

×

sudo apt-get update
sudo apt-get -y install curl gnupg2
sudo curl https://download.netify.ai/5/debian/netify-archive-keyring.gpg -o /usr/share/keyrings/netify-archive-keyring.gpg
echo 'deb [signed-by=/usr/share/keyrings/netify-archive-keyring.gpg] http://download.netify.ai/5/debian/11/ /' | sudo tee /etc/apt/sources.list.d/netify.list

Step 3 - Install Netify Sink Socket:

Terminal - Netify

×

sudo apt update
sudo apt install netify-sink-socket

Step 2 - Add Netify's package signing key and repository:

Terminal - Netify

×

sudo apt-get update
sudo apt-get -y install curl gnupg2
sudo curl https://download.netify.ai/5/debian/netify-archive-keyring.gpg -o /usr/share/keyrings/netify-archive-keyring.gpg
echo 'deb [signed-by=/usr/share/keyrings/netify-archive-keyring.gpg] http://download.netify.ai/5/debian/10/ /' | sudo tee /etc/apt/sources.list.d/netify.list

Step 3 - Install Netify Sink Socket:

Terminal - Netify

×

sudo apt update
sudo apt install netify-sink-socket

Step 2 - Add Netify's package signing key and repository:

Terminal - Netify

×

sudo apt-get update
sudo apt-get -y install curl gnupg2
sudo curl https://download.netify.ai/5/ubuntu/netify-archive-keyring.gpg -o /usr/share/keyrings/netify-archive-keyring.gpg
echo 'deb [signed-by=/usr/share/keyrings/netify-archive-keyring.gpg] http://download.netify.ai/5/ubuntu/noble/ /' | sudo tee /etc/apt/sources.list.d/netify.list

Step 3 - Install Netify Sink Socket:

Terminal - Netify

×

sudo apt update
sudo apt install netify-sink-socket

Step 2 - Add Netify's package signing key and repository:

Terminal - Netify

×

sudo apt-get update
sudo apt-get -y install curl gnupg2
sudo curl https://download.netify.ai/5/ubuntu/netify-archive-keyring.gpg -o /usr/share/keyrings/netify-archive-keyring.gpg
echo 'deb [signed-by=/usr/share/keyrings/netify-archive-keyring.gpg] http://download.netify.ai/5/ubuntu/jammy/ /' | sudo tee /etc/apt/sources.list.d/netify.list

Step 3 - Install Netify Sink Socket:

Terminal - Netify

×

sudo apt update
sudo apt install netify-sink-socket

Step 2 - Add Netify's package signing key and repository:

Terminal - Netify

×

sudo apt-get update
sudo apt-get -y install curl gnupg2
curl -fsSL https://download.netify.ai/5/ubuntu/apt-gpg-key-netify.asc | sudo apt-key add -
echo 'deb http://download.netify.ai/5/ubuntu/focal/ /' | sudo tee /etc/apt/sources.list.d/netify.list

Step 3 - Install Netify Sink Socket:

Terminal - Netify

×

sudo apt update
sudo apt install netify-sink-socket

Step 2 - Add Netify's package signing key and repository:

Terminal - Netify

×

wget https://download.netify.ai/5/openwrt/key-build.pub -O /etc/opkg/keys/b18c240cb821dad2
echo 'src/gz netify https://download.netify.ai/5/openwrt/24.10/x86' >> /etc/opkg/customfeeds.conf

Step 3 - Install Netify Sink Socket:

Terminal - Netify

×

opkg update
opkg install netify-sink-socket

Step 2 - Add Netify's package signing key and repository:

Terminal - Netify

×

wget https://download.netify.ai/5/openwrt/key-build.pub -O /etc/opkg/keys/b18c240cb821dad2
echo 'src/gz netify https://download.netify.ai/5/openwrt/23.05/x86' >> /etc/opkg/customfeeds.conf

Step 3 - Install Netify Sink Socket:

Terminal - Netify

×

opkg update
opkg install netify-sink-socket

Step 2 - Add Netify's package signing key and repository:

Terminal - Netify

×

wget https://download.netify.ai/5/openwrt/key-build.pub -O /etc/opkg/keys/b18c240cb821dad2
echo 'src/gz netify https://download.netify.ai/5/openwrt/22.03/x86' >> /etc/opkg/customfeeds.conf

Step 3 - Install Netify Sink Socket:

Terminal - Netify

×

opkg update
opkg install netify-sink-socket

Step 2 - Add Netify's package signing key and repository:

Terminal - Netify

×

wget https://download.netify.ai/5/openwrt/key-build.pub -O /etc/opkg/keys/b18c240cb821dad2
echo 'src/gz netify https://download.netify.ai/5/openwrt/21.02/x86' >> /etc/opkg/customfeeds.conf

Step 3 - Install Netify Sink Socket:

Terminal - Netify

×

opkg update
opkg install netify-sink-socket

Step 2 - Add Netify's package signing key and repository:

Terminal - Netify

×

wget http://download.netify.ai/5/openwrt/key-build.pub -O /etc/opkg/keys/b18c240cb821dad2
echo 'src/gz netify http://download.netify.ai/5/openwrt/19.07/x86' >> /etc/opkg/customfeeds.conf

Step 3 - Install Netify Sink Socket:

Terminal - Netify

×

opkg update
opkg install netify-sink-socket

Step 2 - Add Netify's package signing key and repository:

Terminal - Netify

×

sudo rpm --import https://download.netify.ai/5/opensuse/15.6/stable/RPM-GPG-KEY-netify
sudo curl https://download.netify.ai/5/opensuse/netify.repo -o /etc/zypp/repos.d/repo-netify.repo

Step 3 - Install Netify Sink Socket:

Terminal - Netify

×

sudo zypper update
sudo zypper install netify-sink-socket

Step 2 - Add Netify's package signing key and repository:

Terminal - Netify

×

sudo rpm --import https://download.netify.ai/5/opensuse/15.5/stable/RPM-GPG-KEY-netify
sudo curl https://download.netify.ai/5/opensuse/netify.repo -o /etc/zypp/repos.d/repo-netify.repo

Step 3 - Install Netify Sink Socket:

Terminal - Netify

×

sudo zypper update
sudo zypper install netify-sink-socket

Step 2 - Add Netify's package signing key and repository:

Terminal - Netify

×

sudo rpm --import https://download.netify.ai/5/almalinux/9/stable/RPM-GPG-KEY-netify
sudo curl https://download.netify.ai/5/almalinux/9/netify.repo -o /etc/yum.repos.d/netify.repo

Step 3 - Install Netify Sink Socket:

Terminal - Netify

×

sudo yum update
sudo yum install netify-sink-socket

Step 2 - Add Netify's package signing key and repository:

Terminal - Netify

×

sudo rpm --import https://download.netify.ai/5/almalinux/8/stable/RPM-GPG-KEY-netify
sudo curl https://download.netify.ai/5/almalinux/8/netify.repo -o /etc/yum.repos.d/netify.repo

Step 3 - Install Netify Sink Socket:

Terminal - Netify

×

sudo yum update
sudo yum install netify-sink-socket

Step 2 - Add Netify's package signing key and repository:

Terminal - Netify

×

sudo rpm --import http://download.netify.ai/5/rockylinux/9/stable/RPM-GPG-KEY-netify
sudo curl https://download.netify.ai/5/rockylinux/9/netify.repo -o /etc/yum.repos.d/netify.repo

Step 3 - Install Netify Sink Socket:

Terminal - Netify

×

sudo yum update
sudo yum install netify-sink-socket

Step 2 - Add Netify's package signing key and repository:

Terminal - Netify

×

sudo rpm --import http://download.netify.ai/5/rockylinux/8/stable/RPM-GPG-KEY-netify
sudo curl https://download.netify.ai/5/rockylinux/8/netify.repo -o /etc/yum.repos.d/netify.repo

Step 3 - Install Netify Sink Socket:

Terminal - Netify

×

sudo yum update
sudo yum install netify-sink-socket

Step 2 - Add Netify's package signing key and repository:

Terminal - Netify

×

mkdir -p /usr/local/etc/pkg/fingerprints/Netify/trusted
curl https://download.netify.ai/5/opnsense/fingerprint -o /usr/local/etc/pkg/fingerprints/Netify/trusted/fingerprint
cat << EOF >  /usr/local/etc/pkg/repos/Netify.conf
Netify: {
  fingerprints: "/usr/local/etc/pkg/fingerprints/Netify",
  url: "https://download.netify.ai/5/opnsense/25.7",
  signature_type: "fingerprints",
  mirror_type: "http",
  priority: 11,
  enabled: yes
}
EOF

Step 3 - Install Netify Sink Socket:

Terminal - Netify

×

pkg update
pkg install netify-sink-socket

Step 2 - Add Netify's package signing key and repository:

Terminal - Netify

×

mkdir -p /usr/local/etc/pkg/fingerprints/Netify/trusted
curl https://download.netify.ai/5/opnsense/fingerprint -o /usr/local/etc/pkg/fingerprints/Netify/trusted/fingerprint
cat << EOF >  /usr/local/etc/pkg/repos/Netify.conf
Netify: {
  fingerprints: "/usr/local/etc/pkg/fingerprints/Netify",
  url: "https://download.netify.ai/5/opnsense/24.7",
  signature_type: "fingerprints",
  mirror_type: "http",
  priority: 11,
  enabled: yes
}
EOF

Step 3 - Install Netify Sink Socket:

Terminal - Netify

×

pkg update
pkg install netify-sink-socket

Step 2 - Add Netify's package signing key and repository:

Terminal - Netify

×

mkdir -p /usr/local/etc/pkg/fingerprints/Netify/trusted
curl https://download.netify.ai/5/freebsd/fingerprint -o /usr/local/etc/pkg/fingerprints/Netify/trusted/fingerprint
cat << EOF >  /usr/local/etc/pkg/repos/Netify.conf
Netify: {
  fingerprints: "/usr/local/etc/pkg/fingerprints/Netify",
  url: "https://download.netify.ai/5/freebsd/15.0",
  signature_type: "fingerprints",
  mirror_type: "http",
  priority: 11,
  enabled: yes
}
EOF

Step 3 - Install Netify Sink Socket:

Terminal - Netify

×

pkg update
pkg install netify-sink-socket

Step 2 - Add Netify's package signing key and repository:

Terminal - Netify

×

mkdir -p /usr/local/etc/pkg/fingerprints/Netify/trusted
curl https://download.netify.ai/5/freebsd/fingerprint -o /usr/local/etc/pkg/fingerprints/Netify/trusted/fingerprint
cat << EOF >  /usr/local/etc/pkg/repos/Netify.conf
Netify: {
  fingerprints: "/usr/local/etc/pkg/fingerprints/Netify",
  url: "https://download.netify.ai/5/freebsd/14.0",
  signature_type: "fingerprints",
  mirror_type: "http",
  priority: 11,
  enabled: yes
}
EOF

Step 3 - Install Netify Sink Socket:

Terminal - Netify

×

pkg update
pkg install netify-sink-socket

Step 2 - Add Netify's package signing key and repository:

Terminal - Netify

×

mkdir -p /usr/local/etc/pkg/fingerprints/Netify/trusted
curl https://download.netify.ai/5/freebsd/fingerprint -o /usr/local/etc/pkg/fingerprints/Netify/trusted/fingerprint
cat << EOF >  /usr/local/etc/pkg/repos/Netify.conf
Netify: {
  fingerprints: "/usr/local/etc/pkg/fingerprints/Netify",
  url: "https://download.netify.ai/5/freebsd/14.0",
  signature_type: "fingerprints",
  mirror_type: "http",
  priority: 11,
  enabled: yes
}
EOF

Step 3 - Install Netify Sink Socket:

Terminal - Netify

×

pkg update
pkg install netify-sink-socket

Setup

All plugins are disabled by default, and the Netify Sink Socket plugin is no different. Use netifyd's --enable-plugin and --disable-plugin flags to enable or disable the plugin.

Terminal - Netify

×

netifyd --enable-plugin sink-socket  # Enables loader
netifyd --disable-plugin sink-socket # Disables loader

For orchestration tools or manual setup, you can also directly update configuration file in the plugins.d subdirectory and set enable to yes.

See the advanced configuration section for details on instantiating multiple instances of the plugin.

Terminal - Netify

×

$ cat 10-netify-sink-socket.conf
[sink-socket]
enable = yes
plugin_library = /usr/lib64/libnetify-sink-socket.so.0.0.0
conf_filename = ${path_state_persistent}/netify-sink-socket.json

AI Integration

For AI integration and machine learning models, the Netify Sink Socket JSON schema is available for reference.

Configuration

The plugin is configured via the JSON file referenced by its loader (typically /etc/netifyd/netify-sink-socket.json ). The only global setting is the default port; all other options are defined per channel, allowing each telemetry stream to specify its own protocol, destination, and behavior.

For example, you might stream interface stats over WebSockets to power a live dashboard, while sending flow data over UDP to a custom network analyzer.

Global Configuration

default_port

integer

Default port used for TCP, UDP, and WebSockets (1-65535).

channels

object

Channel configurations.

Channel Configuration

enable

boolean

State of the output channel.

Default:

true

bind_address

string

Socket connection string. Supported protocols: unix, tcp, udp, ws, wss.

Example Bind Addresses

UDP: udp://127.0.0.1:1760
TCP: tcp://192.168.1.1:1765
WebSocket: ws://0.0.0.0:1770
File: unix://${path_state_volatile}/netify-sink.sock

Example Socket Plugin Configuration

{
    "default_port": 1750,
    "channels": {
        "flows": {
            "enable": true,
            "bind_address": "udp://0.0.0.0:1760"
        },
        "dashboard": {
            "enable": true,
            "bind_address": "ws://0.0.0.0:1770"
        }
    }
}

Telemetry

With one or more sink outputs configured to receive data, the final step is to configure the agent to send telemetry.