Viewing Netify Version v5

Telemetry via Sink Log

The Netify log output interface enables the export of network telemetry and metadata from the DPI engine to local log files, which can be consumed by monitoring systems, automation scripts, or custom tools. This method is most often used for development and debugging, providing a simple, reliable way to capture telemetry without requiring persistent network connections or additional messaging layers.

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

License

The Netify Sink Log 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 Log:

Terminal - Netify

×

sudo apt update
sudo apt install netify-sink-log

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 Log:

Terminal - Netify

×

sudo apt update
sudo apt install netify-sink-log

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 Log:

Terminal - Netify

×

sudo apt update
sudo apt install netify-sink-log

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 Log:

Terminal - Netify

×

sudo apt update
sudo apt install netify-sink-log

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 Log:

Terminal - Netify

×

sudo apt update
sudo apt install netify-sink-log

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 Log:

Terminal - Netify

×

sudo apt update
sudo apt install netify-sink-log

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 Log:

Terminal - Netify

×

opkg update
opkg install netify-sink-log

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 Log:

Terminal - Netify

×

opkg update
opkg install netify-sink-log

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 Log:

Terminal - Netify

×

opkg update
opkg install netify-sink-log

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 Log:

Terminal - Netify

×

opkg update
opkg install netify-sink-log

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 Log:

Terminal - Netify

×

opkg update
opkg install netify-sink-log

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 Log:

Terminal - Netify

×

sudo zypper update
sudo zypper install netify-sink-log

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 Log:

Terminal - Netify

×

sudo zypper update
sudo zypper install netify-sink-log

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 Log:

Terminal - Netify

×

sudo yum update
sudo yum install netify-sink-log

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 Log:

Terminal - Netify

×

sudo yum update
sudo yum install netify-sink-log

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 Log:

Terminal - Netify

×

sudo yum update
sudo yum install netify-sink-log

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 Log:

Terminal - Netify

×

sudo yum update
sudo yum install netify-sink-log

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 Log:

Terminal - Netify

×

pkg update
pkg install netify-sink-log

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 Log:

Terminal - Netify

×

pkg update
pkg install netify-sink-log

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 Log:

Terminal - Netify

×

pkg update
pkg install netify-sink-log

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 Log:

Terminal - Netify

×

pkg update
pkg install netify-sink-log

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 Log:

Terminal - Netify

×

pkg update
pkg install netify-sink-log

Setup

All plugins are disabled by default, and the Netify Sink Log 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-log  # Enables loader
netifyd --disable-plugin sink-log # 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-log.conf
[sink-log]
enable = yes
plugin_library = /usr/lib64/libnetify-sink-log.so.0.0.0
conf_filename = ${path_state_persistent}/netify-sink-log.json

AI Integration

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

Configuration

The plugin is configured via the JSON file referenced by its loader (typically /etc/netifyd/netify-sink-log.json ). Top-level properties set global defaults, while per-channel properties override those defaults and define log prefixes. Use the global settings for shared behavior, and apply per-channel overrides when specific streams need separate files, naming, or overwrite policies.

Global Configuration

overwrite

boolean

Default file overwrite policy.

Default:

false

log_path

string

Default output folder for log files.

Default:

/tmp

channels

object

Channel configurations.

Channel Configuration

enable

boolean

State of the output channel.

Default:

true

overwrite

boolean

Channel-specific overwrite policy.

log_path

string

Channel-specific output folder for log files.

log_name

string

Prefix prepended to generated log filenames.

Example Sink Log Plugin Configuration

{
    "overwrite": false,
    "log_path": "/tmp",
    "channels": {
        "endpoints": {
            "overwrite": true,
            "log_path": "/var/log/telemetry",
            "log_name": "netify-endpoints-"
        },
        "intel": {
            "log_path": "/var/log/telemetry",
            "log_name": "netify-intel-"
        }
    }
}

Telemetry

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